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": "96ca5b39-4b75-4448-bb3c-b27cbbea0cf5",
"Asset": {
"AssetId": "8d00b53c-7a5c-482f-8aca-3e9705006104",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "3e603673-8816-445c-8dd5-296cf079bdeb",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "3851035e-b991-41b8-8294-2b7aa6b91bc3",
"CreateDate": "2026-07-19T19:19:08.9539399-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-19T19:19:08.9539399-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "1c9a4638-8387-417a-9f9c-ae093a4ed72a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-19T19:19:08.9539399-07:00",
"MeasurementValueNeededDate": "2026-07-19T19:19:08.9539399-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "70bbd50d-518f-4b8f-9870-d59e212be082",
"CreateDate": "2026-07-19T19:19:08.9539399-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-19T19:19:08.9539399-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "dae127f9-d63f-446b-ad68-993d465ab5c3",
"EffectiveDate": "2026-07-19T19:19:08.9539399-07:00",
"StateType": {
"StateTypeId": "863dc9c5-62b7-436d-8ff9-f4dbf20126ee",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "3e603673-8816-445c-8dd5-296cf079bdeb",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "3851035e-b991-41b8-8294-2b7aa6b91bc3",
"CreateDate": "2026-07-19T19:19:08.9539399-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-19T19:19:08.9539399-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "32c98c3c-160e-49e9-9cee-afff6235956d",
"CreateDate": "2026-07-19T19:19:08.9539399-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-19T19:19:08.9539399-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e213fc7a-2fa2-4638-b5fa-ff0ec0233e7a",
"CreateDate": "2026-07-19T19:19:08.9539399-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-19T19:19:08.9539399-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "190791d0-dca5-48ca-8b75-1c717b547b6f",
"EffectiveDate": "2026-07-19T19:19:08.9539399-07:00",
"StatusType": {
"StatusTypeId": "14e8057f-a29c-4aba-9f2d-36259072b7d2",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "3e603673-8816-445c-8dd5-296cf079bdeb",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "3851035e-b991-41b8-8294-2b7aa6b91bc3",
"CreateDate": "2026-07-19T19:19:08.9539399-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-19T19:19:08.9539399-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "cefb3525-fbb8-4246-8a09-e7f818db220c",
"CreateDate": "2026-07-19T19:19:08.9539399-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-19T19:19:08.9539399-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "22530c59-80e4-4d27-a988-3e1fee272ccc",
"CreateDate": "2026-07-19T19:19:08.9539399-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-19T19:19:08.9539399-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "f907ee41-589f-47e7-9d97-929837433dc0",
"EffectiveDate": "2026-07-19T19:19:08.9539399-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "fe1878c8-39eb-4d4c-95a8-df21ebde991a",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0cdc9f73-baea-4d49-abb9-bbbaea8ad645",
"CreateDate": "2026-07-19T19:19:08.9539399-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-19T19:19:08.9539399-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "48afdcbb-e389-4d78-9650-3331b35c2383",
"CreateDate": "2026-07-19T19:19:08.9539399-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-19T19:19:08.9539399-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-07-19T19:19:08.9539399-07:00",
"MeasurementValueNeededDate": "2026-07-19T19:19:08.9539399-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b2f72b0e-cee1-4e0a-8310-1158294c364d",
"CreateDate": "2026-07-19T19:19:08.9539399-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-19T19:19:08.9539399-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "29a35884-8f80-4946-ac26-45b0e59d9aac",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "fba8c680-f779-4755-ae26-4e95ee98ef6f",
"CreateDate": "2026-07-19T19:19:08.9539399-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-07-19T19:19:08.9539399-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-07-19T19:19:08.9539399-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "071890a3-f5a4-4e4d-b13c-e93081ea4993",
"CreateDate": "2026-07-19T19:19:08.9539399-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-19T19:19:08.9539399-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": "becc37f2-8dab-4eaf-8cdd-0cea7a256455",
"Asset": {
"AssetId": "d5c9c42b-f7ef-4c38-a5c8-51223eea1b5d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "11dcb966-8630-49e6-b1c7-7d9da85032e8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1db449f9-5c0c-4103-866d-140b8a4520ce",
"CreateDate": "2026-07-19T19:19:08.9539399-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-19T19:19:08.9539399-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "b5adb750-f1cb-418a-9085-f198c9118198",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-19T19:19:08.9539399-07:00",
"MeasurementValueNeededDate": "2026-07-19T19:19:08.9539399-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e8f35a42-3d9d-4851-b9f4-04532ade2703",
"CreateDate": "2026-07-19T19:19:08.9539399-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-19T19:19:08.9539399-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "dbdac39e-b753-43f4-91d5-c6b87aadab9e",
"EffectiveDate": "2026-07-19T19:19:08.9539399-07:00",
"StateType": {
"StateTypeId": "161aa6bc-0bdd-49ba-90aa-0e00a565cc8c",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "11dcb966-8630-49e6-b1c7-7d9da85032e8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1db449f9-5c0c-4103-866d-140b8a4520ce",
"CreateDate": "2026-07-19T19:19:08.9539399-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-19T19:19:08.9539399-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "67a98045-f463-4174-a9b9-6e1c1e5fe911",
"CreateDate": "2026-07-19T19:19:08.9539399-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-19T19:19:08.9539399-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "08f0bec9-7f1e-4ff9-a2bd-5c1d943d5bba",
"CreateDate": "2026-07-19T19:19:08.9539399-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-19T19:19:08.9539399-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "8fd5ca4a-7959-4ca1-a89e-e55a6fb267c0",
"EffectiveDate": "2026-07-19T19:19:08.9539399-07:00",
"StatusType": {
"StatusTypeId": "feb5b9c6-82a7-4385-863b-4be7a0e705a6",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "11dcb966-8630-49e6-b1c7-7d9da85032e8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1db449f9-5c0c-4103-866d-140b8a4520ce",
"CreateDate": "2026-07-19T19:19:08.9539399-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-19T19:19:08.9539399-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "f677dade-7eb6-45fb-8f04-597a0efd631f",
"CreateDate": "2026-07-19T19:19:08.9539399-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-19T19:19:08.9539399-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1bed65dd-1a19-481c-8304-058a2434cd10",
"CreateDate": "2026-07-19T19:19:08.9539399-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-19T19:19:08.9539399-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "8d91479d-037b-4049-ae54-8cb2c9bf2800",
"EffectiveDate": "2026-07-19T19:19:08.9539399-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "6cd1dc37-6773-4c09-a0db-304cc5e62745",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "85c7d395-6505-468a-956d-e164cba4ac78",
"CreateDate": "2026-07-19T19:19:08.9539399-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-19T19:19:08.9539399-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1f4209da-785f-4eee-a442-7f7c41b554f2",
"CreateDate": "2026-07-19T19:19:08.9539399-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-19T19:19:08.9539399-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-07-19T19:19:08.9539399-07:00",
"MeasurementValueNeededDate": "2026-07-19T19:19:08.9539399-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9c4400d6-9f85-43b7-a0e5-067041133299",
"CreateDate": "2026-07-19T19:19:08.9539399-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-19T19:19:08.9539399-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "3016899b-06aa-471d-9220-b5981249faea",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e8241cb3-0dc8-46c8-8c17-e53946d5e325",
"CreateDate": "2026-07-19T19:19:08.9539399-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-07-19T19:19:08.9539399-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-07-19T19:19:08.9539399-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6bbf1756-f664-4ede-b7f6-ef4ba43b0a72",
"CreateDate": "2026-07-19T19:19:08.9539399-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-19T19:19:08.9539399-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}