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": "5fef86c9-d49f-41be-aafa-cc03285f498f",
"Asset": {
"AssetId": "4d7ac603-f43e-402a-8bca-0edf98a5251b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "482a542e-dabb-4fab-bcb1-1d7a10051ff3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "645b6715-34da-4016-bd41-e0367e4ca0c2",
"CreateDate": "2026-05-14T06:47:38.8633186-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-14T06:47:38.8633186-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "8dba14f1-f7c2-4152-b937-03f7c74f5920",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-14T06:47:38.8633186-07:00",
"MeasurementValueNeededDate": "2026-05-14T06:47:38.8633186-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "db4e026b-fd4d-4a7c-917d-4394985f4140",
"CreateDate": "2026-05-14T06:47:38.8633186-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-14T06:47:38.8633186-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "6a437a35-eafd-4795-8bd4-692533812fd7",
"EffectiveDate": "2026-05-14T06:47:38.8633186-07:00",
"StateType": {
"StateTypeId": "161a8faf-5a39-4dd0-8e47-872caf7cfc7f",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "482a542e-dabb-4fab-bcb1-1d7a10051ff3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "645b6715-34da-4016-bd41-e0367e4ca0c2",
"CreateDate": "2026-05-14T06:47:38.8633186-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-14T06:47:38.8633186-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "373d77a2-92ac-4aec-acb4-41d1d04e674a",
"CreateDate": "2026-05-14T06:47:38.8633186-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-14T06:47:38.8633186-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a48e14f5-163b-4bc5-b2b0-3ff38fa24f78",
"CreateDate": "2026-05-14T06:47:38.8633186-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-14T06:47:38.8633186-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "f49e15ff-bcb6-402f-814d-0da090d4ebf9",
"EffectiveDate": "2026-05-14T06:47:38.8633186-07:00",
"StatusType": {
"StatusTypeId": "20b40baf-09f8-460b-b99c-d80a539b0cad",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "482a542e-dabb-4fab-bcb1-1d7a10051ff3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "645b6715-34da-4016-bd41-e0367e4ca0c2",
"CreateDate": "2026-05-14T06:47:38.8633186-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-14T06:47:38.8633186-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "6590a745-3a82-484d-9ae4-336fe44070c5",
"CreateDate": "2026-05-14T06:47:38.8633186-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-14T06:47:38.8633186-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6a3cc631-7a32-4faa-8896-e5157432aeb6",
"CreateDate": "2026-05-14T06:47:38.8633186-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-14T06:47:38.8633186-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "2809b40c-09b6-4559-9b0c-669734f9a335",
"EffectiveDate": "2026-05-14T06:47:38.8633186-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "877427d1-8ed0-4bf2-b75b-736d8b322c3b",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "98f51cec-69b1-4213-9566-5d1424f1f393",
"CreateDate": "2026-05-14T06:47:38.8633186-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-14T06:47:38.8633186-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "8839a07b-18f6-489d-955e-34d287f0bde5",
"CreateDate": "2026-05-14T06:47:38.8633186-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-14T06:47:38.8633186-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-05-14T06:47:38.8633186-07:00",
"MeasurementValueNeededDate": "2026-05-14T06:47:38.8633186-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "175e610b-3591-4aa2-8cce-0d01928c9ff3",
"CreateDate": "2026-05-14T06:47:38.8633186-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-14T06:47:38.8633186-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "cb526efd-5560-4e4e-8c12-a43ea010ea00",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "3e9089a1-91c5-4314-8d9d-e1190c00267e",
"CreateDate": "2026-05-14T06:47:38.8633186-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-14T06:47:38.8633186-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-05-14T06:47:38.8633186-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "54eb4df3-f28f-41e2-a9f7-7f5acb9baa9d",
"CreateDate": "2026-05-14T06:47:38.8633186-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-14T06:47:38.8633186-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": "b3640840-c7b6-4d8b-8327-b0856c2561a0",
"Asset": {
"AssetId": "5c57a019-8968-4577-8810-d00635268ac0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a306cbb7-b971-46b8-a935-74b25c936a5e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c10bbaaf-d7d5-4edc-8f85-e6016aea2e1e",
"CreateDate": "2026-05-14T06:47:38.8633186-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-14T06:47:38.8633186-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "f73525da-6091-4263-bcf8-cfd700a6aa15",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-14T06:47:38.8633186-07:00",
"MeasurementValueNeededDate": "2026-05-14T06:47:38.8633186-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "1f350507-aa2e-47ee-8e27-2efe5ba03440",
"CreateDate": "2026-05-14T06:47:38.8633186-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-14T06:47:38.8633186-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "adc829d8-f153-4475-9e63-bf5bdabba1ae",
"EffectiveDate": "2026-05-14T06:47:38.8633186-07:00",
"StateType": {
"StateTypeId": "df5e18fa-4eaf-441b-b38e-cb4a6b894bca",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "a306cbb7-b971-46b8-a935-74b25c936a5e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c10bbaaf-d7d5-4edc-8f85-e6016aea2e1e",
"CreateDate": "2026-05-14T06:47:38.8633186-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-14T06:47:38.8633186-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "45840086-14a2-40d1-8739-5cfa4db888f7",
"CreateDate": "2026-05-14T06:47:38.8633186-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-14T06:47:38.8633186-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a917fa36-1e49-4261-b5c0-5c7990a8caa4",
"CreateDate": "2026-05-14T06:47:38.8633186-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-14T06:47:38.8633186-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "544d47ab-f9c0-4898-bdd4-9358b9f31df6",
"EffectiveDate": "2026-05-14T06:47:38.8633186-07:00",
"StatusType": {
"StatusTypeId": "8528de13-30d5-4c11-8730-f9711657b56c",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "a306cbb7-b971-46b8-a935-74b25c936a5e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c10bbaaf-d7d5-4edc-8f85-e6016aea2e1e",
"CreateDate": "2026-05-14T06:47:38.8633186-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-14T06:47:38.8633186-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "8b37ee84-3d45-4bf8-b345-fe19bed22c64",
"CreateDate": "2026-05-14T06:47:38.8633186-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-14T06:47:38.8633186-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "77194b26-6ccd-45c6-9014-5ae3f0b5f645",
"CreateDate": "2026-05-14T06:47:38.8633186-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-14T06:47:38.8633186-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "3fe8c7c9-e6b4-4776-bc62-1437cf24983f",
"EffectiveDate": "2026-05-14T06:47:38.8633186-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "52d42f5e-346b-4761-983c-f9bf6d166ea7",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b0c0f22f-1e60-4bd8-8b84-f7677f1e38f0",
"CreateDate": "2026-05-14T06:47:38.8633186-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-14T06:47:38.8633186-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "cd6bb8ab-cdd6-481a-88b4-b2347b1ffff4",
"CreateDate": "2026-05-14T06:47:38.8633186-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-14T06:47:38.8633186-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-05-14T06:47:38.8633186-07:00",
"MeasurementValueNeededDate": "2026-05-14T06:47:38.8633186-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "657220cb-0455-4cbe-9b3a-902ac594b01d",
"CreateDate": "2026-05-14T06:47:38.8633186-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-14T06:47:38.8633186-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "54b99140-31b8-433b-8a1a-5e360e319c9a",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d5e2326b-b2ea-438a-88e1-f9b880455b48",
"CreateDate": "2026-05-14T06:47:38.8633186-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-14T06:47:38.8633186-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-05-14T06:47:38.8633186-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "88aef4da-0951-4c22-9014-125162b2261e",
"CreateDate": "2026-05-14T06:47:38.8633186-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-14T06:47:38.8633186-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}