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": "711c4cfe-3e04-4163-ad87-565d4da0a43d",
"Asset": {
"AssetId": "895068b8-ab39-4d21-822f-bfc3e576ead5",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "0e72666f-86f8-415e-bfed-fbedffdbc1c5",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4a5aaeb9-efbf-4125-9431-d865eb992af3",
"CreateDate": "2025-10-27T21:55:27.2413998-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-27T21:55:27.2413998-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "7b6a5698-4786-404c-9048-e06925dd22f3",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-27T21:55:27.2413998-07:00",
"MeasurementValueNeededDate": "2025-10-27T21:55:27.2413998-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7c671f6f-a605-4d13-b5a1-e40786873b41",
"CreateDate": "2025-10-27T21:55:27.2413998-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-27T21:55:27.2413998-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "94c7d355-6e35-4ca9-8701-52008defea41",
"EffectiveDate": "2025-10-27T21:55:27.2413998-07:00",
"StateType": {
"StateTypeId": "489df7ad-7a7a-4a0d-93ab-86e21b9e75c4",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "0e72666f-86f8-415e-bfed-fbedffdbc1c5",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4a5aaeb9-efbf-4125-9431-d865eb992af3",
"CreateDate": "2025-10-27T21:55:27.2413998-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-27T21:55:27.2413998-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "89d44d15-6b85-4d91-9ad6-707dcb5330d2",
"CreateDate": "2025-10-27T21:55:27.2413998-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-27T21:55:27.2413998-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0bf2975a-95e8-43b4-a814-1329ad930d24",
"CreateDate": "2025-10-27T21:55:27.2413998-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-27T21:55:27.2413998-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "a095e3d2-a508-4aea-ace3-984ac0020e48",
"EffectiveDate": "2025-10-27T21:55:27.2413998-07:00",
"StatusType": {
"StatusTypeId": "65222f5d-391d-40df-9747-4bd32f1552cc",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "0e72666f-86f8-415e-bfed-fbedffdbc1c5",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4a5aaeb9-efbf-4125-9431-d865eb992af3",
"CreateDate": "2025-10-27T21:55:27.2413998-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-27T21:55:27.2413998-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "cebfc655-a858-4d36-ac82-c9df29fe9fe0",
"CreateDate": "2025-10-27T21:55:27.2413998-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-27T21:55:27.2413998-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0faf879b-aedf-4e63-9e1f-40916762e56f",
"CreateDate": "2025-10-27T21:55:27.2413998-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-27T21:55:27.2413998-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "c0d9a877-8351-4c92-8f28-74d47314d2e3",
"EffectiveDate": "2025-10-27T21:55:27.2413998-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "624abbff-d489-4005-bda6-d994120567fd",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d7d50b3a-d68b-47e2-8c29-bb140f2c77ca",
"CreateDate": "2025-10-27T21:55:27.2413998-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-27T21:55:27.2413998-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "623eacff-3e34-439a-9013-eb63c8b90c87",
"CreateDate": "2025-10-27T21:55:27.2413998-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-27T21:55:27.2413998-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-10-27T21:55:27.2413998-07:00",
"MeasurementValueNeededDate": "2025-10-27T21:55:27.2413998-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9577e87c-0a7a-4db1-8181-a03977fb8912",
"CreateDate": "2025-10-27T21:55:27.2413998-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-27T21:55:27.2413998-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "c6d89cca-1549-485d-bb77-c332a7fe1943",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "3757c7d1-7db1-4687-a4b1-c14385a296cc",
"CreateDate": "2025-10-27T21:55:27.2413998-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-27T21:55:27.2413998-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-10-27T21:55:27.2413998-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "bacd55c8-ae7a-4431-ae78-cb89ec9823d7",
"CreateDate": "2025-10-27T21:55:27.2413998-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-27T21:55:27.2413998-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": "df129838-025e-4635-b3da-f4a98aef2131",
"Asset": {
"AssetId": "34a12f8a-69c7-46c7-bdec-654a41810718",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "c4e5e957-efa8-4211-a367-85a4af29985a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c631cf8a-9532-4e4f-9579-9a67c6bdd587",
"CreateDate": "2025-10-27T21:55:27.2413998-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-27T21:55:27.2413998-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "5adb3eab-8ac0-456e-a5d1-c4c5d17e810a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-27T21:55:27.2413998-07:00",
"MeasurementValueNeededDate": "2025-10-27T21:55:27.2413998-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8bd27a56-52cf-4f99-82d5-1002b310a3f4",
"CreateDate": "2025-10-27T21:55:27.2413998-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-27T21:55:27.2413998-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "23a8899f-f9ef-42eb-a2fe-ac59d7c21e24",
"EffectiveDate": "2025-10-27T21:55:27.2413998-07:00",
"StateType": {
"StateTypeId": "2353363d-3e3f-4d4c-98ef-cb69c5da06ed",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "c4e5e957-efa8-4211-a367-85a4af29985a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c631cf8a-9532-4e4f-9579-9a67c6bdd587",
"CreateDate": "2025-10-27T21:55:27.2413998-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-27T21:55:27.2413998-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "876192b0-3aec-4aea-a440-1409810a957b",
"CreateDate": "2025-10-27T21:55:27.2413998-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-27T21:55:27.2413998-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "31cc3f0a-8ad7-4466-aff3-a64e38c037f2",
"CreateDate": "2025-10-27T21:55:27.2413998-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-27T21:55:27.2413998-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "a349d7c7-d4da-4457-8a72-ffcb867cd990",
"EffectiveDate": "2025-10-27T21:55:27.2413998-07:00",
"StatusType": {
"StatusTypeId": "c4dd72ac-a187-4ad0-a5df-a75f13f2f398",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "c4e5e957-efa8-4211-a367-85a4af29985a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c631cf8a-9532-4e4f-9579-9a67c6bdd587",
"CreateDate": "2025-10-27T21:55:27.2413998-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-27T21:55:27.2413998-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "9d708d92-a551-448b-a913-e0cd2046ad63",
"CreateDate": "2025-10-27T21:55:27.2413998-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-27T21:55:27.2413998-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a4e9bfd6-ae5a-42cd-9aa8-a569f669a0bb",
"CreateDate": "2025-10-27T21:55:27.2413998-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-27T21:55:27.2413998-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "8b4b64ba-2807-4fa3-845e-b9cac84ff3b5",
"EffectiveDate": "2025-10-27T21:55:27.2413998-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "d31e46a2-9e35-4b5c-9191-395574e12682",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e7d717ce-2761-411f-88a4-394d62a927ee",
"CreateDate": "2025-10-27T21:55:27.2413998-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-27T21:55:27.2413998-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "023dcd5d-a860-4cdc-945f-df702ae53e22",
"CreateDate": "2025-10-27T21:55:27.2413998-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-27T21:55:27.2413998-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-10-27T21:55:27.2413998-07:00",
"MeasurementValueNeededDate": "2025-10-27T21:55:27.2413998-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "af274641-da5b-4533-a307-a0910e2831b3",
"CreateDate": "2025-10-27T21:55:27.2413998-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-27T21:55:27.2413998-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "22f76174-f1fb-46db-b0c5-c32691ef6dbf",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c599769b-a054-4c8f-8d8e-bdc7e786b865",
"CreateDate": "2025-10-27T21:55:27.2413998-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-27T21:55:27.2413998-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-10-27T21:55:27.2413998-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ad4a15dc-eea9-4895-98f2-501a97c962ca",
"CreateDate": "2025-10-27T21:55:27.2413998-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-27T21:55:27.2413998-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}