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": "b0031f66-31df-4611-81a4-64dbe58ce3d7",
"Asset": {
"AssetId": "0dfb3f2e-4bfc-442a-b6fc-0640eec305e1",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "aaf96e8b-b8a5-4755-b105-709715612781",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "712f4897-a76f-472a-b186-125f69a73e35",
"CreateDate": "2026-08-31T00:33:13.3280717-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-31T00:33:13.3280717-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "88e26d45-5430-4538-9082-e957991b4bb3",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-31T00:33:13.3280717-07:00",
"MeasurementValueNeededDate": "2026-08-31T00:33:13.3280717-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "fc3d470d-8b30-4e13-a880-1bedb4cb2da7",
"CreateDate": "2026-08-31T00:33:13.3280717-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-31T00:33:13.3280717-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "5f046654-53f9-440c-becd-63a4e5aaf648",
"EffectiveDate": "2026-08-31T00:33:13.3280717-07:00",
"StateType": {
"StateTypeId": "2bc5f81c-c34e-4784-a6ed-1fab0dc75bd9",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "aaf96e8b-b8a5-4755-b105-709715612781",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "712f4897-a76f-472a-b186-125f69a73e35",
"CreateDate": "2026-08-31T00:33:13.3280717-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-31T00:33:13.3280717-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "d9c928c6-2991-4854-9eca-a59d87266eb6",
"CreateDate": "2026-08-31T00:33:13.3280717-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-31T00:33:13.3280717-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "92d6e3b5-2f48-4818-8ff8-80f0922ac3d1",
"CreateDate": "2026-08-31T00:33:13.3280717-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-31T00:33:13.3280717-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "577c0fb9-136b-46eb-9ce0-246a84004ba1",
"EffectiveDate": "2026-08-31T00:33:13.3280717-07:00",
"StatusType": {
"StatusTypeId": "b65ebaf2-8022-4e26-b142-5b91b514aadd",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "aaf96e8b-b8a5-4755-b105-709715612781",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "712f4897-a76f-472a-b186-125f69a73e35",
"CreateDate": "2026-08-31T00:33:13.3280717-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-31T00:33:13.3280717-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "8863ae9b-edd4-4f33-8e43-b13e8a3c3bc8",
"CreateDate": "2026-08-31T00:33:13.3280717-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-31T00:33:13.3280717-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "02d6ef10-f3fc-4871-8685-d8a7dcf12590",
"CreateDate": "2026-08-31T00:33:13.3280717-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-31T00:33:13.3280717-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "f476a46f-34c1-45bf-a612-18121538b9f2",
"EffectiveDate": "2026-08-31T00:33:13.3280717-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "f031411c-29a4-49eb-8d69-b5660f3ddd58",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "086f253d-5bb6-40d2-82fc-0a359878a1ed",
"CreateDate": "2026-08-31T00:33:13.3280717-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-31T00:33:13.3280717-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "8a9106de-f3b9-4210-80dd-3c60ac271635",
"CreateDate": "2026-08-31T00:33:13.3280717-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-31T00:33:13.3280717-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-08-31T00:33:13.3280717-07:00",
"MeasurementValueNeededDate": "2026-08-31T00:33:13.3280717-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "3429ae8d-ccac-4477-8083-4028bba88b5c",
"CreateDate": "2026-08-31T00:33:13.3280717-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-31T00:33:13.3280717-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "ba7c89ed-357d-4a35-b230-69d70eacc7a4",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "20f468fc-b44f-44c8-bc48-c9c611ec35a6",
"CreateDate": "2026-08-31T00:33:13.3280717-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-31T00:33:13.3280717-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-31T00:33:13.3280717-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c9114ca3-e6c6-4ef8-b3d4-98731a2dfff1",
"CreateDate": "2026-08-31T00:33:13.3280717-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-31T00:33:13.3280717-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": "e9a1cafd-be35-4ea6-971b-72e50dc2ee45",
"Asset": {
"AssetId": "350c1948-c403-4c52-aede-6bec6f3e25ea",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "f2c7bced-ecee-4c34-b275-61cb1d341275",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "64f771d8-28c9-4920-8181-5309a8b3b28e",
"CreateDate": "2026-08-31T00:33:13.3436821-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-31T00:33:13.3436821-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "b0ad9e00-9610-4978-9760-db5c995365e0",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-31T00:33:13.3436821-07:00",
"MeasurementValueNeededDate": "2026-08-31T00:33:13.3436821-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "d500f187-55e9-46a9-a304-487edda5d1f8",
"CreateDate": "2026-08-31T00:33:13.3436821-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-31T00:33:13.3436821-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "67f1dd82-9b64-45da-852d-3aafa3865490",
"EffectiveDate": "2026-08-31T00:33:13.3436821-07:00",
"StateType": {
"StateTypeId": "3410fc2d-fdb7-480e-824c-bb9a1ee205cc",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "f2c7bced-ecee-4c34-b275-61cb1d341275",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "64f771d8-28c9-4920-8181-5309a8b3b28e",
"CreateDate": "2026-08-31T00:33:13.3436821-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-31T00:33:13.3436821-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "52cef431-d3fb-4069-bfee-54ae3ede96d6",
"CreateDate": "2026-08-31T00:33:13.3436821-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-31T00:33:13.3436821-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a95739d8-d95c-4c6e-b0d1-0eb593fc94b6",
"CreateDate": "2026-08-31T00:33:13.3436821-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-31T00:33:13.3436821-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "8b230c4b-41a2-411d-ade3-5d618f251d0d",
"EffectiveDate": "2026-08-31T00:33:13.3436821-07:00",
"StatusType": {
"StatusTypeId": "ac65f192-eff9-4d38-8b03-6545e544203b",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "f2c7bced-ecee-4c34-b275-61cb1d341275",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "64f771d8-28c9-4920-8181-5309a8b3b28e",
"CreateDate": "2026-08-31T00:33:13.3436821-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-31T00:33:13.3436821-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "df107700-6559-492b-b5b8-a4ba301cf8fd",
"CreateDate": "2026-08-31T00:33:13.3436821-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-31T00:33:13.3436821-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9769e7a0-00b9-4ca5-9edc-5adeb9fe795d",
"CreateDate": "2026-08-31T00:33:13.3436821-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-31T00:33:13.3436821-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "2d1b5aa7-ea7c-4494-8f0c-4ae0d09ca5ae",
"EffectiveDate": "2026-08-31T00:33:13.3436821-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "74b4f9a8-f1ef-42e7-8418-16f730f4e716",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e6f07333-ea42-456e-864b-fc60738828a1",
"CreateDate": "2026-08-31T00:33:13.3436821-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-31T00:33:13.3436821-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f3884238-42e8-42c4-92de-5fe46c3f6f73",
"CreateDate": "2026-08-31T00:33:13.3436821-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-31T00:33:13.3436821-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-08-31T00:33:13.3436821-07:00",
"MeasurementValueNeededDate": "2026-08-31T00:33:13.3436821-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "1eab690e-1297-492e-958d-0aa0ac5d2153",
"CreateDate": "2026-08-31T00:33:13.3436821-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-31T00:33:13.3436821-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "3fbc0606-08f3-43bc-9bf9-50bc74a3e75a",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0e8e5743-53ba-4607-9b10-a7a2d7e2abfb",
"CreateDate": "2026-08-31T00:33:13.3436821-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-31T00:33:13.3436821-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-31T00:33:13.3436821-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0aa93456-720d-4ade-b2a8-c0878aafae18",
"CreateDate": "2026-08-31T00:33:13.3436821-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-31T00:33:13.3436821-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}