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": "5b9442fd-88bf-4e76-a3da-fbd94f2880c2",
"Asset": {
"AssetId": "7fe06609-633f-4fd3-ad2e-08aabcd0334e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "e4ab85d2-d08f-4925-a84f-9c6b73b1c2c8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "348ac565-603e-4612-a18c-cceab5e3c714",
"CreateDate": "2026-10-19T09:28:16.3856234-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-19T09:28:16.3856234-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "7f2fbc22-fcae-4677-a94e-2167769bb8f2",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-19T09:28:16.3856234-07:00",
"MeasurementValueNeededDate": "2026-10-19T09:28:16.3856234-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2c55e9ac-0805-47b2-8528-a1681cc52c0b",
"CreateDate": "2026-10-19T09:28:16.3856234-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-19T09:28:16.3856234-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "a05b72c6-49a8-418d-a875-d6705220c3ce",
"EffectiveDate": "2026-10-19T09:28:16.3856234-07:00",
"StateType": {
"StateTypeId": "27586293-b324-4ecd-88e7-5233c403d764",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "e4ab85d2-d08f-4925-a84f-9c6b73b1c2c8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "348ac565-603e-4612-a18c-cceab5e3c714",
"CreateDate": "2026-10-19T09:28:16.3856234-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-19T09:28:16.3856234-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "dd304f6d-6f50-4349-ad53-07294b618223",
"CreateDate": "2026-10-19T09:28:16.3856234-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-19T09:28:16.3856234-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ef8d85f8-775e-4df7-9e64-cb58f3dff854",
"CreateDate": "2026-10-19T09:28:16.3856234-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-19T09:28:16.3856234-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "0c982057-77c7-4bf4-9fed-426308ea316a",
"EffectiveDate": "2026-10-19T09:28:16.3856234-07:00",
"StatusType": {
"StatusTypeId": "318be8a6-e95e-4b62-b11b-fdf0d6730e22",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "e4ab85d2-d08f-4925-a84f-9c6b73b1c2c8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "348ac565-603e-4612-a18c-cceab5e3c714",
"CreateDate": "2026-10-19T09:28:16.3856234-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-19T09:28:16.3856234-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "2bd03c61-3dfd-46f5-8ebf-c881c36aa1ef",
"CreateDate": "2026-10-19T09:28:16.3856234-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-19T09:28:16.3856234-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2396d76a-3549-4d06-bde4-c11f29f5d0e5",
"CreateDate": "2026-10-19T09:28:16.3856234-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-19T09:28:16.3856234-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "00f29c60-125d-477f-80db-99c50c751d15",
"EffectiveDate": "2026-10-19T09:28:16.3856234-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "fe27984f-4b01-410c-8e5c-416bdaf54d7c",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "93ddfb3d-e833-4bdc-a2fd-69396fe400bc",
"CreateDate": "2026-10-19T09:28:16.3856234-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-19T09:28:16.3856234-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c66888f2-75f6-4e78-b536-faa6e3238717",
"CreateDate": "2026-10-19T09:28:16.3856234-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-19T09:28:16.3856234-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-10-19T09:28:16.3856234-07:00",
"MeasurementValueNeededDate": "2026-10-19T09:28:16.3856234-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "c341bf15-f231-4a94-8deb-6860a82f1cd2",
"CreateDate": "2026-10-19T09:28:16.3856234-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-19T09:28:16.3856234-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "c6447068-168a-4461-9c2a-cdaf025ef343",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "7ef94387-2bfa-4360-b7f3-3260263cf9aa",
"CreateDate": "2026-10-19T09:28:16.3856234-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-19T09:28:16.3856234-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-10-19T09:28:16.3856234-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9f202f58-7f52-4f6d-88d0-9bbc68873aa6",
"CreateDate": "2026-10-19T09:28:16.3856234-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-19T09:28:16.3856234-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": "4aa9eda6-e9c4-4e7c-a2a0-9f9d62f7cbd1",
"Asset": {
"AssetId": "a7725f2f-63a3-4476-ac98-9b322262ed34",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "450e36db-7852-4083-a768-31f067d35538",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b3dc43ba-f580-4b94-941c-6e21b471973b",
"CreateDate": "2026-10-19T09:28:16.3856234-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-19T09:28:16.3856234-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "f137c44d-b3bf-497a-aef2-9b1d5be4e21c",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-19T09:28:16.3856234-07:00",
"MeasurementValueNeededDate": "2026-10-19T09:28:16.3856234-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "918c5b3a-bc90-43d8-b1b8-8c2205b6e9b8",
"CreateDate": "2026-10-19T09:28:16.3856234-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-19T09:28:16.3856234-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "07269e23-d328-4d3d-8348-70c543199c06",
"EffectiveDate": "2026-10-19T09:28:16.3856234-07:00",
"StateType": {
"StateTypeId": "6a92abd5-09d1-4148-a565-c003f9c9cf74",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "450e36db-7852-4083-a768-31f067d35538",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b3dc43ba-f580-4b94-941c-6e21b471973b",
"CreateDate": "2026-10-19T09:28:16.3856234-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-19T09:28:16.3856234-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "dc567a58-ba37-4d36-8016-a27c3dc30ea7",
"CreateDate": "2026-10-19T09:28:16.3856234-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-19T09:28:16.3856234-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "fcb85f93-120a-42ab-b20f-2b660c92ffce",
"CreateDate": "2026-10-19T09:28:16.3856234-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-19T09:28:16.3856234-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "cc73942a-f997-47ac-a85a-fe2a50ae9312",
"EffectiveDate": "2026-10-19T09:28:16.3856234-07:00",
"StatusType": {
"StatusTypeId": "8f3ad4c9-c079-478a-92b4-52a75817732c",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "450e36db-7852-4083-a768-31f067d35538",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b3dc43ba-f580-4b94-941c-6e21b471973b",
"CreateDate": "2026-10-19T09:28:16.3856234-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-19T09:28:16.3856234-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "f91d46d6-853d-4878-9b6c-686f049f6e0c",
"CreateDate": "2026-10-19T09:28:16.3856234-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-19T09:28:16.3856234-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "43c60697-04ac-407c-9235-c391bd839937",
"CreateDate": "2026-10-19T09:28:16.3856234-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-19T09:28:16.3856234-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "b070cb72-020a-454c-b27a-509f8a2731a4",
"EffectiveDate": "2026-10-19T09:28:16.3856234-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "d01f3ce4-5535-4eb2-82dc-9136abbd8927",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "bf03355e-b044-40e0-8f9b-825532145bf2",
"CreateDate": "2026-10-19T09:28:16.3856234-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-19T09:28:16.3856234-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ab4c26ec-4f79-46b5-82d7-21c7e70e68e7",
"CreateDate": "2026-10-19T09:28:16.4012518-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-19T09:28:16.4012518-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-10-19T09:28:16.4012518-07:00",
"MeasurementValueNeededDate": "2026-10-19T09:28:16.4012518-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "5d71b792-80dd-41de-be3f-a039a9ea345b",
"CreateDate": "2026-10-19T09:28:16.4012518-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-19T09:28:16.4012518-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "d45bf5de-dce8-43f4-b8a6-cc5a5ae24cad",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "74c2de68-c4b1-4750-8cb6-695b3bf6f586",
"CreateDate": "2026-10-19T09:28:16.4012518-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-19T09:28:16.4012518-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-10-19T09:28:16.4012518-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1483e802-49d7-4169-8d05-9f9f4f3c2ef5",
"CreateDate": "2026-10-19T09:28:16.4012518-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-19T09:28:16.4012518-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}