PUT Notes
Updates the given note.
Request Information
URI Parameters
None.
Body Parameters
The note to update
Note| Name | Description | Type | Additional information |
|---|---|---|---|
| NoteId | globally unique identifier |
None. |
|
| Asset | Asset |
None. |
|
| OnBehalfOf | string |
None. |
|
| NoteCategory | NoteCategory |
None. |
|
| EffectiveDate | date |
None. |
|
| NoteHTML | string |
None. |
|
| SourceSystemId | string |
None. |
|
| CompanyId | globally unique identifier |
None. |
|
| CreateDate | date |
None. |
|
| CreateUser | string |
None. |
|
| LastModifiedDate | date |
None. |
|
| LastModifiedUser | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"NoteId": "a154de2e-3143-45ed-8086-fe4b05065f88",
"Asset": {
"AssetId": "ea3bc1d4-f400-4ce6-a43e-f3f953af78d6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d9337b98-0a5f-4f9b-b0b5-b68767d654e6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1400002e-6f8b-49bf-8545-28e1b381c9d8",
"CreateDate": "2026-03-14T22:30:53.2169304-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-14T22:30:53.2169304-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "6b00511a-9508-4f43-a569-dc7d5bf12385",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-14T22:30:53.2169304-07:00",
"MeasurementValueNeededDate": "2026-03-14T22:30:53.2169304-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "bc978fed-3890-4178-b505-31fcbe56044a",
"CreateDate": "2026-03-14T22:30:53.2169304-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-14T22:30:53.2169304-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "fa4aa38c-4834-4d9e-b87a-7deb2a264086",
"EffectiveDate": "2026-03-14T22:30:53.2169304-07:00",
"StateType": {
"StateTypeId": "b48ef725-f3e5-4ed2-af78-174ebfb8e5f7",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "d9337b98-0a5f-4f9b-b0b5-b68767d654e6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1400002e-6f8b-49bf-8545-28e1b381c9d8",
"CreateDate": "2026-03-14T22:30:53.2169304-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-14T22:30:53.2169304-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "bd973116-17e8-4240-8afe-f6c0234f1cb1",
"CreateDate": "2026-03-14T22:30:53.2169304-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-14T22:30:53.2169304-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "800c04d0-50dc-4568-9199-e7ad4de7ebe1",
"CreateDate": "2026-03-14T22:30:53.2169304-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-14T22:30:53.2169304-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "ea80bab2-bb74-45de-8113-04a1c9018642",
"EffectiveDate": "2026-03-14T22:30:53.2169304-07:00",
"StatusType": {
"StatusTypeId": "12d1eb16-0901-4a37-b3cc-e6aa6c75c94a",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "d9337b98-0a5f-4f9b-b0b5-b68767d654e6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1400002e-6f8b-49bf-8545-28e1b381c9d8",
"CreateDate": "2026-03-14T22:30:53.2169304-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-14T22:30:53.2169304-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "4274b088-27a3-4efa-95c7-ae4b78de5bdd",
"CreateDate": "2026-03-14T22:30:53.2169304-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-14T22:30:53.2169304-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c2bb9494-d30f-4c3c-833c-2a07987ff24c",
"CreateDate": "2026-03-14T22:30:53.2169304-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-14T22:30:53.2169304-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "f0f6229c-0a89-44ef-b67f-9c9802fcf5e4",
"EffectiveDate": "2026-03-14T22:30:53.2169304-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "20bf8890-195d-4ae8-957b-d9f7e9ebf371",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "8ba48d13-2ceb-4180-842d-90010e0390f7",
"CreateDate": "2026-03-14T22:30:53.2169304-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-14T22:30:53.2169304-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3df1d7f3-b067-4b2a-a968-22c16f5ace36",
"CreateDate": "2026-03-14T22:30:53.2169304-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-14T22:30:53.2169304-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-14T22:30:53.2169304-07:00",
"MeasurementValueNeededDate": "2026-03-14T22:30:53.2169304-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "06fa1d69-2e80-4e86-9575-7eff4b69e20e",
"CreateDate": "2026-03-14T22:30:53.2169304-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-14T22:30:53.2169304-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "8080bb64-a8a5-453a-9091-7cf3fd2bc57d",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "ea7e63cd-54f7-49db-ae58-65bf4fb998d9",
"CreateDate": "2026-03-14T22:30:53.2169304-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-14T22:30:53.2169304-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-14T22:30:53.2169304-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "142a8461-7a45-4eac-ac2d-5edbc596be7f",
"CreateDate": "2026-03-14T22:30:53.2169304-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-14T22:30:53.2169304-07:00",
"LastModifiedUser": "sample string 6"
}
Response Information
Resource Description
On success, the updated note.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Note |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": {
"NoteId": "a251f4f8-a3b9-42a7-b220-5090cce9b114",
"Asset": {
"AssetId": "b007a257-454c-4621-9b92-869e61a01657",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a6dba1b7-1adf-43e1-8dd4-e9daa9b85169",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5cd9c9b2-926e-4b42-974e-63a6a5936ba8",
"CreateDate": "2026-03-14T22:30:53.2169304-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-14T22:30:53.2169304-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "eba1101c-c836-49fa-8aea-84616a1223ec",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-14T22:30:53.2169304-07:00",
"MeasurementValueNeededDate": "2026-03-14T22:30:53.2169304-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f1652d1e-96ab-42ca-889b-934933759083",
"CreateDate": "2026-03-14T22:30:53.2169304-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-14T22:30:53.2169304-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "c57b37d5-0ed1-4dfc-a98f-35273a3c1038",
"EffectiveDate": "2026-03-14T22:30:53.2169304-07:00",
"StateType": {
"StateTypeId": "41866e3f-43f7-4bd1-ad65-3182a17aa4a6",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "a6dba1b7-1adf-43e1-8dd4-e9daa9b85169",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5cd9c9b2-926e-4b42-974e-63a6a5936ba8",
"CreateDate": "2026-03-14T22:30:53.2169304-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-14T22:30:53.2169304-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "2d4eeede-5ca1-4ae1-b4c7-d5493bd1cf5e",
"CreateDate": "2026-03-14T22:30:53.2169304-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-14T22:30:53.2169304-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ca8360fe-6d2f-4ab8-a971-b62e312535cc",
"CreateDate": "2026-03-14T22:30:53.2169304-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-14T22:30:53.2169304-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "67e82ff8-2532-4f1c-b6f2-9576b8e8f681",
"EffectiveDate": "2026-03-14T22:30:53.2169304-07:00",
"StatusType": {
"StatusTypeId": "984776b7-4136-4af7-81f3-41b8ad37733e",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "a6dba1b7-1adf-43e1-8dd4-e9daa9b85169",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5cd9c9b2-926e-4b42-974e-63a6a5936ba8",
"CreateDate": "2026-03-14T22:30:53.2169304-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-14T22:30:53.2169304-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "05d0d87a-a97e-43d9-bd95-6080cc2df42f",
"CreateDate": "2026-03-14T22:30:53.2169304-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-14T22:30:53.2169304-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4e64f7e8-a648-4035-9e16-13cc4de73aed",
"CreateDate": "2026-03-14T22:30:53.2169304-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-14T22:30:53.2169304-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "4912c966-e108-40ad-aa00-11b5d1e37288",
"EffectiveDate": "2026-03-14T22:30:53.2169304-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "a7de22b9-3981-432a-a52d-acfbe93db3ac",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4c7557dc-a6ea-4f0c-a1d1-f595b642ba87",
"CreateDate": "2026-03-14T22:30:53.2169304-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-14T22:30:53.2169304-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "7f33d16b-96dc-455e-bf55-0576d785a064",
"CreateDate": "2026-03-14T22:30:53.2169304-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-14T22:30:53.2169304-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-14T22:30:53.2169304-07:00",
"MeasurementValueNeededDate": "2026-03-14T22:30:53.2169304-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "a75c8c6a-e39d-46d8-a959-cd4c9cb53e10",
"CreateDate": "2026-03-14T22:30:53.2169304-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-14T22:30:53.2169304-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "0de6b8dd-a71e-44a0-93ca-b12959e7d8b9",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "5742d97d-473f-4845-81ed-d4f2e147df1f",
"CreateDate": "2026-03-14T22:30:53.2169304-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-14T22:30:53.2169304-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-14T22:30:53.2169304-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ca1c55fd-f639-408d-8234-b5bdee58324c",
"CreateDate": "2026-03-14T22:30:53.2169304-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-14T22:30:53.2169304-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}