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": "532c8f1a-1afd-4641-ada8-43f2083c481c",
"Asset": {
"AssetId": "498c2f71-76cb-428a-830c-35fb082f2b4f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "7489c100-1fb8-4c93-82b2-6119da6afc24",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "53fa22d8-8141-46ee-bfbe-4cd8eca1233f",
"CreateDate": "2026-06-17T17:24:31.3087165-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:24:31.3087165-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "dfa826b5-c0a7-49be-a1a7-6a2e1ecee71b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-17T17:24:31.3087165-07:00",
"MeasurementValueNeededDate": "2026-06-17T17:24:31.3087165-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "4da55f9a-3d8a-4c2c-9b1a-49eb78286b6a",
"CreateDate": "2026-06-17T17:24:31.3087165-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-17T17:24:31.3087165-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "2e72385b-d80f-43ac-8cef-4bb6eccb6529",
"EffectiveDate": "2026-06-17T17:24:31.3087165-07:00",
"StateType": {
"StateTypeId": "94cef853-8e7e-4f47-ba9d-e5613bf1c54a",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "7489c100-1fb8-4c93-82b2-6119da6afc24",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "53fa22d8-8141-46ee-bfbe-4cd8eca1233f",
"CreateDate": "2026-06-17T17:24:31.3087165-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:24:31.3087165-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "99b07b24-729a-4980-9f62-9ffde3110a1f",
"CreateDate": "2026-06-17T17:24:31.3087165-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-17T17:24:31.3087165-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "909e429a-9830-4940-8197-7b47c5d83277",
"CreateDate": "2026-06-17T17:24:31.3087165-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-17T17:24:31.3087165-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "910fe09e-08cb-4dc5-a241-dd33c45f8a1b",
"EffectiveDate": "2026-06-17T17:24:31.3087165-07:00",
"StatusType": {
"StatusTypeId": "a531fa91-c50c-4210-83c4-401be7fd4f87",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "7489c100-1fb8-4c93-82b2-6119da6afc24",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "53fa22d8-8141-46ee-bfbe-4cd8eca1233f",
"CreateDate": "2026-06-17T17:24:31.3087165-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:24:31.3087165-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "a7934cb8-946e-4415-b8b4-71e3a57b370d",
"CreateDate": "2026-06-17T17:24:31.3087165-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-17T17:24:31.3087165-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b3a2620b-a963-415a-b913-ed8b56835a1e",
"CreateDate": "2026-06-17T17:24:31.3087165-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-17T17:24:31.3087165-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "98c9d286-2512-4f82-ba3d-212da1fe34e9",
"EffectiveDate": "2026-06-17T17:24:31.3087165-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "0e9b660f-5917-43ac-a84f-0c3c6cdf0ffd",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ebb70efb-6c32-49aa-9cd7-3c26f5f3689b",
"CreateDate": "2026-06-17T17:24:31.3087165-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-17T17:24:31.3087165-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f68d5f27-59ed-48c8-9a1e-4257d3c163af",
"CreateDate": "2026-06-17T17:24:31.3087165-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-17T17:24:31.3087165-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-06-17T17:24:31.3087165-07:00",
"MeasurementValueNeededDate": "2026-06-17T17:24:31.3087165-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "4f3e0683-674f-4907-b002-98b9a6c42d19",
"CreateDate": "2026-06-17T17:24:31.3087165-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:24:31.3087165-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "da556a37-76a5-4d79-9850-fe3daf1ebecc",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "32bc5632-c90b-4649-8558-3c2c5e51afe6",
"CreateDate": "2026-06-17T17:24:31.3087165-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-17T17:24:31.3087165-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-06-17T17:24:31.3087165-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9e5db077-bea1-4899-b710-7252405e72b7",
"CreateDate": "2026-06-17T17:24:31.3087165-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-17T17:24:31.3087165-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": "77ffc8c7-6c04-495f-834a-56c30d456c3f",
"Asset": {
"AssetId": "e2725bc5-9bed-4d2b-9233-d4d778a675e4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "f0427aba-2b6c-4ebf-9cf3-d4791ad75fc6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1dd2581d-c06f-4d08-82f2-8ba8bbe34046",
"CreateDate": "2026-06-17T17:24:31.3087165-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:24:31.3087165-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "300b5c9e-a0d0-4a3e-84ab-dbfbdafbfa1a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-17T17:24:31.3087165-07:00",
"MeasurementValueNeededDate": "2026-06-17T17:24:31.3087165-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ebb3b33b-30a4-4864-9fcd-02f600f1bbe8",
"CreateDate": "2026-06-17T17:24:31.3087165-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-17T17:24:31.3087165-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "d8c5a3ff-3538-4d31-94c2-3645d2aa74f8",
"EffectiveDate": "2026-06-17T17:24:31.3087165-07:00",
"StateType": {
"StateTypeId": "69183813-230f-4b6c-ba4d-0858500ba361",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "f0427aba-2b6c-4ebf-9cf3-d4791ad75fc6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1dd2581d-c06f-4d08-82f2-8ba8bbe34046",
"CreateDate": "2026-06-17T17:24:31.3087165-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:24:31.3087165-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "8e465d36-d33d-4b42-b37a-79424597b843",
"CreateDate": "2026-06-17T17:24:31.3087165-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-17T17:24:31.3087165-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0eb0dd50-394b-492d-8ef0-bdc587a9736a",
"CreateDate": "2026-06-17T17:24:31.3087165-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-17T17:24:31.3087165-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "38d42744-28d2-40ac-8b0b-2deaf1412cfa",
"EffectiveDate": "2026-06-17T17:24:31.3087165-07:00",
"StatusType": {
"StatusTypeId": "7b672663-5984-4659-a2be-8f52698daaed",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "f0427aba-2b6c-4ebf-9cf3-d4791ad75fc6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1dd2581d-c06f-4d08-82f2-8ba8bbe34046",
"CreateDate": "2026-06-17T17:24:31.3087165-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:24:31.3087165-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "b2dd48c6-f31b-41c6-915a-1246c5f2b159",
"CreateDate": "2026-06-17T17:24:31.3087165-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-17T17:24:31.3087165-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "8136012b-90cc-4e70-8838-e5f20733364f",
"CreateDate": "2026-06-17T17:24:31.3087165-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-17T17:24:31.3087165-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "e42bf5d3-45ec-4b0f-89ae-f518211857b6",
"EffectiveDate": "2026-06-17T17:24:31.3087165-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "04038a89-11f4-48f9-bbec-272bc14291a7",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "171e2eef-cb35-4fac-ae14-8c167d4fdfbc",
"CreateDate": "2026-06-17T17:24:31.3087165-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-17T17:24:31.3087165-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c608045c-a662-4552-949a-9e9547fc0080",
"CreateDate": "2026-06-17T17:24:31.3087165-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-17T17:24:31.3087165-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-06-17T17:24:31.3087165-07:00",
"MeasurementValueNeededDate": "2026-06-17T17:24:31.3087165-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "59d93356-023d-41b2-9a33-a3034384fee3",
"CreateDate": "2026-06-17T17:24:31.3087165-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:24:31.3087165-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "c27a2d0f-f03d-4c01-a7f9-7d672cab3b3b",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "2a5b7d88-6126-4438-9e90-9e0d6bc77e40",
"CreateDate": "2026-06-17T17:24:31.3087165-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-17T17:24:31.3087165-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-06-17T17:24:31.3087165-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "92c271e4-57ff-4e36-98ff-f320178496cb",
"CreateDate": "2026-06-17T17:24:31.3087165-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-17T17:24:31.3087165-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}