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": "6d94e7ff-b624-4c43-9a40-ae4bad04f641",
"Asset": {
"AssetId": "79031d6a-60c8-41d0-8644-2621da33a38c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "e27cf617-436b-47d9-8314-1b0eba4c6ce8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6eca0e32-bad1-4384-99cd-2adf69ef3c29",
"CreateDate": "2026-03-30T16:48:22.8141788-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-30T16:48:22.8141788-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "c33a6547-200f-4d76-88d8-c9cd2742726f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-30T16:48:22.8141788-07:00",
"MeasurementValueNeededDate": "2026-03-30T16:48:22.8141788-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "625a8231-ec7a-476c-a719-afb90c56612e",
"CreateDate": "2026-03-30T16:48:22.8141788-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T16:48:22.8141788-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "e2527547-a1c5-461d-9c17-b7244e4fcf1c",
"EffectiveDate": "2026-03-30T16:48:22.8141788-07:00",
"StateType": {
"StateTypeId": "e1179f34-7a5e-4232-88a4-018a3e9921b7",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "e27cf617-436b-47d9-8314-1b0eba4c6ce8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6eca0e32-bad1-4384-99cd-2adf69ef3c29",
"CreateDate": "2026-03-30T16:48:22.8141788-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-30T16:48:22.8141788-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "1c708b80-5ee6-4b46-9bc1-290ef95aa877",
"CreateDate": "2026-03-30T16:48:22.8141788-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T16:48:22.8141788-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ca180377-0280-458d-964c-8e2dadaa016c",
"CreateDate": "2026-03-30T16:48:22.8141788-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-30T16:48:22.8141788-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "76cfe768-1b9a-4b85-89af-2f180e3fd918",
"EffectiveDate": "2026-03-30T16:48:22.8141788-07:00",
"StatusType": {
"StatusTypeId": "ea48a82b-7e4a-43e7-925b-61d6177db69a",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "e27cf617-436b-47d9-8314-1b0eba4c6ce8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6eca0e32-bad1-4384-99cd-2adf69ef3c29",
"CreateDate": "2026-03-30T16:48:22.8141788-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-30T16:48:22.8141788-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "4589dc8c-887a-4eca-a328-02f722295b2f",
"CreateDate": "2026-03-30T16:48:22.8141788-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-30T16:48:22.8141788-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c7e97caa-2c8a-49f7-887b-a6d55152b167",
"CreateDate": "2026-03-30T16:48:22.8141788-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-30T16:48:22.8141788-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "7aef5a96-974d-4173-802e-402e7f5bab7a",
"EffectiveDate": "2026-03-30T16:48:22.8141788-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "5bad8e2f-40ea-4020-b209-f00c71e3d249",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d043566a-e9d2-4858-9666-aca3058a30f4",
"CreateDate": "2026-03-30T16:48:22.8141788-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-30T16:48:22.8141788-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "bfa37722-35db-40bf-bbef-7966dc86659a",
"CreateDate": "2026-03-30T16:48:22.8141788-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-30T16:48:22.8141788-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-30T16:48:22.8141788-07:00",
"MeasurementValueNeededDate": "2026-03-30T16:48:22.8141788-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e2036ff3-6fa6-4e41-9d42-cf325628cf68",
"CreateDate": "2026-03-30T16:48:22.8141788-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-30T16:48:22.8141788-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "4b157fab-0be2-41f3-9296-b43996e23680",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "6e9859f3-2e68-4efb-b058-139965a817ad",
"CreateDate": "2026-03-30T16:48:22.8141788-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-30T16:48:22.8141788-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-30T16:48:22.8141788-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "fb5cabdf-2a63-4795-a3e3-b7cfd0ba61ca",
"CreateDate": "2026-03-30T16:48:22.8141788-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T16:48:22.8141788-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": "d2145ae5-5ea8-4bfa-9230-3eb925a4eb47",
"Asset": {
"AssetId": "491b671d-9bb0-47d6-aae6-8f1a3785a24e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "9c0ebca0-9acd-4092-9d1a-336c0189e6d6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2d5e81a9-eb3e-4527-94c1-5b200d1a7549",
"CreateDate": "2026-03-30T16:48:22.8297102-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-30T16:48:22.8297102-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "0747813b-0e65-4662-a398-306843f716bc",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-30T16:48:22.8297102-07:00",
"MeasurementValueNeededDate": "2026-03-30T16:48:22.8297102-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "75015e00-2380-457e-8336-0afdfd7f7503",
"CreateDate": "2026-03-30T16:48:22.8297102-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T16:48:22.8297102-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "1c7003b5-d107-4e03-b5f1-da15da82a597",
"EffectiveDate": "2026-03-30T16:48:22.8297102-07:00",
"StateType": {
"StateTypeId": "d7c48ca9-6f77-4ff7-a50d-50be1cbc582d",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "9c0ebca0-9acd-4092-9d1a-336c0189e6d6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2d5e81a9-eb3e-4527-94c1-5b200d1a7549",
"CreateDate": "2026-03-30T16:48:22.8297102-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-30T16:48:22.8297102-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "989c670b-1fd1-4d27-8319-7181e23a2b4c",
"CreateDate": "2026-03-30T16:48:22.8297102-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T16:48:22.8297102-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "70934b5d-d47e-49aa-86ba-bc7037e73da0",
"CreateDate": "2026-03-30T16:48:22.8297102-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-30T16:48:22.8297102-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "ee7dc25d-44bf-44b4-be3b-b2eedd89f657",
"EffectiveDate": "2026-03-30T16:48:22.8297102-07:00",
"StatusType": {
"StatusTypeId": "146f7332-8a5a-4167-8696-4bf0c41b19d6",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "9c0ebca0-9acd-4092-9d1a-336c0189e6d6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2d5e81a9-eb3e-4527-94c1-5b200d1a7549",
"CreateDate": "2026-03-30T16:48:22.8297102-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-30T16:48:22.8297102-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "3d6297f7-d4ac-4ff4-a1fb-5e98f0cb0a10",
"CreateDate": "2026-03-30T16:48:22.8297102-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-30T16:48:22.8297102-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6ae04c7e-5b1f-4811-8ee4-009315790d87",
"CreateDate": "2026-03-30T16:48:22.8297102-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-30T16:48:22.8297102-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "db7b64b9-9bd6-4ea3-a48f-8cd70ece5000",
"EffectiveDate": "2026-03-30T16:48:22.8297102-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "36516dfd-ef9e-49d3-af5f-81eeb5ee2b77",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "77399c84-081e-4f00-8aac-83a694773b06",
"CreateDate": "2026-03-30T16:48:22.8297102-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-30T16:48:22.8297102-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "bc80e17a-fcd1-421d-b814-0205c8f53e86",
"CreateDate": "2026-03-30T16:48:22.8297102-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-30T16:48:22.8297102-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-30T16:48:22.8297102-07:00",
"MeasurementValueNeededDate": "2026-03-30T16:48:22.8297102-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "7427a6f1-f66e-497f-aa5d-56d5d16ad630",
"CreateDate": "2026-03-30T16:48:22.8297102-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-30T16:48:22.8297102-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "1b8c9e19-affa-4cf6-894b-36b0506546c6",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "5be1e353-3b2f-4514-9ef3-8cf09507bc59",
"CreateDate": "2026-03-30T16:48:22.8297102-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-30T16:48:22.8297102-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-30T16:48:22.8297102-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b2249ba6-38f2-40a9-a95d-9901a5e526fb",
"CreateDate": "2026-03-30T16:48:22.8297102-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T16:48:22.8297102-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}