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": "c1cc1bcd-6687-48d9-80ea-360dae3fdedb",
"Asset": {
"AssetId": "0a7e7455-e510-49c7-b480-d5b859d11cb4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "39ada89b-00a7-4a90-a582-4aa81ee18e92",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8cb29cbe-55cf-42ad-b65c-b2f5392a3d6b",
"CreateDate": "2025-10-13T15:17:41.6828012-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T15:17:41.6828012-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "3d180e77-8f01-4e0d-b8fd-99208a59f842",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-13T15:17:41.6828012-07:00",
"MeasurementValueNeededDate": "2025-10-13T15:17:41.6828012-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "eb3def04-7b77-4188-ac87-cf549c479851",
"CreateDate": "2025-10-13T15:17:41.6828012-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T15:17:41.6828012-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "958f026c-d92a-4869-8a15-2df7b6b8b595",
"EffectiveDate": "2025-10-13T15:17:41.6828012-07:00",
"StateType": {
"StateTypeId": "2b57c781-1dfd-430d-bbc1-0bcb8227701f",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "39ada89b-00a7-4a90-a582-4aa81ee18e92",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8cb29cbe-55cf-42ad-b65c-b2f5392a3d6b",
"CreateDate": "2025-10-13T15:17:41.6828012-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T15:17:41.6828012-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "2014ac1b-9b60-4851-908c-cad30e6eecce",
"CreateDate": "2025-10-13T15:17:41.6828012-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T15:17:41.6828012-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "7b9899b3-8783-4122-a30b-937b336f54f7",
"CreateDate": "2025-10-13T15:17:41.6828012-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-13T15:17:41.6828012-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "06846c28-a093-4d46-9b73-f15656e80d75",
"EffectiveDate": "2025-10-13T15:17:41.6828012-07:00",
"StatusType": {
"StatusTypeId": "a04a78d1-3311-43cd-8453-ffa9b5dabe8a",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "39ada89b-00a7-4a90-a582-4aa81ee18e92",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8cb29cbe-55cf-42ad-b65c-b2f5392a3d6b",
"CreateDate": "2025-10-13T15:17:41.6828012-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T15:17:41.6828012-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "520426f7-937f-4714-a75f-37c978c02f85",
"CreateDate": "2025-10-13T15:17:41.6828012-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-13T15:17:41.6828012-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5db65bbf-9ff9-4440-bac8-271e9e0934af",
"CreateDate": "2025-10-13T15:17:41.6828012-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-13T15:17:41.6828012-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "3c1972ca-d3d4-4837-bf78-f8296763090c",
"EffectiveDate": "2025-10-13T15:17:41.6828012-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "9c7db26a-b082-4e58-a507-7771711c5649",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "cd831580-e52b-42f9-a20c-871774dfce31",
"CreateDate": "2025-10-13T15:17:41.6984243-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-13T15:17:41.6984243-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "513cfbe3-4d56-429a-8455-eccae1dffa25",
"CreateDate": "2025-10-13T15:17:41.6984243-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-13T15:17:41.6984243-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-10-13T15:17:41.6984243-07:00",
"MeasurementValueNeededDate": "2025-10-13T15:17:41.6984243-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9ca01bd3-dcb6-4afc-8175-7133c79d6182",
"CreateDate": "2025-10-13T15:17:41.6984243-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T15:17:41.6984243-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "357ff86e-3007-494b-be61-7246508bcd86",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f8ed3238-6f85-401f-b9bb-b349d0f38908",
"CreateDate": "2025-10-13T15:17:41.6984243-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-13T15:17:41.6984243-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-10-13T15:17:41.6984243-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "94137ab9-a48f-499f-8f1b-add3924203a2",
"CreateDate": "2025-10-13T15:17:41.6984243-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T15:17:41.6984243-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": "85e0d4e7-300a-4a0b-981c-d7fffbbe53ff",
"Asset": {
"AssetId": "8a1fcdad-519e-4559-9783-cc32a2b943d8",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "951f8747-7ab4-4688-b373-a606a38a964b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "cdb37f1c-b3cd-471a-85e9-de5ee24b66d7",
"CreateDate": "2025-10-13T15:17:41.6984243-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T15:17:41.6984243-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "639237c6-f9aa-414b-af15-32a89f058e63",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-13T15:17:41.6984243-07:00",
"MeasurementValueNeededDate": "2025-10-13T15:17:41.6984243-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8846a7c1-6ef4-4c23-803f-0e666d58afdf",
"CreateDate": "2025-10-13T15:17:41.6984243-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T15:17:41.6984243-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "437eb7d1-dbe9-4cff-856b-800413e16729",
"EffectiveDate": "2025-10-13T15:17:41.6984243-07:00",
"StateType": {
"StateTypeId": "24d3c3ed-bd3c-4c16-acc9-b9f0bbdcb292",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "951f8747-7ab4-4688-b373-a606a38a964b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "cdb37f1c-b3cd-471a-85e9-de5ee24b66d7",
"CreateDate": "2025-10-13T15:17:41.6984243-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T15:17:41.6984243-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "4b06eba8-45bd-4563-ad2c-1890d1fd3cc2",
"CreateDate": "2025-10-13T15:17:41.6984243-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T15:17:41.6984243-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a3829ab0-fd35-44e7-931b-4742ba44af69",
"CreateDate": "2025-10-13T15:17:41.6984243-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-13T15:17:41.6984243-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "5431caf0-dfa1-49bf-a4c0-deded68658c0",
"EffectiveDate": "2025-10-13T15:17:41.6984243-07:00",
"StatusType": {
"StatusTypeId": "82eff978-a9ca-495a-9d21-392d1cc6d0ab",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "951f8747-7ab4-4688-b373-a606a38a964b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "cdb37f1c-b3cd-471a-85e9-de5ee24b66d7",
"CreateDate": "2025-10-13T15:17:41.6984243-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T15:17:41.6984243-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "7f5dd165-392f-4ff3-a1a2-5173da476037",
"CreateDate": "2025-10-13T15:17:41.6984243-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-13T15:17:41.6984243-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f5eb3933-4356-4ef3-9a3b-7be8e8c23c36",
"CreateDate": "2025-10-13T15:17:41.6984243-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-13T15:17:41.6984243-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "30644c31-8967-484c-afaf-a9219fc0253a",
"EffectiveDate": "2025-10-13T15:17:41.6984243-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "e8011591-023d-4b29-bcd6-72554f48ab40",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b0bea9da-0494-4487-b469-adb967faba4e",
"CreateDate": "2025-10-13T15:17:41.6984243-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-13T15:17:41.6984243-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "46398b64-a4dd-4a78-b079-6d2f99ee5238",
"CreateDate": "2025-10-13T15:17:41.6984243-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-13T15:17:41.6984243-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-10-13T15:17:41.6984243-07:00",
"MeasurementValueNeededDate": "2025-10-13T15:17:41.6984243-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6c838194-875a-4f0c-b509-3aa6a432b1ad",
"CreateDate": "2025-10-13T15:17:41.6984243-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T15:17:41.6984243-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "666b22ab-7cd5-49b1-b296-d97cd7a7cfb4",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "8fff9229-0f2e-4c5b-83fb-9239449ae932",
"CreateDate": "2025-10-13T15:17:41.6984243-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-13T15:17:41.6984243-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-10-13T15:17:41.6984243-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1fd3726a-37ab-48e1-9fe3-5d273f698685",
"CreateDate": "2025-10-13T15:17:41.6984243-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T15:17:41.6984243-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}