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": "f4b1fb74-6394-4309-8f4d-1f6a667ae4b0",
"Asset": {
"AssetId": "146345a8-cea3-4965-9eb3-e15d79c05d5a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "4fae4e78-5d4a-4663-91ba-57665c23e2b1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "004806a8-d397-4168-94bc-d417de382245",
"CreateDate": "2026-04-03T02:02:07.5979611-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-03T02:02:07.5979611-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "bb5ec56c-03f1-467f-b7bb-31ea96bdc235",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-03T02:02:07.5979611-07:00",
"MeasurementValueNeededDate": "2026-04-03T02:02:07.5979611-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "63dc13ea-c385-4a55-938c-5b403aac331f",
"CreateDate": "2026-04-03T02:02:07.5979611-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-03T02:02:07.5979611-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "264bbd7e-8034-48d5-a86e-dcf074d996e5",
"EffectiveDate": "2026-04-03T02:02:07.5979611-07:00",
"StateType": {
"StateTypeId": "3ad69d13-d807-4de9-bafa-df67a9d7f723",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "4fae4e78-5d4a-4663-91ba-57665c23e2b1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "004806a8-d397-4168-94bc-d417de382245",
"CreateDate": "2026-04-03T02:02:07.5979611-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-03T02:02:07.5979611-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "12ebaacb-a0f4-4e73-a7c8-1e42333f3122",
"CreateDate": "2026-04-03T02:02:07.5979611-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-03T02:02:07.5979611-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "013717ff-4ace-4540-bc54-d44741c5a45e",
"CreateDate": "2026-04-03T02:02:07.5979611-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-03T02:02:07.5979611-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "634bc5b7-cff7-4cfd-b925-3ef3532f2b51",
"EffectiveDate": "2026-04-03T02:02:07.5979611-07:00",
"StatusType": {
"StatusTypeId": "a52b3f4a-7753-44f8-a201-22927fe7eddb",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "4fae4e78-5d4a-4663-91ba-57665c23e2b1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "004806a8-d397-4168-94bc-d417de382245",
"CreateDate": "2026-04-03T02:02:07.5979611-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-03T02:02:07.5979611-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "d4177d70-810d-41ff-a4f8-9a883c87ef2a",
"CreateDate": "2026-04-03T02:02:07.5979611-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-03T02:02:07.5979611-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "80df686c-9ab3-49da-9649-13cc22198e13",
"CreateDate": "2026-04-03T02:02:07.5979611-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-03T02:02:07.5979611-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "3d110f23-9b99-423c-b349-58e5217d72f3",
"EffectiveDate": "2026-04-03T02:02:07.5979611-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "90c20436-0ce3-4c4f-9a0c-32ef680e6a2d",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b3901ac7-4dc9-49d9-bf59-9a11d52d9c00",
"CreateDate": "2026-04-03T02:02:07.5979611-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-03T02:02:07.5979611-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "97930ac4-8b1e-4c6d-a135-c2b08463b9e4",
"CreateDate": "2026-04-03T02:02:07.5979611-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-03T02:02:07.5979611-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-04-03T02:02:07.5979611-07:00",
"MeasurementValueNeededDate": "2026-04-03T02:02:07.5979611-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "73d93722-3def-4125-9bee-3c176a7a1eaf",
"CreateDate": "2026-04-03T02:02:07.5979611-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-03T02:02:07.5979611-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "17438f10-fb66-4123-9885-3fd7ec22a29e",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "784dbcda-5db4-4579-9873-eef9b85b0474",
"CreateDate": "2026-04-03T02:02:07.5979611-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-03T02:02:07.5979611-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-04-03T02:02:07.5979611-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a982793d-8383-4978-95b5-a63cec61bb9e",
"CreateDate": "2026-04-03T02:02:07.5979611-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-03T02:02:07.5979611-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": "a5a045a7-8a66-4a7e-aaff-7fc80eb76676",
"Asset": {
"AssetId": "d63630c9-fca2-4f37-b64a-e27a4f7afc44",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "5a97db58-87bf-4f9e-82b8-08f2df10b22e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f2a54943-a8f2-488b-8956-213f688b15b6",
"CreateDate": "2026-04-03T02:02:07.5979611-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-03T02:02:07.5979611-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "405f9b4e-ea0b-40de-a94a-0bfcb1bcac8a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-03T02:02:07.5979611-07:00",
"MeasurementValueNeededDate": "2026-04-03T02:02:07.5979611-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "81173426-a874-45e7-80db-b2e6e96dc3ba",
"CreateDate": "2026-04-03T02:02:07.5979611-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-03T02:02:07.5979611-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "132572cc-577d-4cb5-93b2-d15c98882cac",
"EffectiveDate": "2026-04-03T02:02:07.5979611-07:00",
"StateType": {
"StateTypeId": "5336728d-ed12-422b-b899-6b3aeb17688b",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "5a97db58-87bf-4f9e-82b8-08f2df10b22e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f2a54943-a8f2-488b-8956-213f688b15b6",
"CreateDate": "2026-04-03T02:02:07.5979611-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-03T02:02:07.5979611-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "681451cd-1e80-4234-8088-0506c3816466",
"CreateDate": "2026-04-03T02:02:07.5979611-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-03T02:02:07.5979611-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "99200dfc-1210-4c29-9907-c623b7b9b631",
"CreateDate": "2026-04-03T02:02:07.5979611-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-03T02:02:07.5979611-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "6afc1104-ecfb-4e23-a664-f290e43c380d",
"EffectiveDate": "2026-04-03T02:02:07.5979611-07:00",
"StatusType": {
"StatusTypeId": "e3e3b0a1-ffe0-4613-b4f3-072c88708d89",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "5a97db58-87bf-4f9e-82b8-08f2df10b22e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f2a54943-a8f2-488b-8956-213f688b15b6",
"CreateDate": "2026-04-03T02:02:07.5979611-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-03T02:02:07.5979611-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "617e2dc8-23de-4b2e-948f-d0d2354d6b8a",
"CreateDate": "2026-04-03T02:02:07.5979611-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-03T02:02:07.5979611-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "50383744-afd9-4a62-a909-34720edfae6d",
"CreateDate": "2026-04-03T02:02:07.5979611-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-03T02:02:07.5979611-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "a31e6bdf-b596-459b-8988-46aaa1c0125e",
"EffectiveDate": "2026-04-03T02:02:07.5979611-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "6ad06753-14e8-47b4-8e6d-fddf8165124e",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "31597da6-7bb3-4c20-b996-c2a135a2bc9e",
"CreateDate": "2026-04-03T02:02:07.5979611-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-03T02:02:07.5979611-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "bd644a13-390e-4881-b897-5fe1764e56fe",
"CreateDate": "2026-04-03T02:02:07.5979611-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-03T02:02:07.5979611-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-04-03T02:02:07.5979611-07:00",
"MeasurementValueNeededDate": "2026-04-03T02:02:07.5979611-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6249d579-25ee-48fc-af48-e362610a4109",
"CreateDate": "2026-04-03T02:02:07.5979611-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-03T02:02:07.5979611-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "79d30cc7-5d26-4eca-a197-8646b700e12f",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "922c3799-6bef-47c7-88ce-60eed074e50d",
"CreateDate": "2026-04-03T02:02:07.5979611-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-03T02:02:07.5979611-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-04-03T02:02:07.5979611-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "28af5a1e-e3c1-4eca-b850-465b7b67df07",
"CreateDate": "2026-04-03T02:02:07.5979611-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-03T02:02:07.5979611-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}