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": "2c62c60b-6dbf-4197-8d6d-20d359427867",
"Asset": {
"AssetId": "5413c2a2-ced5-4482-84f9-cf5805c616a3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "c7475da9-afec-4731-872e-69ffb29833f7",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "41da86dd-2491-428b-b15a-8f62342119b1",
"CreateDate": "2026-03-18T02:33:17.1504086-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-18T02:33:17.1504086-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "c878f0b1-5750-42ff-ba5c-bb7589b4c2fd",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-18T02:33:17.1504086-07:00",
"MeasurementValueNeededDate": "2026-03-18T02:33:17.1504086-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "0e128549-4b4e-4904-aeef-b990ed4aaa1a",
"CreateDate": "2026-03-18T02:33:17.1504086-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-18T02:33:17.1504086-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "a5ac3e0b-2c6e-45fe-84a1-708e5ed7af60",
"EffectiveDate": "2026-03-18T02:33:17.1504086-07:00",
"StateType": {
"StateTypeId": "20db5344-7f1f-4f69-8a0e-357cb5f33ab5",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "c7475da9-afec-4731-872e-69ffb29833f7",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "41da86dd-2491-428b-b15a-8f62342119b1",
"CreateDate": "2026-03-18T02:33:17.1504086-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-18T02:33:17.1504086-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "01b12bd5-597a-4762-b077-6fac64668d4b",
"CreateDate": "2026-03-18T02:33:17.1504086-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-18T02:33:17.1504086-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "70b7c0d7-5c60-40b8-81d8-3ea2505ddb2d",
"CreateDate": "2026-03-18T02:33:17.1504086-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-18T02:33:17.1504086-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "adb13326-db3f-4ab5-b6f4-dd07c70693fd",
"EffectiveDate": "2026-03-18T02:33:17.1504086-07:00",
"StatusType": {
"StatusTypeId": "b29531c7-a142-4d95-8e18-87046ca865c5",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "c7475da9-afec-4731-872e-69ffb29833f7",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "41da86dd-2491-428b-b15a-8f62342119b1",
"CreateDate": "2026-03-18T02:33:17.1504086-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-18T02:33:17.1504086-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "fad24c09-2dee-49de-b4b6-8f791a3786c2",
"CreateDate": "2026-03-18T02:33:17.1504086-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-18T02:33:17.1504086-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "7a2609aa-7df5-4fef-bfb9-7f03d84cbf61",
"CreateDate": "2026-03-18T02:33:17.1504086-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-18T02:33:17.1504086-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "6eaef926-8b69-483d-bd03-eebe62d30b65",
"EffectiveDate": "2026-03-18T02:33:17.1504086-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "a5bab4b9-63a4-46c4-adbe-17f444f7653d",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e1267138-e8d5-44ea-a7ea-c8c2fd363f42",
"CreateDate": "2026-03-18T02:33:17.1504086-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-18T02:33:17.1504086-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ef92846f-192b-4cbe-800f-34cb2e025d3b",
"CreateDate": "2026-03-18T02:33:17.1504086-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-18T02:33:17.1504086-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-18T02:33:17.1504086-07:00",
"MeasurementValueNeededDate": "2026-03-18T02:33:17.1504086-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "3ca24e02-048d-48b8-b94d-0fbbcef4c273",
"CreateDate": "2026-03-18T02:33:17.1504086-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-18T02:33:17.1504086-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "a2a999ce-5e0b-4d1b-bdc5-b3a65864370a",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "fd6bb5c9-b5d7-4cc6-aec7-b55a6fd23aa6",
"CreateDate": "2026-03-18T02:33:17.1504086-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-18T02:33:17.1504086-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-18T02:33:17.1504086-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "44cfb666-b2cb-425d-abe9-f78b0f3095b4",
"CreateDate": "2026-03-18T02:33:17.1504086-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-18T02:33:17.1504086-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": "34b0ee33-41e1-4ac2-922b-96f79f94b764",
"Asset": {
"AssetId": "a9a1817d-7989-40c0-8e33-908a09d4112e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "9ebe6335-d2b4-46f3-8e0c-3d629dc995cf",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "cd9b2bb9-fee0-4f37-b92e-f5efd37f40bd",
"CreateDate": "2026-03-18T02:33:17.1660311-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-18T02:33:17.1660311-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "12b95d0f-360a-4b80-b741-10e1c5aa9039",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-18T02:33:17.1660311-07:00",
"MeasurementValueNeededDate": "2026-03-18T02:33:17.1660311-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "de64fcce-5036-45bf-bbd0-87c9326c5748",
"CreateDate": "2026-03-18T02:33:17.1660311-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-18T02:33:17.1660311-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "35e05374-ef93-4a14-a56a-a149141b3238",
"EffectiveDate": "2026-03-18T02:33:17.1660311-07:00",
"StateType": {
"StateTypeId": "f5113018-fc56-43a9-8dcd-a4404d785e8c",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "9ebe6335-d2b4-46f3-8e0c-3d629dc995cf",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "cd9b2bb9-fee0-4f37-b92e-f5efd37f40bd",
"CreateDate": "2026-03-18T02:33:17.1660311-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-18T02:33:17.1660311-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "88baa553-b460-4cc1-8a2e-c631ae85bbbb",
"CreateDate": "2026-03-18T02:33:17.1660311-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-18T02:33:17.1660311-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "87ae54c2-bcea-4b9f-a1f7-fe5605967711",
"CreateDate": "2026-03-18T02:33:17.1660311-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-18T02:33:17.1660311-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "26fe9202-06f9-4b17-8ee9-2c1c84c13729",
"EffectiveDate": "2026-03-18T02:33:17.1660311-07:00",
"StatusType": {
"StatusTypeId": "8cfc40ea-3170-4ee9-9b10-7206551be4d6",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "9ebe6335-d2b4-46f3-8e0c-3d629dc995cf",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "cd9b2bb9-fee0-4f37-b92e-f5efd37f40bd",
"CreateDate": "2026-03-18T02:33:17.1660311-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-18T02:33:17.1660311-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "dc7e181a-c42c-4500-86a8-cc922b5bea9e",
"CreateDate": "2026-03-18T02:33:17.1660311-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-18T02:33:17.1660311-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "38ee62fb-a556-4966-9120-79ec801da92c",
"CreateDate": "2026-03-18T02:33:17.1660311-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-18T02:33:17.1660311-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "b633bb86-488e-4e6d-b86c-f8fa6b160b55",
"EffectiveDate": "2026-03-18T02:33:17.1660311-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "d05104c5-8612-439f-9656-7e1d481e6107",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "551481d6-32ed-4dc5-8939-5abcf68fd825",
"CreateDate": "2026-03-18T02:33:17.1660311-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-18T02:33:17.1660311-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c3ee98bf-e0dc-45e4-8d22-cddd19a0f489",
"CreateDate": "2026-03-18T02:33:17.1660311-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-18T02:33:17.1660311-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-18T02:33:17.1660311-07:00",
"MeasurementValueNeededDate": "2026-03-18T02:33:17.1660311-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f798e73c-dbce-42a8-8641-95b599b32226",
"CreateDate": "2026-03-18T02:33:17.1660311-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-18T02:33:17.1660311-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "a497d562-4ca6-4876-8df0-03012de7dad7",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "53a40f36-a4c8-4ddb-a015-70bf93a8c91b",
"CreateDate": "2026-03-18T02:33:17.1660311-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-18T02:33:17.1660311-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-18T02:33:17.1660311-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f2db4198-3bff-44f5-a0dc-f58a1a68972a",
"CreateDate": "2026-03-18T02:33:17.1660311-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-18T02:33:17.1660311-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}