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": "acdfff7a-dc6c-44d1-b556-c45da33a7230",
"Asset": {
"AssetId": "d5b60c1d-f61e-44bc-927b-44d44fe3005b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "893e5ade-3742-42d0-b7cf-fed90a300173",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e3d84753-1950-45bf-a360-ab0705806c6d",
"CreateDate": "2026-03-22T10:25:52.0140196-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-22T10:25:52.0140196-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "8033c77b-a891-4f75-9ce9-42a745c56c02",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-22T10:25:52.0140196-07:00",
"MeasurementValueNeededDate": "2026-03-22T10:25:52.0140196-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "dea5abfe-ff5d-4a65-8516-078116b2ed1b",
"CreateDate": "2026-03-22T10:25:52.0140196-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-22T10:25:52.0140196-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "e235025e-4244-4720-b736-c27c41dfc99c",
"EffectiveDate": "2026-03-22T10:25:52.0140196-07:00",
"StateType": {
"StateTypeId": "bf10a371-98ae-4419-8720-212826e7b58e",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "893e5ade-3742-42d0-b7cf-fed90a300173",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e3d84753-1950-45bf-a360-ab0705806c6d",
"CreateDate": "2026-03-22T10:25:52.0140196-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-22T10:25:52.0140196-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "9219855d-924c-47f1-8b9d-f87210264823",
"CreateDate": "2026-03-22T10:25:52.0140196-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-22T10:25:52.0140196-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f9783495-0187-4f16-a4d4-be4cc7051ab3",
"CreateDate": "2026-03-22T10:25:52.0140196-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-22T10:25:52.0140196-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "aac37b8b-3df4-4f0e-8fe3-bb419c69a796",
"EffectiveDate": "2026-03-22T10:25:52.0140196-07:00",
"StatusType": {
"StatusTypeId": "f47cc2a3-ef5e-476f-9530-ff219e6d18ab",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "893e5ade-3742-42d0-b7cf-fed90a300173",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e3d84753-1950-45bf-a360-ab0705806c6d",
"CreateDate": "2026-03-22T10:25:52.0140196-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-22T10:25:52.0140196-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "6f9d9b31-6f99-4e05-a34e-9a8da54261ad",
"CreateDate": "2026-03-22T10:25:52.0140196-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-22T10:25:52.0140196-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0f05c538-fdb0-4235-b632-997bbefefa8d",
"CreateDate": "2026-03-22T10:25:52.0140196-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-22T10:25:52.0140196-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "aeb259bd-3151-4f9e-bad2-bc9e67c25b68",
"EffectiveDate": "2026-03-22T10:25:52.0140196-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "9c209549-9be7-4a37-9e92-34e99dead8e1",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "8ffa77a9-c656-4b22-8524-c23757e83f80",
"CreateDate": "2026-03-22T10:25:52.0140196-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-22T10:25:52.0140196-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "68bda545-8552-4a87-8d64-afeb1fc8c8f3",
"CreateDate": "2026-03-22T10:25:52.0140196-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-22T10:25:52.0140196-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-22T10:25:52.0140196-07:00",
"MeasurementValueNeededDate": "2026-03-22T10:25:52.0140196-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e6ae4133-71b1-44ea-80c5-e2f784d15880",
"CreateDate": "2026-03-22T10:25:52.0140196-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-22T10:25:52.0140196-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "d665de4f-c5ac-4bd6-bd4c-6a5995846b36",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d4c1581a-b471-45e0-9f0c-29aaea58530a",
"CreateDate": "2026-03-22T10:25:52.0140196-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-22T10:25:52.0140196-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-22T10:25:52.0140196-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a1066749-afc0-4c4c-b807-098f9477b140",
"CreateDate": "2026-03-22T10:25:52.0140196-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-22T10:25:52.0140196-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": "b22fcb0a-99c1-4450-8fe7-27cd8fe50d4d",
"Asset": {
"AssetId": "f6914534-ee0e-48d7-b9f4-9b5a294bd111",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d87fb58b-0259-46a3-b53a-fec79d247535",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b3e4adb8-f7a8-4b69-9d61-9fc03e244f9c",
"CreateDate": "2026-03-22T10:25:52.0140196-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-22T10:25:52.0140196-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "2dccec52-f4ee-4b75-8502-24d1e6cc7888",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-22T10:25:52.0140196-07:00",
"MeasurementValueNeededDate": "2026-03-22T10:25:52.0140196-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7f8c4851-8899-4f56-b3d6-addcb0d5a707",
"CreateDate": "2026-03-22T10:25:52.0140196-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-22T10:25:52.0140196-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "cb6bc77c-90a1-4c27-926e-0826530e50c5",
"EffectiveDate": "2026-03-22T10:25:52.0140196-07:00",
"StateType": {
"StateTypeId": "1cc8f3e1-1371-47b6-93c0-691f2434ffb7",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "d87fb58b-0259-46a3-b53a-fec79d247535",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b3e4adb8-f7a8-4b69-9d61-9fc03e244f9c",
"CreateDate": "2026-03-22T10:25:52.0140196-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-22T10:25:52.0140196-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "78416cbd-1954-40b1-a574-24f69323beeb",
"CreateDate": "2026-03-22T10:25:52.0140196-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-22T10:25:52.0140196-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c91ab71e-1d9b-4ac4-bf11-91148e82ea81",
"CreateDate": "2026-03-22T10:25:52.0140196-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-22T10:25:52.0140196-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "4e47b53e-51a8-4e5a-9d82-cc3f86311b5e",
"EffectiveDate": "2026-03-22T10:25:52.0140196-07:00",
"StatusType": {
"StatusTypeId": "e52a1f40-98d9-49b6-a1c3-5d3ff529e9cf",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "d87fb58b-0259-46a3-b53a-fec79d247535",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b3e4adb8-f7a8-4b69-9d61-9fc03e244f9c",
"CreateDate": "2026-03-22T10:25:52.0140196-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-22T10:25:52.0140196-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "6afee856-4df4-493e-ac39-f1ffd96c7e85",
"CreateDate": "2026-03-22T10:25:52.0140196-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-22T10:25:52.0140196-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "cdedfb3f-e411-46df-9792-585a41aa53cc",
"CreateDate": "2026-03-22T10:25:52.0140196-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-22T10:25:52.0140196-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "c46ed6ac-eda5-4a81-9762-e61ff96c96dd",
"EffectiveDate": "2026-03-22T10:25:52.0140196-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "86685b2b-9c7b-4c41-8ffd-9b17df26d2ec",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "078182a4-8a23-465f-8a9f-c21d9643181e",
"CreateDate": "2026-03-22T10:25:52.0140196-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-22T10:25:52.0140196-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a86c1a57-48ea-436e-9574-2f24200fd141",
"CreateDate": "2026-03-22T10:25:52.0140196-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-22T10:25:52.0140196-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-22T10:25:52.0140196-07:00",
"MeasurementValueNeededDate": "2026-03-22T10:25:52.0140196-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "de6e1d0b-1dec-4c2a-a698-92f264daff2e",
"CreateDate": "2026-03-22T10:25:52.0140196-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-22T10:25:52.0140196-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "4ef38565-4fd9-4328-a350-b129895b702f",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "81b8e07b-c6e4-4ae0-83b4-9cde9970ee5e",
"CreateDate": "2026-03-22T10:25:52.0140196-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-22T10:25:52.0140196-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-22T10:25:52.0140196-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "3ccc06d9-96a1-4fba-9ba8-6818c8e0b5bc",
"CreateDate": "2026-03-22T10:25:52.0140196-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-22T10:25:52.0140196-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}