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": "c8f1f197-5908-44dd-b9c7-68d7c296350c",
"Asset": {
"AssetId": "49384b33-710c-461a-8bd5-ea3fc42392eb",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "34d0d10a-be40-4b3e-ba67-6cfded797ce3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7929b2d8-e5d6-4f23-bfd6-9dc115ba4079",
"CreateDate": "2026-10-12T09:01:48.1075067-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-12T09:01:48.1075067-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "e78da215-06c1-4bbe-97e1-f0b7bca16eb7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-12T09:01:48.1075067-07:00",
"MeasurementValueNeededDate": "2026-10-12T09:01:48.1075067-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "183ba97e-624a-4fa6-8f94-e07daff939e1",
"CreateDate": "2026-10-12T09:01:48.1075067-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-12T09:01:48.1075067-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "591e61e7-c958-4459-ba27-bb97bade86d6",
"EffectiveDate": "2026-10-12T09:01:48.1075067-07:00",
"StateType": {
"StateTypeId": "e8806e65-327b-4c06-bfe3-d4169a25d171",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "34d0d10a-be40-4b3e-ba67-6cfded797ce3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7929b2d8-e5d6-4f23-bfd6-9dc115ba4079",
"CreateDate": "2026-10-12T09:01:48.1075067-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-12T09:01:48.1075067-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "e880cff7-679d-4ab5-863b-bb1e196512a2",
"CreateDate": "2026-10-12T09:01:48.1075067-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-12T09:01:48.1075067-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "afd479b4-ecd6-48d8-b913-dbecd86deb8f",
"CreateDate": "2026-10-12T09:01:48.1075067-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-12T09:01:48.1075067-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "038aabce-2363-4ede-ae4b-d7f075dc683b",
"EffectiveDate": "2026-10-12T09:01:48.1075067-07:00",
"StatusType": {
"StatusTypeId": "d5fb6e96-d545-4cba-954c-bb11d4d75670",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "34d0d10a-be40-4b3e-ba67-6cfded797ce3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7929b2d8-e5d6-4f23-bfd6-9dc115ba4079",
"CreateDate": "2026-10-12T09:01:48.1075067-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-12T09:01:48.1075067-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "3f6a51a0-e355-45b7-9aad-78007b90614d",
"CreateDate": "2026-10-12T09:01:48.1075067-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-12T09:01:48.1075067-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1f9cb31e-8587-446c-ae78-afcdf7818b87",
"CreateDate": "2026-10-12T09:01:48.1075067-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-12T09:01:48.1075067-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "d0c4849b-e1bd-4f5f-b8ea-4851c1a5478e",
"EffectiveDate": "2026-10-12T09:01:48.1075067-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "39747310-dc72-42d9-ac70-d375446be069",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c34af827-2e20-40ad-98ff-08ee2cbd4c28",
"CreateDate": "2026-10-12T09:01:48.1075067-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-12T09:01:48.1075067-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3ca482a1-868c-4609-b670-d893da873971",
"CreateDate": "2026-10-12T09:01:48.1075067-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-12T09:01:48.1075067-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-10-12T09:01:48.1075067-07:00",
"MeasurementValueNeededDate": "2026-10-12T09:01:48.1075067-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "43db91d6-c594-4022-b121-a4ba5cd2882c",
"CreateDate": "2026-10-12T09:01:48.1075067-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-12T09:01:48.1075067-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "b181ae0e-5e5b-4f5e-8dde-67582b593eef",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "cde13c41-045c-4499-ba74-705c1eef31d0",
"CreateDate": "2026-10-12T09:01:48.1075067-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-12T09:01:48.1075067-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-10-12T09:01:48.1075067-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "83490c2b-13ca-4bbb-94e4-5cf72479a4ad",
"CreateDate": "2026-10-12T09:01:48.1075067-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-12T09:01:48.1075067-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": "2f77e57c-6d65-49c0-964a-0a9aee1120c3",
"Asset": {
"AssetId": "e1a74827-18ac-4a3e-a12f-6efba0ce56cb",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1d1b2af3-170e-459e-8f28-e0363ca43591",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "832fbe59-bce4-4dea-8caf-23e29d28137b",
"CreateDate": "2026-10-12T09:01:48.1075067-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-12T09:01:48.1075067-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "db1d816d-c3d5-407a-a2ba-5ef8ec1250ee",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-12T09:01:48.1075067-07:00",
"MeasurementValueNeededDate": "2026-10-12T09:01:48.1075067-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "cfcda59d-2163-41d1-b2fe-e1766cb09ff2",
"CreateDate": "2026-10-12T09:01:48.1075067-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-12T09:01:48.1075067-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "1e40e61c-2f98-45b8-9529-e93305045229",
"EffectiveDate": "2026-10-12T09:01:48.1075067-07:00",
"StateType": {
"StateTypeId": "c02ab2c1-7b44-434b-9dc2-368d8f45cf43",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "1d1b2af3-170e-459e-8f28-e0363ca43591",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "832fbe59-bce4-4dea-8caf-23e29d28137b",
"CreateDate": "2026-10-12T09:01:48.1075067-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-12T09:01:48.1075067-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "c872fec5-3b64-4402-b7a8-934b0abc66cd",
"CreateDate": "2026-10-12T09:01:48.1075067-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-12T09:01:48.1075067-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b063e3d1-3c9e-42e1-93b8-bd3c8c76d9ce",
"CreateDate": "2026-10-12T09:01:48.1075067-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-12T09:01:48.1075067-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "36ef4415-103a-402f-b6ff-6813ea70bca6",
"EffectiveDate": "2026-10-12T09:01:48.1075067-07:00",
"StatusType": {
"StatusTypeId": "1670766d-2b15-437f-8d47-fd3d65c0895e",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "1d1b2af3-170e-459e-8f28-e0363ca43591",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "832fbe59-bce4-4dea-8caf-23e29d28137b",
"CreateDate": "2026-10-12T09:01:48.1075067-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-12T09:01:48.1075067-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "65f04097-4fa2-4a35-802f-5fa420c3b3d1",
"CreateDate": "2026-10-12T09:01:48.1075067-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-12T09:01:48.1075067-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "889478b6-80c4-4e55-89b3-d0506c218837",
"CreateDate": "2026-10-12T09:01:48.1075067-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-12T09:01:48.1075067-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "f86891d1-1222-43ae-9bee-43c6ad36f433",
"EffectiveDate": "2026-10-12T09:01:48.1075067-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "0fcf5fcb-d5cd-4a84-88b7-fc9cdff06c08",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "09a31906-288e-4937-a339-035fccd67a43",
"CreateDate": "2026-10-12T09:01:48.1075067-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-12T09:01:48.1075067-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "935a0250-dc7a-4340-9dfb-33ca50cc831b",
"CreateDate": "2026-10-12T09:01:48.1075067-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-12T09:01:48.1075067-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-10-12T09:01:48.1075067-07:00",
"MeasurementValueNeededDate": "2026-10-12T09:01:48.1075067-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "8ae34000-9574-475a-8eaa-9a378e8a16db",
"CreateDate": "2026-10-12T09:01:48.1075067-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-12T09:01:48.1075067-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "69907504-b63a-4f83-8716-4529ab0a9a8c",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1a5e98f5-6fd7-490e-970e-bfb6e30824bc",
"CreateDate": "2026-10-12T09:01:48.1075067-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-12T09:01:48.1075067-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-10-12T09:01:48.1075067-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f0937499-31b7-49f0-a59a-d083a2d0bbe2",
"CreateDate": "2026-10-12T09:01:48.1075067-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-12T09:01:48.1075067-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}