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": "f4e00203-f5cb-4419-943e-b8a2e001658a",
"Asset": {
"AssetId": "773f157f-99db-41f3-bd21-305f92552c0d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "5a492b6c-4b6b-4036-8d2f-20f12a58701e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "29159799-7941-46ca-b704-ac62e7c42239",
"CreateDate": "2026-03-24T12:40:04.5882012-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-24T12:40:04.5882012-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "22ab6476-71fa-4ba1-a2aa-1d1c8fdd5296",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-24T12:40:04.5882012-07:00",
"MeasurementValueNeededDate": "2026-03-24T12:40:04.5882012-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "934bf60d-dc9f-480d-a2f6-c080ce053afc",
"CreateDate": "2026-03-24T12:40:04.5882012-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-24T12:40:04.5882012-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "6715f7e2-6634-418b-84ae-fda658c6ab5c",
"EffectiveDate": "2026-03-24T12:40:04.5882012-07:00",
"StateType": {
"StateTypeId": "8420042b-80b2-4edc-bc62-4656d9437f1f",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "5a492b6c-4b6b-4036-8d2f-20f12a58701e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "29159799-7941-46ca-b704-ac62e7c42239",
"CreateDate": "2026-03-24T12:40:04.5882012-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-24T12:40:04.5882012-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "64f65c7d-48db-4b31-8423-7ff6c35eb666",
"CreateDate": "2026-03-24T12:40:04.5882012-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-24T12:40:04.5882012-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b0046f44-5207-4dec-b9d6-0f72e939904a",
"CreateDate": "2026-03-24T12:40:04.5882012-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-24T12:40:04.5882012-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "80006992-f7a3-47e4-89c2-c385056d7836",
"EffectiveDate": "2026-03-24T12:40:04.5882012-07:00",
"StatusType": {
"StatusTypeId": "d868bbcc-87a0-42b4-9eee-66a7a801be3a",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "5a492b6c-4b6b-4036-8d2f-20f12a58701e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "29159799-7941-46ca-b704-ac62e7c42239",
"CreateDate": "2026-03-24T12:40:04.5882012-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-24T12:40:04.5882012-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "a77915ac-ee44-432f-9b5a-2ed8f3e87469",
"CreateDate": "2026-03-24T12:40:04.5882012-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-24T12:40:04.5882012-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5ea9aea7-7aa7-4c8e-ad8b-bb7ee82d41b9",
"CreateDate": "2026-03-24T12:40:04.5882012-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-24T12:40:04.5882012-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "142628b1-ee63-43a1-82bd-bce85ad600b2",
"EffectiveDate": "2026-03-24T12:40:04.5882012-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "068f9a14-a837-473c-8cdc-17a725a78d33",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c17810a1-472d-4994-b09e-36ffc1b2746a",
"CreateDate": "2026-03-24T12:40:04.5882012-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-24T12:40:04.5882012-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "869f11e8-477f-444b-bde1-a35e0dcc1903",
"CreateDate": "2026-03-24T12:40:04.5882012-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-24T12:40:04.5882012-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-24T12:40:04.5882012-07:00",
"MeasurementValueNeededDate": "2026-03-24T12:40:04.5882012-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "5ab3985b-99f3-4f34-ac4d-367bd28246e3",
"CreateDate": "2026-03-24T12:40:04.5882012-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-24T12:40:04.5882012-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "2abff7dc-786d-4353-9c37-ae3bb947cbec",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "625e2063-5303-4355-bf90-13426505d9e6",
"CreateDate": "2026-03-24T12:40:04.5882012-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-24T12:40:04.5882012-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-24T12:40:04.5882012-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "e011d996-cd9a-47e1-a251-980185dc6cc0",
"CreateDate": "2026-03-24T12:40:04.5882012-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-24T12:40:04.5882012-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": "4fccd722-e1c8-421d-8bcc-d03b4527a978",
"Asset": {
"AssetId": "f70dad09-1a42-4462-9faf-7fa53bddbdd7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "9c77cb8f-eb56-4df1-92bd-4e33577dadd6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "001db268-492d-49d9-939a-950e1662f821",
"CreateDate": "2026-03-24T12:40:04.6038308-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-24T12:40:04.6038308-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "f855d325-ba2a-49d7-91f7-4dc65fe0686c",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-24T12:40:04.6038308-07:00",
"MeasurementValueNeededDate": "2026-03-24T12:40:04.6038308-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "cfa51a89-3c03-452a-96a6-832932e19cb4",
"CreateDate": "2026-03-24T12:40:04.6038308-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-24T12:40:04.6038308-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "1f4a1140-eb61-463b-8d84-623ce1577f5b",
"EffectiveDate": "2026-03-24T12:40:04.6038308-07:00",
"StateType": {
"StateTypeId": "91b1d39b-c718-45df-b579-72350611e972",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "9c77cb8f-eb56-4df1-92bd-4e33577dadd6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "001db268-492d-49d9-939a-950e1662f821",
"CreateDate": "2026-03-24T12:40:04.6038308-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-24T12:40:04.6038308-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "d59025d0-4d85-4ee9-84f4-6932bbfd0069",
"CreateDate": "2026-03-24T12:40:04.6038308-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-24T12:40:04.6038308-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a184828c-3f27-49dc-b4dc-ac4ff542e1d4",
"CreateDate": "2026-03-24T12:40:04.6038308-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-24T12:40:04.6038308-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "e625014a-1d51-4a27-b9ee-ee7890b78eaa",
"EffectiveDate": "2026-03-24T12:40:04.6038308-07:00",
"StatusType": {
"StatusTypeId": "07e5ca62-5604-4b17-9588-d06af8c8ac41",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "9c77cb8f-eb56-4df1-92bd-4e33577dadd6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "001db268-492d-49d9-939a-950e1662f821",
"CreateDate": "2026-03-24T12:40:04.6038308-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-24T12:40:04.6038308-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "7702447e-8812-409b-b88c-6902711ced80",
"CreateDate": "2026-03-24T12:40:04.6038308-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-24T12:40:04.6038308-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e7e7eda2-97a5-4f74-a03c-89cec89d1273",
"CreateDate": "2026-03-24T12:40:04.6038308-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-24T12:40:04.6038308-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "4be57030-e579-439b-8f53-62ea3d412760",
"EffectiveDate": "2026-03-24T12:40:04.6038308-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "f11fd9e9-bab9-4812-ae12-e08ef7085f7b",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2090ce9b-be52-4a4d-8caa-ff4130ede102",
"CreateDate": "2026-03-24T12:40:04.6038308-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-24T12:40:04.6038308-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "477eaea9-1fe5-4ac7-a17a-58c645dc535b",
"CreateDate": "2026-03-24T12:40:04.6038308-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-24T12:40:04.6038308-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-24T12:40:04.6038308-07:00",
"MeasurementValueNeededDate": "2026-03-24T12:40:04.6038308-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "5bc82f91-6c3e-439b-9f79-cb84dc48aaf5",
"CreateDate": "2026-03-24T12:40:04.6038308-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-24T12:40:04.6038308-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "9e911682-5b54-4f5d-992a-d9a5caac0177",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "97e159d1-3b19-4fe8-b1fc-d325af37c8de",
"CreateDate": "2026-03-24T12:40:04.6038308-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-24T12:40:04.6038308-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-24T12:40:04.6038308-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c6ca69c4-859b-41c6-83a2-d73fad43c031",
"CreateDate": "2026-03-24T12:40:04.6038308-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-24T12:40:04.6038308-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}