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": "901fd918-b5bb-4061-a31e-919c423609c3",
"Asset": {
"AssetId": "797a4c68-8eab-4c65-bfd3-8d4a44b0708d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "82dea971-53ac-495d-b24a-a883c893cb1a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "53f4a3cf-0e41-4572-9a28-67dd778aa62f",
"CreateDate": "2025-03-09T03:33:38.1338697-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-03-09T03:33:38.1338697-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "f2ef0bfe-1344-4ae7-b647-b4579f35005d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-03-09T03:33:38.1338697-07:00",
"MeasurementValueNeededDate": "2025-03-09T03:33:38.1338697-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "acfaaa26-a11b-4895-9b4b-afd48af60452",
"CreateDate": "2025-03-09T03:33:38.1338697-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-03-09T03:33:38.1338697-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "54a964e8-8546-4d99-a6a2-72453c307caa",
"EffectiveDate": "2025-03-09T03:33:38.1338697-07:00",
"StateType": {
"StateTypeId": "75d501cb-acf6-4a70-9c82-2b4f4ad94691",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "82dea971-53ac-495d-b24a-a883c893cb1a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "53f4a3cf-0e41-4572-9a28-67dd778aa62f",
"CreateDate": "2025-03-09T03:33:38.1338697-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-03-09T03:33:38.1338697-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "9805f3b3-e137-4806-86a6-a8dea033d19d",
"CreateDate": "2025-03-09T03:33:38.1338697-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-03-09T03:33:38.1338697-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "139ed4c5-afea-4b30-800b-8a57582f6c65",
"CreateDate": "2025-03-09T03:33:38.1338697-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-03-09T03:33:38.1338697-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "6f0c2f0d-5789-45c9-8622-c6b9c964f19e",
"EffectiveDate": "2025-03-09T03:33:38.1338697-07:00",
"StatusType": {
"StatusTypeId": "c4eeef27-781c-4b1b-acdf-d1cb47fef2d3",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "82dea971-53ac-495d-b24a-a883c893cb1a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "53f4a3cf-0e41-4572-9a28-67dd778aa62f",
"CreateDate": "2025-03-09T03:33:38.1338697-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-03-09T03:33:38.1338697-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "d0509b46-322f-42fd-aee4-b429038cfc90",
"CreateDate": "2025-03-09T03:33:38.1338697-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-03-09T03:33:38.1338697-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5913728f-ddf1-4e72-a013-b800b461ffd1",
"CreateDate": "2025-03-09T03:33:38.1338697-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-03-09T03:33:38.1338697-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "ae894f5e-7618-4a78-87e2-380fde35308c",
"EffectiveDate": "2025-03-09T03:33:38.1338697-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "d90db302-20c1-4497-b2e4-e2361036ca75",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2acabf46-a472-4bec-a92f-2f22398ada02",
"CreateDate": "2025-03-09T03:33:38.1338697-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-03-09T03:33:38.1338697-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "846fcacc-92e8-4e23-8ddb-7ad45abd8e0e",
"CreateDate": "2025-03-09T03:33:38.1338697-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-03-09T03:33:38.1338697-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-03-09T03:33:38.1338697-07:00",
"MeasurementValueNeededDate": "2025-03-09T03:33:38.1338697-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "ff00a96e-81e9-4ab8-9c11-1dcf1c908632",
"CreateDate": "2025-03-09T03:33:38.1338697-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-03-09T03:33:38.1338697-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "ceefda05-3a13-45e1-ac51-530177a46dbb",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "7b10835e-efad-4081-b01a-8387ec905f9a",
"CreateDate": "2025-03-09T03:33:38.1338697-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-03-09T03:33:38.1338697-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-03-09T03:33:38.1338697-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "986bce84-b1d7-43b2-a0cc-75780c01f26d",
"CreateDate": "2025-03-09T03:33:38.1338697-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-03-09T03:33:38.1338697-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": "fa1b1fca-0441-4776-90e9-0af6c66e2fcc",
"Asset": {
"AssetId": "31111d8c-75df-45da-962f-ca4a81f07ec8",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "9fb1a625-a95d-419c-b345-dc41726bcd61",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a9946db4-53fc-4f7f-84f1-1e5131e3e178",
"CreateDate": "2025-03-09T03:33:38.1338697-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-03-09T03:33:38.1338697-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "6c1d16fe-0c60-45b6-9996-fed2d55c4f9f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-03-09T03:33:38.1338697-07:00",
"MeasurementValueNeededDate": "2025-03-09T03:33:38.1338697-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2f095329-2ad1-447f-abc4-5affaec483ab",
"CreateDate": "2025-03-09T03:33:38.1338697-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-03-09T03:33:38.1338697-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "5cc3b3b0-f997-4af7-97cb-87c98feaf852",
"EffectiveDate": "2025-03-09T03:33:38.1338697-07:00",
"StateType": {
"StateTypeId": "254e58c5-b66e-4088-9fb5-24ca2687431d",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "9fb1a625-a95d-419c-b345-dc41726bcd61",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a9946db4-53fc-4f7f-84f1-1e5131e3e178",
"CreateDate": "2025-03-09T03:33:38.1338697-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-03-09T03:33:38.1338697-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "44539b7f-5d72-48ac-a36d-5450e1b621f4",
"CreateDate": "2025-03-09T03:33:38.1338697-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-03-09T03:33:38.1338697-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "764efc9d-9fbc-4ef7-bb12-3b1205b9ded5",
"CreateDate": "2025-03-09T03:33:38.1338697-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-03-09T03:33:38.1338697-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "b293a73e-3a5f-45ae-a177-b3e683ab64ac",
"EffectiveDate": "2025-03-09T03:33:38.1338697-07:00",
"StatusType": {
"StatusTypeId": "688f17f7-fb3c-49ff-b416-61cc930eb305",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "9fb1a625-a95d-419c-b345-dc41726bcd61",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a9946db4-53fc-4f7f-84f1-1e5131e3e178",
"CreateDate": "2025-03-09T03:33:38.1338697-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-03-09T03:33:38.1338697-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "30ab2bc4-2781-4428-b7e0-b88b85ad9e6c",
"CreateDate": "2025-03-09T03:33:38.1338697-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-03-09T03:33:38.1338697-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "59ff8b84-77c9-4cad-8ba6-eab01f4f7b04",
"CreateDate": "2025-03-09T03:33:38.1338697-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-03-09T03:33:38.1338697-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "ddb627d9-8f81-4741-b260-a8eb06cec0b6",
"EffectiveDate": "2025-03-09T03:33:38.1338697-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "da2ac518-c329-4150-9826-0ab9dbcf7982",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2ad1a6b6-0ca9-4ba7-b25f-5075f0dd3bcc",
"CreateDate": "2025-03-09T03:33:38.1338697-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-03-09T03:33:38.1338697-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2fcf8f4b-e3dd-4e07-bb50-9664002fe000",
"CreateDate": "2025-03-09T03:33:38.1338697-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-03-09T03:33:38.1338697-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-03-09T03:33:38.1338697-07:00",
"MeasurementValueNeededDate": "2025-03-09T03:33:38.1338697-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "3f468da4-cb49-4a1e-abdf-9056a273226d",
"CreateDate": "2025-03-09T03:33:38.1338697-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-03-09T03:33:38.1338697-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "362d8598-7144-404c-af3d-4293ca95296b",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c493e8e8-f585-4f0b-a2e7-d214e299e912",
"CreateDate": "2025-03-09T03:33:38.1338697-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-03-09T03:33:38.1338697-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-03-09T03:33:38.1338697-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c6f19a55-eae2-416c-8c7b-4907b6c39ba4",
"CreateDate": "2025-03-09T03:33:38.1338697-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-03-09T03:33:38.1338697-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}