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": "eeef3c21-b6c0-4bf4-ba3e-66a9e94aafa5",
"Asset": {
"AssetId": "21973bb3-e599-4d9f-baa1-0d72ca952844",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a8cab56b-e4aa-40e4-b011-d31133b80b66",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "3e9d6698-65c8-4db0-b539-5af888fb8b7a",
"CreateDate": "2026-04-24T01:38:14.2887861-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-24T01:38:14.2887861-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "de319e8e-bdcc-45ed-9bce-3d6233d26daf",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-24T01:38:14.2887861-07:00",
"MeasurementValueNeededDate": "2026-04-24T01:38:14.2887861-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "6ba44bc7-8afb-4ea4-8389-471db954bcaf",
"CreateDate": "2026-04-24T01:38:14.2887861-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-24T01:38:14.2887861-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "2865d03a-00d3-4494-a173-d4287e8b6617",
"EffectiveDate": "2026-04-24T01:38:14.2887861-07:00",
"StateType": {
"StateTypeId": "544936f6-8e42-46a8-a042-7b940c8654a5",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "a8cab56b-e4aa-40e4-b011-d31133b80b66",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "3e9d6698-65c8-4db0-b539-5af888fb8b7a",
"CreateDate": "2026-04-24T01:38:14.2887861-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-24T01:38:14.2887861-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "d4f67026-b8b4-4067-b568-8463c7483cc7",
"CreateDate": "2026-04-24T01:38:14.2887861-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-24T01:38:14.2887861-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "52e42561-0a93-4d23-b137-8cf499961a10",
"CreateDate": "2026-04-24T01:38:14.2887861-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-24T01:38:14.2887861-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "31fa4a9f-8eed-4239-9751-ff7cd7b56838",
"EffectiveDate": "2026-04-24T01:38:14.2887861-07:00",
"StatusType": {
"StatusTypeId": "6496546f-b423-46f7-8b7c-8517887d7c4f",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "a8cab56b-e4aa-40e4-b011-d31133b80b66",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "3e9d6698-65c8-4db0-b539-5af888fb8b7a",
"CreateDate": "2026-04-24T01:38:14.2887861-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-24T01:38:14.2887861-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "ad7132e8-d898-425f-a931-6b78b1f9e867",
"CreateDate": "2026-04-24T01:38:14.2887861-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-24T01:38:14.2887861-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3ff86e0c-6190-4efd-9be7-604edbb200cb",
"CreateDate": "2026-04-24T01:38:14.2887861-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-24T01:38:14.2887861-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "b63e1f78-c9d7-4e2e-b4a9-734d42faa9f5",
"EffectiveDate": "2026-04-24T01:38:14.2887861-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "3e2a7493-ba39-4c1d-82d3-9cd14c15f2b9",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "bcfd094d-6a76-4366-8f91-20bde9e50d8b",
"CreateDate": "2026-04-24T01:38:14.2887861-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-24T01:38:14.2887861-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e83a4536-19e9-43c8-9893-f0b29a22bf26",
"CreateDate": "2026-04-24T01:38:14.2887861-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-24T01:38:14.2887861-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-04-24T01:38:14.2887861-07:00",
"MeasurementValueNeededDate": "2026-04-24T01:38:14.2887861-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "79c6c688-c040-42c9-a7a5-72489c21a19a",
"CreateDate": "2026-04-24T01:38:14.2887861-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-24T01:38:14.2887861-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "06a12b56-38bf-4da5-b7c2-dbcf0c20f361",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c9e91153-4cfe-40f1-89e1-2c8fb15b36ef",
"CreateDate": "2026-04-24T01:38:14.2887861-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-24T01:38:14.2887861-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-04-24T01:38:14.2887861-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c39ae059-ce11-4c01-be95-77de850916be",
"CreateDate": "2026-04-24T01:38:14.2887861-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-24T01:38:14.2887861-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": "26a33fe1-8aa6-49c5-a02b-033bebd982d6",
"Asset": {
"AssetId": "5aaae658-227a-4e68-b38d-2fcba4da6376",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "c9ff6d81-4cdb-48ab-ac51-4e50a2c41f61",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6559ea06-1ec1-47eb-8d41-b9bc2c745028",
"CreateDate": "2026-04-24T01:38:14.2887861-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-24T01:38:14.2887861-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "a8edc85e-5980-4ee7-bede-c5f49dfb6099",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-24T01:38:14.2887861-07:00",
"MeasurementValueNeededDate": "2026-04-24T01:38:14.2887861-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8bc64ab5-b9bb-4a6a-a37b-2e792b747c56",
"CreateDate": "2026-04-24T01:38:14.2887861-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-24T01:38:14.2887861-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "ef489b74-3ba9-45d6-ab49-638c8b755da0",
"EffectiveDate": "2026-04-24T01:38:14.2887861-07:00",
"StateType": {
"StateTypeId": "2e4880d3-01fe-44ac-b979-7359d4cc2780",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "c9ff6d81-4cdb-48ab-ac51-4e50a2c41f61",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6559ea06-1ec1-47eb-8d41-b9bc2c745028",
"CreateDate": "2026-04-24T01:38:14.2887861-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-24T01:38:14.2887861-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "f7ffef3c-b8a5-460d-b11d-bdf963febf01",
"CreateDate": "2026-04-24T01:38:14.2887861-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-24T01:38:14.2887861-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d5462f69-962c-49a7-a086-891703263904",
"CreateDate": "2026-04-24T01:38:14.2887861-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-24T01:38:14.2887861-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "74c96a63-a454-4374-87b3-60611b192768",
"EffectiveDate": "2026-04-24T01:38:14.2887861-07:00",
"StatusType": {
"StatusTypeId": "04f1222d-d8dc-4402-a352-958de0b304c9",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "c9ff6d81-4cdb-48ab-ac51-4e50a2c41f61",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6559ea06-1ec1-47eb-8d41-b9bc2c745028",
"CreateDate": "2026-04-24T01:38:14.2887861-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-24T01:38:14.2887861-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "41c29443-639c-4bfd-b5a2-b7c4ed2baead",
"CreateDate": "2026-04-24T01:38:14.2887861-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-24T01:38:14.2887861-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a0968193-1d1d-4530-b75d-640c5e89ba64",
"CreateDate": "2026-04-24T01:38:14.2887861-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-24T01:38:14.2887861-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "c239a871-bf90-41f6-92a5-4084bdab2179",
"EffectiveDate": "2026-04-24T01:38:14.2887861-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "bcbce2ae-7bf0-4aa6-87ec-6aade4b8076f",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "5e0691ef-ea01-4a66-bbca-b78e40658712",
"CreateDate": "2026-04-24T01:38:14.2887861-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-24T01:38:14.2887861-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "596b5da6-aabc-4f26-bfff-9214b164cc23",
"CreateDate": "2026-04-24T01:38:14.2887861-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-24T01:38:14.2887861-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-04-24T01:38:14.2887861-07:00",
"MeasurementValueNeededDate": "2026-04-24T01:38:14.2887861-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "5ea94374-e899-4921-a9f6-1f375efa41fb",
"CreateDate": "2026-04-24T01:38:14.2887861-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-24T01:38:14.2887861-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "7fdf6ea5-aca8-41e2-92ac-7a3ec6a55e70",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "254736cf-c696-4775-ac40-4083d102c4ad",
"CreateDate": "2026-04-24T01:38:14.2887861-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-24T01:38:14.2887861-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-04-24T01:38:14.2887861-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "021a8b53-18b9-4054-80cf-092c585f1115",
"CreateDate": "2026-04-24T01:38:14.2887861-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-24T01:38:14.2887861-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}