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": "8eee4284-ae3a-4b6f-9396-b715b27a165c",
"Asset": {
"AssetId": "0eba6ae1-e925-4da9-a381-7d38057f9e2b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d25fe8ce-58c5-409b-b65a-ffe2db4f3161",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f0aa9880-a70a-4909-854f-5f377287ef11",
"CreateDate": "2026-03-22T19:54:38.6787674-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-22T19:54:38.6787674-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "764367bf-e806-45b7-99e9-1fb869516c3f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-22T19:54:38.6787674-07:00",
"MeasurementValueNeededDate": "2026-03-22T19:54:38.6787674-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2e8ac40c-868e-4db9-b811-d7057cac2ede",
"CreateDate": "2026-03-22T19:54:38.6787674-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-22T19:54:38.6787674-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "58977a65-e6cf-4218-bbac-952b1a351f71",
"EffectiveDate": "2026-03-22T19:54:38.6787674-07:00",
"StateType": {
"StateTypeId": "5a20e4f8-5fbf-4531-8ad3-638efea325dc",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "d25fe8ce-58c5-409b-b65a-ffe2db4f3161",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f0aa9880-a70a-4909-854f-5f377287ef11",
"CreateDate": "2026-03-22T19:54:38.6787674-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-22T19:54:38.6787674-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "e053c6d9-712b-4cc5-9c32-ba9fbb6f6797",
"CreateDate": "2026-03-22T19:54:38.6787674-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-22T19:54:38.6787674-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5c619bac-bbca-4688-b315-b0198c1c3690",
"CreateDate": "2026-03-22T19:54:38.6787674-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-22T19:54:38.6787674-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "5a7866b2-5a7c-4e81-90eb-0f28de2f75f3",
"EffectiveDate": "2026-03-22T19:54:38.6787674-07:00",
"StatusType": {
"StatusTypeId": "bdfee630-9a38-4e94-afc8-e4d186139061",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "d25fe8ce-58c5-409b-b65a-ffe2db4f3161",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f0aa9880-a70a-4909-854f-5f377287ef11",
"CreateDate": "2026-03-22T19:54:38.6787674-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-22T19:54:38.6787674-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "f9e6f745-7382-41ee-b874-21f780563114",
"CreateDate": "2026-03-22T19:54:38.6787674-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-22T19:54:38.6787674-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "dedaeac0-2d4f-4bb0-a457-2abaeb39520a",
"CreateDate": "2026-03-22T19:54:38.6787674-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-22T19:54:38.6787674-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "84579fbc-18fa-440d-bb41-799879621e34",
"EffectiveDate": "2026-03-22T19:54:38.6787674-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "17f0d00a-f0ea-462a-acd1-70499bdadbb2",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "08f29e62-d214-4cca-b115-9012031990d5",
"CreateDate": "2026-03-22T19:54:38.6787674-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-22T19:54:38.6787674-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3cf1467e-8d1b-4cfd-876f-31913b8e3296",
"CreateDate": "2026-03-22T19:54:38.6787674-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-22T19:54:38.6787674-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-22T19:54:38.6787674-07:00",
"MeasurementValueNeededDate": "2026-03-22T19:54:38.6787674-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "8e0cf565-026c-40a0-b068-b520f24e8c17",
"CreateDate": "2026-03-22T19:54:38.6787674-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-22T19:54:38.6787674-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "dd72b276-dd1c-4d4c-ae3e-283751988286",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "12b6cb2f-59a6-4241-9a6b-546d3bba4682",
"CreateDate": "2026-03-22T19:54:38.6787674-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-22T19:54:38.6787674-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-22T19:54:38.6787674-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1d297ee4-9c0c-4fed-80ac-4b6f8b800a21",
"CreateDate": "2026-03-22T19:54:38.6787674-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-22T19:54:38.6787674-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": "efc611f6-6703-47a6-b6ff-9631fd6b5c45",
"Asset": {
"AssetId": "71444784-504f-4a42-a431-252021a811ed",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "872cb7f3-ba92-462f-a49c-b57ef0af5de8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "971afea4-2f56-413a-8d82-b8b613091f0f",
"CreateDate": "2026-03-22T19:54:38.6943467-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-22T19:54:38.6943467-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "4f1a1c06-b6a8-4e3a-ac9d-a877374cd2db",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-22T19:54:38.6943467-07:00",
"MeasurementValueNeededDate": "2026-03-22T19:54:38.6943467-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5322a44e-fd9f-427f-8766-761a206746f2",
"CreateDate": "2026-03-22T19:54:38.6943467-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-22T19:54:38.6943467-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "b85b2bca-4ce4-4412-ab31-876968891e47",
"EffectiveDate": "2026-03-22T19:54:38.6943467-07:00",
"StateType": {
"StateTypeId": "3888a4b9-2ecb-44a9-9b8d-fd75ec77aad7",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "872cb7f3-ba92-462f-a49c-b57ef0af5de8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "971afea4-2f56-413a-8d82-b8b613091f0f",
"CreateDate": "2026-03-22T19:54:38.6943467-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-22T19:54:38.6943467-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "9b3886d8-e1fb-4b7f-aec6-e5f3835f3213",
"CreateDate": "2026-03-22T19:54:38.6943467-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-22T19:54:38.6943467-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9a3e4629-c58d-42d9-87ae-0b975dbcc102",
"CreateDate": "2026-03-22T19:54:38.6943467-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-22T19:54:38.6943467-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "af6dd9ee-9ed0-4811-bbc7-a4dc2a8145a7",
"EffectiveDate": "2026-03-22T19:54:38.6943467-07:00",
"StatusType": {
"StatusTypeId": "4350fe0a-fb50-411b-840b-1eaf68f69529",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "872cb7f3-ba92-462f-a49c-b57ef0af5de8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "971afea4-2f56-413a-8d82-b8b613091f0f",
"CreateDate": "2026-03-22T19:54:38.6943467-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-22T19:54:38.6943467-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "3b4bbd81-a48d-4507-958e-98d4caecacaf",
"CreateDate": "2026-03-22T19:54:38.6943467-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-22T19:54:38.6943467-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0278067b-7d85-47f2-a4a5-04c93fd4fff7",
"CreateDate": "2026-03-22T19:54:38.6943467-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-22T19:54:38.6943467-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "7b33150c-b068-42ac-a6ef-1cda32ee59f4",
"EffectiveDate": "2026-03-22T19:54:38.6943467-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "8cd85b90-aa4c-48fa-a1b0-e01018ba78fc",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "35bb6f74-59c2-482a-ad57-17c090258b2b",
"CreateDate": "2026-03-22T19:54:38.6943467-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-22T19:54:38.6943467-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5f97cc9b-c6f2-4fa8-9d19-46de4d2ce334",
"CreateDate": "2026-03-22T19:54:38.6943467-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-22T19:54:38.6943467-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-22T19:54:38.6943467-07:00",
"MeasurementValueNeededDate": "2026-03-22T19:54:38.6943467-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b40e3a68-a1c9-49f6-b3da-f042ada5d01c",
"CreateDate": "2026-03-22T19:54:38.6943467-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-22T19:54:38.6943467-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "37fd3f04-a5b0-4c06-961b-d040d137b38c",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1bd6a497-bb69-443a-bd3c-483dfd602916",
"CreateDate": "2026-03-22T19:54:38.6943467-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-22T19:54:38.6943467-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-22T19:54:38.6943467-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "00e5b737-01bc-4a37-bc60-06d58520cf7c",
"CreateDate": "2026-03-22T19:54:38.6943467-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-22T19:54:38.6943467-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}