PUT Notes
Updates the given note.
Request Information
URI Parameters
None.
Body Parameters
The note to update
NoteName | 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": "fd948d98-686e-46d2-8926-888f36447d89", "Asset": { "AssetId": "e01cf6d0-25e6-4f36-9d21-f997c5b29aa1", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "f8dbcc1b-50b8-4f01-8507-e579e1623b6e", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "401017b1-f4c6-4f9c-9ca8-3438bebd83af", "CreateDate": "2025-04-25T15:42:38.2696917-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-25T15:42:38.2696917-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "e3a9812f-06f7-4338-af7e-981dc1b29fe0", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-25T15:42:38.2696917-07:00", "MeasurementValueNeededDate": "2025-04-25T15:42:38.2696917-07:00", "SourceSystemId": "sample string 3", "CompanyId": "08c3f162-3547-4a00-b5f3-0bfcafc392a6", "CreateDate": "2025-04-25T15:42:38.2696917-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T15:42:38.2696917-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "525cfe8b-46af-4ac2-be63-99df59e886d5", "EffectiveDate": "2025-04-25T15:42:38.2696917-07:00", "StateType": { "StateTypeId": "2aecd57e-0729-42ef-8cfb-4fa954e9b568", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "f8dbcc1b-50b8-4f01-8507-e579e1623b6e", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "401017b1-f4c6-4f9c-9ca8-3438bebd83af", "CreateDate": "2025-04-25T15:42:38.2696917-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-25T15:42:38.2696917-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "0aeaa4d4-9bd4-4173-830d-ca64a1c208f7", "CreateDate": "2025-04-25T15:42:38.2696917-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T15:42:38.2696917-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "c11ee0a1-6c16-4c24-9791-7f3dfcbf8934", "CreateDate": "2025-04-25T15:42:38.2696917-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-04-25T15:42:38.2696917-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "44d8b313-f2fb-421f-a6d0-e49375b45aa9", "EffectiveDate": "2025-04-25T15:42:38.2696917-07:00", "StatusType": { "StatusTypeId": "97168bad-953d-42db-8ac2-5b76363bd35b", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "f8dbcc1b-50b8-4f01-8507-e579e1623b6e", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "401017b1-f4c6-4f9c-9ca8-3438bebd83af", "CreateDate": "2025-04-25T15:42:38.2696917-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-25T15:42:38.2696917-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "d8ca4063-0b62-4726-86d7-45fe82b80996", "CreateDate": "2025-04-25T15:42:38.2696917-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-25T15:42:38.2696917-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "b1fbfa9a-14ce-4d3d-a5f3-b08cfc6971c8", "CreateDate": "2025-04-25T15:42:38.2696917-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-04-25T15:42:38.2696917-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "5de3c3e6-e57a-4ee8-9705-7305015828c4", "EffectiveDate": "2025-04-25T15:42:38.2696917-07:00", "WellPurposeType": { "WellPurposeTypeId": "24873731-5eae-4900-85a5-5835e25eebcf", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "04ef74e5-6174-402d-8477-f5a12061f991", "CreateDate": "2025-04-25T15:42:38.2696917-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-25T15:42:38.2696917-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "1f614a8b-530c-489b-a31a-83858dc6e17a", "CreateDate": "2025-04-25T15:42:38.2696917-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-04-25T15:42:38.2696917-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-04-25T15:42:38.2696917-07:00", "MeasurementValueNeededDate": "2025-04-25T15:42:38.2696917-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "224f102d-fe43-4d24-afc9-635a8f1419ac", "CreateDate": "2025-04-25T15:42:38.2696917-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-25T15:42:38.2696917-07:00", "LastModifiedUser": "sample string 8" }, "OnBehalfOf": "sample string 1", "NoteCategory": { "NoteCategoryId": "6d0b4909-fa9e-49ed-ba05-44db4f098e9c", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "8f81251f-434c-4551-bab1-913ae7a87244", "CreateDate": "2025-04-25T15:42:38.2696917-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-04-25T15:42:38.2696917-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2025-04-25T15:42:38.2696917-07:00", "NoteHTML": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "4ccc9225-eef9-4580-9287-7b439814a1f1", "CreateDate": "2025-04-25T15:42:38.2696917-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T15:42:38.2696917-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": "6339d09d-51fc-4812-84d6-f838ea3a2a46", "Asset": { "AssetId": "14f72d98-f2e2-473d-b5e6-95abaa81e042", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "9dab0a42-8506-4914-bd2f-2530a1a5cda3", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "e3c23c96-1890-4d20-8c1a-ba5394cfa454", "CreateDate": "2025-04-25T15:42:38.2696917-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-25T15:42:38.2696917-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "13842df6-6eef-4a90-9e08-b68a3884a6ec", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-25T15:42:38.2696917-07:00", "MeasurementValueNeededDate": "2025-04-25T15:42:38.2696917-07:00", "SourceSystemId": "sample string 3", "CompanyId": "6aea85c4-d1f4-49a2-9ab6-e7ecde54c819", "CreateDate": "2025-04-25T15:42:38.2696917-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T15:42:38.2696917-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "6158f66f-7104-4228-914c-7eab49a6abb0", "EffectiveDate": "2025-04-25T15:42:38.2696917-07:00", "StateType": { "StateTypeId": "054bdd4f-5d27-4aa3-a963-0b50cae5a29c", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "9dab0a42-8506-4914-bd2f-2530a1a5cda3", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "e3c23c96-1890-4d20-8c1a-ba5394cfa454", "CreateDate": "2025-04-25T15:42:38.2696917-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-25T15:42:38.2696917-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "63339d50-3c15-47ba-95c1-82def591250e", "CreateDate": "2025-04-25T15:42:38.2696917-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T15:42:38.2696917-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "185558d5-eed1-4dab-b9b4-bb6783226c61", "CreateDate": "2025-04-25T15:42:38.2696917-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-04-25T15:42:38.2696917-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "4405c36e-7ce3-4eb5-aeea-6e82c0bca8de", "EffectiveDate": "2025-04-25T15:42:38.2696917-07:00", "StatusType": { "StatusTypeId": "297bd1f6-1dfb-4d56-8b19-2244e3285bb3", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "9dab0a42-8506-4914-bd2f-2530a1a5cda3", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "e3c23c96-1890-4d20-8c1a-ba5394cfa454", "CreateDate": "2025-04-25T15:42:38.2696917-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-25T15:42:38.2696917-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "b92015f4-ae29-4d0c-a533-20f6089f22d1", "CreateDate": "2025-04-25T15:42:38.2696917-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-25T15:42:38.2696917-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "cb8f6bdb-cc6a-46fc-8235-231f4e68923d", "CreateDate": "2025-04-25T15:42:38.2696917-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-04-25T15:42:38.2696917-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "8cf4ab76-4ef0-40fc-8e0c-ad716fde5229", "EffectiveDate": "2025-04-25T15:42:38.2696917-07:00", "WellPurposeType": { "WellPurposeTypeId": "62e15eca-c0da-4131-9147-e682bfe77200", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "6b4b5ccd-bb50-4c0f-8421-ed265233c686", "CreateDate": "2025-04-25T15:42:38.2696917-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-25T15:42:38.2696917-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "0b73d2ff-1de5-4718-91bf-fab7a917e708", "CreateDate": "2025-04-25T15:42:38.2696917-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-04-25T15:42:38.2696917-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-04-25T15:42:38.2696917-07:00", "MeasurementValueNeededDate": "2025-04-25T15:42:38.2696917-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "c6289af6-e9dc-4f62-8c73-bb81b4db3291", "CreateDate": "2025-04-25T15:42:38.2696917-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-25T15:42:38.2696917-07:00", "LastModifiedUser": "sample string 8" }, "OnBehalfOf": "sample string 1", "NoteCategory": { "NoteCategoryId": "87c0c890-89ec-485f-8d5a-88061ca89848", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "891fb4c6-afe1-4c3f-8b7c-beae03d6acfa", "CreateDate": "2025-04-25T15:42:38.2696917-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-04-25T15:42:38.2696917-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2025-04-25T15:42:38.2696917-07:00", "NoteHTML": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "2f428a7c-de08-4209-b613-2d0b8d1cf49c", "CreateDate": "2025-04-25T15:42:38.2696917-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T15:42:38.2696917-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }