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": "16706756-1e18-4e06-889c-9f2ea7ae322e",
"Asset": {
"AssetId": "63201018-cda4-4fe6-92eb-783667a2a078",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "b0417094-37ae-4707-8f63-91fbb20279b2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "84696d6c-1f2e-46c5-b049-688b293b38d7",
"CreateDate": "2026-05-13T09:51:11.5096524-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-13T09:51:11.5096524-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "54d56c37-3549-4138-a167-46d361ea4aca",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-13T09:51:11.5096524-07:00",
"MeasurementValueNeededDate": "2026-05-13T09:51:11.5096524-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f22d70cf-34ea-43e4-b65a-8b82ccb911af",
"CreateDate": "2026-05-13T09:51:11.5096524-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-13T09:51:11.5096524-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "f65e7c18-267e-4a47-a3e6-ebfe4ed97572",
"EffectiveDate": "2026-05-13T09:51:11.5096524-07:00",
"StateType": {
"StateTypeId": "1264dd61-2544-4ff8-8096-96a0c676888f",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "b0417094-37ae-4707-8f63-91fbb20279b2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "84696d6c-1f2e-46c5-b049-688b293b38d7",
"CreateDate": "2026-05-13T09:51:11.5096524-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-13T09:51:11.5096524-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "6b3ef86e-a617-43fa-9490-04e393a637f1",
"CreateDate": "2026-05-13T09:51:11.5096524-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-13T09:51:11.5096524-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d6094633-5de4-4272-9ee2-d46c8fa2fe1e",
"CreateDate": "2026-05-13T09:51:11.5096524-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-13T09:51:11.5096524-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "56f85e74-abab-41c4-911d-da11798c1fa9",
"EffectiveDate": "2026-05-13T09:51:11.5096524-07:00",
"StatusType": {
"StatusTypeId": "c6ec0de8-a027-4c45-832a-a9f2b5a3ec84",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "b0417094-37ae-4707-8f63-91fbb20279b2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "84696d6c-1f2e-46c5-b049-688b293b38d7",
"CreateDate": "2026-05-13T09:51:11.5096524-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-13T09:51:11.5096524-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "902d8230-b0d7-4e2e-88f3-bac6b443f680",
"CreateDate": "2026-05-13T09:51:11.5096524-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-13T09:51:11.5096524-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6738c3a5-9dcd-4659-999a-1efae0b1ddec",
"CreateDate": "2026-05-13T09:51:11.5096524-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-13T09:51:11.5096524-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "c1b09656-e920-4241-91d3-24bb2be50bd2",
"EffectiveDate": "2026-05-13T09:51:11.5096524-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "da765cf7-8783-4257-b97c-4e0f567d6a5a",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4d6c4cd3-4b15-4ed8-83b2-e57e1c841dc3",
"CreateDate": "2026-05-13T09:51:11.5096524-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-13T09:51:11.5096524-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "76a2e2f0-5334-43b0-bbe9-53c42e227538",
"CreateDate": "2026-05-13T09:51:11.5096524-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-13T09:51:11.5096524-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-05-13T09:51:11.5096524-07:00",
"MeasurementValueNeededDate": "2026-05-13T09:51:11.5096524-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f57a4a3b-428a-438f-a9c3-b5d152d60d5d",
"CreateDate": "2026-05-13T09:51:11.5096524-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-13T09:51:11.5096524-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "9c7ab7a1-bbce-45d7-8c45-284870667be8",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "9ba78bd8-9a48-48a7-8ec7-ebd2ebac3b16",
"CreateDate": "2026-05-13T09:51:11.5096524-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-13T09:51:11.5096524-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-05-13T09:51:11.5096524-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ff399948-e0de-4651-9e7b-77d49789e455",
"CreateDate": "2026-05-13T09:51:11.5096524-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-13T09:51:11.5096524-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": "1406a737-6704-4c40-ae5c-fd31d31b2e70",
"Asset": {
"AssetId": "3508911c-1919-4987-8f4d-133c3891a23b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "6816506f-b7fa-4247-958a-b869f787207e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "da182ea9-52f5-4b4c-b4e4-1caa5857414b",
"CreateDate": "2026-05-13T09:51:11.5252673-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-13T09:51:11.5252673-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "9a9a164b-69dd-454a-b80f-6cf486075b30",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-13T09:51:11.5252673-07:00",
"MeasurementValueNeededDate": "2026-05-13T09:51:11.5252673-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3d183752-001f-41d9-b8b6-802a77e1b5bd",
"CreateDate": "2026-05-13T09:51:11.5252673-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-13T09:51:11.5252673-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "3365519d-dd59-4731-b8ec-5428ab1aa17f",
"EffectiveDate": "2026-05-13T09:51:11.5252673-07:00",
"StateType": {
"StateTypeId": "bff93210-f83f-442e-8f17-434149abc80c",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "6816506f-b7fa-4247-958a-b869f787207e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "da182ea9-52f5-4b4c-b4e4-1caa5857414b",
"CreateDate": "2026-05-13T09:51:11.5252673-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-13T09:51:11.5252673-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "058f4810-fe25-4a1e-b2b1-87a5ca4a8ee9",
"CreateDate": "2026-05-13T09:51:11.5252673-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-13T09:51:11.5252673-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5744d21e-252b-4f32-a974-527f798df032",
"CreateDate": "2026-05-13T09:51:11.5252673-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-13T09:51:11.5252673-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "fb676198-1a12-4856-9ed2-966f27dc0935",
"EffectiveDate": "2026-05-13T09:51:11.5252673-07:00",
"StatusType": {
"StatusTypeId": "d4bc1c1f-6599-40c0-8a14-9cb5ce903389",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "6816506f-b7fa-4247-958a-b869f787207e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "da182ea9-52f5-4b4c-b4e4-1caa5857414b",
"CreateDate": "2026-05-13T09:51:11.5252673-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-13T09:51:11.5252673-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "c7f6836c-462a-4462-ac15-9e147849d6b4",
"CreateDate": "2026-05-13T09:51:11.5252673-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-13T09:51:11.5252673-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0be4d013-f9cf-4d04-b7cf-fb1ecd599530",
"CreateDate": "2026-05-13T09:51:11.5252673-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-13T09:51:11.5252673-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "e89bbc2c-b7e8-4ec4-b635-5ada14c1bf8d",
"EffectiveDate": "2026-05-13T09:51:11.5252673-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "74f7dbe4-1df4-4822-87f0-6761ddb286c5",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f49b6c8c-dd39-4e40-aed9-11c4cf6a7425",
"CreateDate": "2026-05-13T09:51:11.5252673-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-13T09:51:11.5252673-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d9dd8562-a14b-4e53-a469-6c828b71296d",
"CreateDate": "2026-05-13T09:51:11.5252673-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-13T09:51:11.5252673-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-05-13T09:51:11.5252673-07:00",
"MeasurementValueNeededDate": "2026-05-13T09:51:11.5252673-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e044750c-e642-43ea-a7f4-84e486f8f482",
"CreateDate": "2026-05-13T09:51:11.5252673-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-13T09:51:11.5252673-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "cde5532d-2a66-430c-b7fe-392b1a5f0407",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "dddeccda-0302-49e8-93a0-74e8cd227f1f",
"CreateDate": "2026-05-13T09:51:11.5252673-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-13T09:51:11.5252673-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-05-13T09:51:11.5252673-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "baa2384b-a513-4933-b9b8-4fa794fb37dc",
"CreateDate": "2026-05-13T09:51:11.5252673-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-13T09:51:11.5252673-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}