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": "db35dbe4-1fa1-40e9-8f8d-68cc738b0e37",
"Asset": {
"AssetId": "a4924dd3-973d-43cd-a90a-e2002e54a279",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "c263b70a-44a7-4e9f-b988-8c4fe8e91db3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "097a692b-3c93-42d4-94cf-77219b5833b3",
"CreateDate": "2026-02-08T13:14:53.1378687-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-08T13:14:53.1378687-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "8498e346-c7f9-479a-8ea4-431819529dce",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-08T13:14:53.1378687-08:00",
"MeasurementValueNeededDate": "2026-02-08T13:14:53.1378687-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "17c8ed38-e530-4d7a-85ec-b68da09a7ab4",
"CreateDate": "2026-02-08T13:14:53.1378687-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-08T13:14:53.1378687-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "44cf070a-46b2-46d6-b785-065195a29f90",
"EffectiveDate": "2026-02-08T13:14:53.1378687-08:00",
"StateType": {
"StateTypeId": "44562746-6591-4425-9c67-899f224f4670",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "c263b70a-44a7-4e9f-b988-8c4fe8e91db3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "097a692b-3c93-42d4-94cf-77219b5833b3",
"CreateDate": "2026-02-08T13:14:53.1378687-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-08T13:14:53.1378687-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "ad88c85e-752a-4e7e-a9c3-b28b02584a19",
"CreateDate": "2026-02-08T13:14:53.1378687-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-08T13:14:53.1378687-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d5751532-772a-4afc-aafd-23a8172261fc",
"CreateDate": "2026-02-08T13:14:53.1378687-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-08T13:14:53.1378687-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "364c3dcf-3736-48d7-ace0-bcbda4f6a0bd",
"EffectiveDate": "2026-02-08T13:14:53.1378687-08:00",
"StatusType": {
"StatusTypeId": "ca275150-8b6a-47d4-842e-b297ee4fdf59",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "c263b70a-44a7-4e9f-b988-8c4fe8e91db3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "097a692b-3c93-42d4-94cf-77219b5833b3",
"CreateDate": "2026-02-08T13:14:53.1378687-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-08T13:14:53.1378687-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "97e344f8-1255-4cff-b5f5-d26d37bdda20",
"CreateDate": "2026-02-08T13:14:53.1378687-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-08T13:14:53.1378687-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f8686cbb-e03f-45d9-ae8c-828a143476a9",
"CreateDate": "2026-02-08T13:14:53.1378687-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-08T13:14:53.1378687-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "f958f177-3902-4a4f-80f1-452288c9aa05",
"EffectiveDate": "2026-02-08T13:14:53.1378687-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "408fc3fd-2c4f-44c0-a39b-30303c85a16c",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ed0c26d3-9a4e-4238-9c40-0cfb45f61a93",
"CreateDate": "2026-02-08T13:14:53.1378687-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-08T13:14:53.1378687-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "7cbb6fe8-659f-409c-a68e-2bddafb8cb29",
"CreateDate": "2026-02-08T13:14:53.1378687-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-08T13:14:53.1378687-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-02-08T13:14:53.1378687-08:00",
"MeasurementValueNeededDate": "2026-02-08T13:14:53.1378687-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "02d891bd-085c-4dd2-af0e-5cebfde5a95a",
"CreateDate": "2026-02-08T13:14:53.1378687-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-08T13:14:53.1378687-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "0db44eea-d673-49c9-816e-a03f2777e7bf",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "64018921-6420-4dfb-bd8a-cfa0af49909a",
"CreateDate": "2026-02-08T13:14:53.1378687-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-08T13:14:53.1378687-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-02-08T13:14:53.1378687-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "402fdb97-b83a-4852-b8f0-ed3f2bcffac8",
"CreateDate": "2026-02-08T13:14:53.1378687-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-08T13:14:53.1378687-08: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": "7a73817f-fdc1-478d-8a8d-898bfe6241d0",
"Asset": {
"AssetId": "e293013c-a5ab-4f59-b6ab-9b91109170ff",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a07cf42c-cb2f-4cbf-9620-dc3eacd62abc",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0a58e753-2627-4f95-93c7-149f451b6d89",
"CreateDate": "2026-02-08T13:14:53.1378687-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-08T13:14:53.1378687-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "495d07fe-5b0d-474b-a6b7-9f7b42471889",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-08T13:14:53.1378687-08:00",
"MeasurementValueNeededDate": "2026-02-08T13:14:53.1378687-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "49d81721-2196-40d6-af32-fef69fee2cb4",
"CreateDate": "2026-02-08T13:14:53.1378687-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-08T13:14:53.1378687-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "04440504-17f1-48ff-9a82-fcf1c740c7ac",
"EffectiveDate": "2026-02-08T13:14:53.1378687-08:00",
"StateType": {
"StateTypeId": "903aceb0-5225-4517-a2bd-5310459abd8f",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "a07cf42c-cb2f-4cbf-9620-dc3eacd62abc",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0a58e753-2627-4f95-93c7-149f451b6d89",
"CreateDate": "2026-02-08T13:14:53.1378687-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-08T13:14:53.1378687-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "b784f662-e230-43d5-ab52-bad1a4ee4c28",
"CreateDate": "2026-02-08T13:14:53.1378687-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-08T13:14:53.1378687-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "235f3ec4-1bb9-4d31-8290-f868ae8f5274",
"CreateDate": "2026-02-08T13:14:53.1378687-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-08T13:14:53.1378687-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "eae2d41a-5c1f-43e0-80db-1c7ae363974c",
"EffectiveDate": "2026-02-08T13:14:53.1378687-08:00",
"StatusType": {
"StatusTypeId": "c9ca79dc-fbca-490f-8af1-f33310305f68",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "a07cf42c-cb2f-4cbf-9620-dc3eacd62abc",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0a58e753-2627-4f95-93c7-149f451b6d89",
"CreateDate": "2026-02-08T13:14:53.1378687-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-08T13:14:53.1378687-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "34110b48-8645-4d4f-a1ea-e637b1e0565a",
"CreateDate": "2026-02-08T13:14:53.1378687-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-08T13:14:53.1378687-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "382d0823-2344-408a-9d47-fb6ba9ce718f",
"CreateDate": "2026-02-08T13:14:53.1378687-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-08T13:14:53.1378687-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "593353cc-8cbd-409e-9959-e5449a991e6e",
"EffectiveDate": "2026-02-08T13:14:53.1378687-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "fb644fb7-eadd-4097-a512-65a08aed214a",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "dfa35ec1-ba75-4bd4-819c-63b779c96d02",
"CreateDate": "2026-02-08T13:14:53.1378687-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-08T13:14:53.1378687-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9f308d0f-eb80-4f94-ba68-016bd53bac7f",
"CreateDate": "2026-02-08T13:14:53.1378687-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-08T13:14:53.1378687-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-02-08T13:14:53.1378687-08:00",
"MeasurementValueNeededDate": "2026-02-08T13:14:53.1378687-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "c31d3628-19fb-449a-93d1-76077cb0be6c",
"CreateDate": "2026-02-08T13:14:53.1378687-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-08T13:14:53.1378687-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "8bc2599f-6c85-485d-89a4-6fb21dbb3cc8",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "ad8cbe5c-b4d3-43c0-8109-f3aed2765569",
"CreateDate": "2026-02-08T13:14:53.1378687-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-08T13:14:53.1378687-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-02-08T13:14:53.1378687-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5da63bb0-e6f2-4561-8a7f-3e7a76162d05",
"CreateDate": "2026-02-08T13:14:53.1378687-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-08T13:14:53.1378687-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}