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": "bb12240a-8230-457f-bad2-1ccec88ea63a",
"Asset": {
"AssetId": "f6148e64-b18a-4127-a6d3-0b6d88f05bb0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "461357b5-ea10-4536-a0df-7077ae68ad71",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "73c41fb9-1263-4427-9fea-6cd441ed2203",
"CreateDate": "2026-04-28T02:28:41.1839728-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-28T02:28:41.1839728-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "31c84d24-ff0e-477e-8bd8-96d7c6f45678",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-28T02:28:41.1839728-07:00",
"MeasurementValueNeededDate": "2026-04-28T02:28:41.1839728-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "6db56828-ef21-4840-be4e-5a0cc4fff594",
"CreateDate": "2026-04-28T02:28:41.1839728-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-28T02:28:41.1839728-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "fe4b9feb-4c55-4f07-8c4a-32af20bcb820",
"EffectiveDate": "2026-04-28T02:28:41.1839728-07:00",
"StateType": {
"StateTypeId": "e3498214-2934-4138-ab73-710d5d29f451",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "461357b5-ea10-4536-a0df-7077ae68ad71",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "73c41fb9-1263-4427-9fea-6cd441ed2203",
"CreateDate": "2026-04-28T02:28:41.1839728-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-28T02:28:41.1839728-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "4a474c3b-ec97-47af-a22e-955ea95df6fe",
"CreateDate": "2026-04-28T02:28:41.1839728-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-28T02:28:41.1839728-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "cf66e3ff-62d7-4f6d-b48b-94941e1cdb25",
"CreateDate": "2026-04-28T02:28:41.1839728-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-28T02:28:41.1839728-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "7365b5be-aa4b-47be-bfd0-ee72e941bb51",
"EffectiveDate": "2026-04-28T02:28:41.1839728-07:00",
"StatusType": {
"StatusTypeId": "39e9babc-2e92-42a2-9956-b787c2216362",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "461357b5-ea10-4536-a0df-7077ae68ad71",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "73c41fb9-1263-4427-9fea-6cd441ed2203",
"CreateDate": "2026-04-28T02:28:41.1839728-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-28T02:28:41.1839728-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "37c4e632-0f5c-4e7c-81c9-74d38f31a0bf",
"CreateDate": "2026-04-28T02:28:41.1839728-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-28T02:28:41.1839728-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "934d3181-34c5-46e9-b095-e754c874b4f1",
"CreateDate": "2026-04-28T02:28:41.1839728-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-28T02:28:41.1839728-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "3e5ace9f-1d17-4190-acef-af941cd1ecef",
"EffectiveDate": "2026-04-28T02:28:41.1839728-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "7907582c-8fa6-448e-b46c-97b6c18d2a7a",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "694d5d0d-8d5d-4e3c-8b27-ab3a3869e864",
"CreateDate": "2026-04-28T02:28:41.1839728-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-28T02:28:41.1839728-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b41b40ab-555b-4909-9fe1-7e416822e0c0",
"CreateDate": "2026-04-28T02:28:41.1839728-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-28T02:28:41.1839728-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-04-28T02:28:41.1839728-07:00",
"MeasurementValueNeededDate": "2026-04-28T02:28:41.1839728-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "5b56096e-7bea-4215-987d-a601f1050ea5",
"CreateDate": "2026-04-28T02:28:41.1839728-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-28T02:28:41.1839728-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "199df5a2-7400-4244-b158-aec10799b7e1",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "b507a7a4-a9c4-4b16-a646-c911c08d0f1e",
"CreateDate": "2026-04-28T02:28:41.1839728-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-28T02:28:41.1839728-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-04-28T02:28:41.1839728-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "3669197c-6777-4e0f-abf4-4fc08544982d",
"CreateDate": "2026-04-28T02:28:41.1839728-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-28T02:28:41.1839728-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": "94a57fab-157f-45f0-b8de-872bdb4bdef8",
"Asset": {
"AssetId": "930e2479-d95d-4075-b32c-bc7af11d3503",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "f4f83ea9-77d9-461f-ab47-5c6f5aec07f6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "05df83b2-eb24-4dcf-8b02-fba945b1af74",
"CreateDate": "2026-04-28T02:28:41.1839728-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-28T02:28:41.1839728-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "434594f8-eccf-4992-a246-db4e270d029b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-28T02:28:41.1839728-07:00",
"MeasurementValueNeededDate": "2026-04-28T02:28:41.1839728-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "cf8187fc-ab3e-42c6-a511-3245d8df5e72",
"CreateDate": "2026-04-28T02:28:41.1839728-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-28T02:28:41.1839728-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "113ada98-822e-4bfc-acd3-d46b5089878f",
"EffectiveDate": "2026-04-28T02:28:41.1839728-07:00",
"StateType": {
"StateTypeId": "a55ace9f-e50f-4c0e-b28c-7d54a48ecfee",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "f4f83ea9-77d9-461f-ab47-5c6f5aec07f6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "05df83b2-eb24-4dcf-8b02-fba945b1af74",
"CreateDate": "2026-04-28T02:28:41.1839728-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-28T02:28:41.1839728-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "790eaecc-4def-47e0-9957-9646eea4b3c7",
"CreateDate": "2026-04-28T02:28:41.1839728-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-28T02:28:41.1839728-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a11861a3-8e1d-4557-bdab-e7ce70e1d438",
"CreateDate": "2026-04-28T02:28:41.1839728-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-28T02:28:41.1839728-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "83b96aab-fbde-4a30-a307-b94159cfcd19",
"EffectiveDate": "2026-04-28T02:28:41.1839728-07:00",
"StatusType": {
"StatusTypeId": "44a627cf-3666-40d4-be6f-0926a0364d11",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "f4f83ea9-77d9-461f-ab47-5c6f5aec07f6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "05df83b2-eb24-4dcf-8b02-fba945b1af74",
"CreateDate": "2026-04-28T02:28:41.1839728-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-28T02:28:41.1839728-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "fe97588f-4981-434f-a050-244e368c87ea",
"CreateDate": "2026-04-28T02:28:41.1839728-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-28T02:28:41.1839728-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "43996fd9-4312-4ca2-b9d0-c938d400dc77",
"CreateDate": "2026-04-28T02:28:41.1839728-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-28T02:28:41.1839728-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "3992599c-5edc-474f-82a2-b27870008dd8",
"EffectiveDate": "2026-04-28T02:28:41.1839728-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "f1ce10fc-c251-477e-b4a3-274fb384d845",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2494b7e7-0d36-4524-b96b-10cc9489e869",
"CreateDate": "2026-04-28T02:28:41.1839728-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-28T02:28:41.1839728-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "72545b75-0003-4a55-8bd7-15681bacb9f9",
"CreateDate": "2026-04-28T02:28:41.1839728-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-28T02:28:41.1839728-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-04-28T02:28:41.1839728-07:00",
"MeasurementValueNeededDate": "2026-04-28T02:28:41.1839728-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "2ba62452-1140-4736-af59-b54b9b4ccaa1",
"CreateDate": "2026-04-28T02:28:41.1839728-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-28T02:28:41.1839728-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "ea001850-79c2-40b7-847e-92ce127363bf",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "4cfcad85-49db-4ebe-92e9-b9f21103683a",
"CreateDate": "2026-04-28T02:28:41.1839728-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-28T02:28:41.1839728-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-04-28T02:28:41.1839728-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "095c7959-7125-45b6-8943-46a40414f96c",
"CreateDate": "2026-04-28T02:28:41.1839728-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-28T02:28:41.1839728-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}