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": "73432aab-bb61-478d-8266-c881280584a1",
"Asset": {
"AssetId": "93d09a55-9851-4ef4-9a7b-adf3c1aec61e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "dd7702a3-93cd-4644-bf7d-e087de70f749",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f469a700-cfe6-42c3-922b-81a9958c3c15",
"CreateDate": "2024-11-21T05:04:17.483053-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-11-21T05:04:17.483053-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "59bbd0df-f9ad-406e-ad5b-b19d167dc2b8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-11-21T05:04:17.483053-08:00",
"MeasurementValueNeededDate": "2024-11-21T05:04:17.483053-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e745a1a6-8b49-4536-906c-9d28784a5a17",
"CreateDate": "2024-11-21T05:04:17.483053-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-11-21T05:04:17.483053-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "5fbd084d-bed0-4280-b09d-29ce43c420e8",
"EffectiveDate": "2024-11-21T05:04:17.483053-08:00",
"StateType": {
"StateTypeId": "413039dc-da06-4b52-be9b-8855344f9d80",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "dd7702a3-93cd-4644-bf7d-e087de70f749",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f469a700-cfe6-42c3-922b-81a9958c3c15",
"CreateDate": "2024-11-21T05:04:17.483053-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-11-21T05:04:17.483053-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "5a70b2ad-5dea-48f2-9ff9-fe56b3b63b22",
"CreateDate": "2024-11-21T05:04:17.483053-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-11-21T05:04:17.483053-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ed9a4019-366b-4e84-a227-846123c50d62",
"CreateDate": "2024-11-21T05:04:17.483053-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-11-21T05:04:17.483053-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "11aa5efa-c0db-45fd-b205-8ae3a4e059ab",
"EffectiveDate": "2024-11-21T05:04:17.483053-08:00",
"StatusType": {
"StatusTypeId": "b5ab7e82-fd40-480d-8fc4-22cedf359993",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "dd7702a3-93cd-4644-bf7d-e087de70f749",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f469a700-cfe6-42c3-922b-81a9958c3c15",
"CreateDate": "2024-11-21T05:04:17.483053-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-11-21T05:04:17.483053-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "e16d8199-d0d9-4633-a5d9-5d79f533469d",
"CreateDate": "2024-11-21T05:04:17.483053-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-11-21T05:04:17.483053-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a5345ac0-c455-4ab7-a110-fa89ee10b8c6",
"CreateDate": "2024-11-21T05:04:17.483053-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-11-21T05:04:17.483053-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "82f269d0-eb3c-4e3c-8d0f-613e3ef528c2",
"EffectiveDate": "2024-11-21T05:04:17.483053-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "23bfe789-c0f6-43ed-93f8-3bc93c458ded",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "bc05ea90-e482-422f-af8e-4d113bf60e58",
"CreateDate": "2024-11-21T05:04:17.483053-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-11-21T05:04:17.483053-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "641349d3-0c12-46fe-bf81-647139d0fda5",
"CreateDate": "2024-11-21T05:04:17.483053-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-11-21T05:04:17.483053-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2024-11-21T05:04:17.483053-08:00",
"MeasurementValueNeededDate": "2024-11-21T05:04:17.483053-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "8af8a147-d8a9-478d-8b24-ecba9f2f73a1",
"CreateDate": "2024-11-21T05:04:17.483053-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-11-21T05:04:17.483053-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "16cb3857-3af1-480b-9908-9bfc884e083c",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "90322134-977a-4008-ab3b-7d056a262ed6",
"CreateDate": "2024-11-21T05:04:17.483053-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-11-21T05:04:17.483053-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2024-11-21T05:04:17.483053-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "758858b4-2e3a-4d9b-a0a1-18ddfbebb0bb",
"CreateDate": "2024-11-21T05:04:17.483053-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-11-21T05:04:17.483053-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": "c4c3190c-6e7f-4376-bfa3-d56ebc5f82b1",
"Asset": {
"AssetId": "6b2f2a2b-22d8-48e0-b15c-cde01f154efa",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "3d384f7f-0f11-4257-ae59-75257fd498cd",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "808e9f7c-d527-43c3-81a7-57d6b91c2675",
"CreateDate": "2024-11-21T05:04:17.483053-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-11-21T05:04:17.483053-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "458d4718-d48b-493a-a93a-e62c7d9a6939",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-11-21T05:04:17.483053-08:00",
"MeasurementValueNeededDate": "2024-11-21T05:04:17.483053-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ad271dd6-b3f4-471f-b90d-d1f68f5307ba",
"CreateDate": "2024-11-21T05:04:17.483053-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-11-21T05:04:17.483053-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "d82c24df-8c18-4660-87bc-fc94521326d3",
"EffectiveDate": "2024-11-21T05:04:17.483053-08:00",
"StateType": {
"StateTypeId": "c5a73273-69e2-49b7-ac76-15d3191decef",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "3d384f7f-0f11-4257-ae59-75257fd498cd",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "808e9f7c-d527-43c3-81a7-57d6b91c2675",
"CreateDate": "2024-11-21T05:04:17.483053-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-11-21T05:04:17.483053-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "096f2372-9c44-480d-9f64-ee0bd6201d9e",
"CreateDate": "2024-11-21T05:04:17.483053-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-11-21T05:04:17.483053-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9f5c01f4-36f9-45f4-be4d-1cce93f26fed",
"CreateDate": "2024-11-21T05:04:17.483053-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-11-21T05:04:17.483053-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "95ff58fd-f134-43be-975c-76093c64f225",
"EffectiveDate": "2024-11-21T05:04:17.483053-08:00",
"StatusType": {
"StatusTypeId": "efbac5a8-8ff8-45f8-9123-c0631cd62263",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "3d384f7f-0f11-4257-ae59-75257fd498cd",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "808e9f7c-d527-43c3-81a7-57d6b91c2675",
"CreateDate": "2024-11-21T05:04:17.483053-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-11-21T05:04:17.483053-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "21485790-ba3e-4e3f-aac4-a9a1e758d6ce",
"CreateDate": "2024-11-21T05:04:17.483053-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-11-21T05:04:17.483053-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b25df221-a236-407d-bfdd-2da634772389",
"CreateDate": "2024-11-21T05:04:17.483053-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-11-21T05:04:17.483053-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "84efe5b3-3a70-42b2-b5df-8fed8ff54fe3",
"EffectiveDate": "2024-11-21T05:04:17.483053-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "739b9238-9b84-4a5b-8b15-3281dcb54968",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a4dee785-1a1f-45c5-8b51-16a43a9da72d",
"CreateDate": "2024-11-21T05:04:17.483053-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-11-21T05:04:17.483053-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d137ca1c-8515-42de-8548-745b17ceebe8",
"CreateDate": "2024-11-21T05:04:17.483053-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-11-21T05:04:17.483053-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2024-11-21T05:04:17.483053-08:00",
"MeasurementValueNeededDate": "2024-11-21T05:04:17.483053-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "bd13531d-4cca-4258-bdd3-12c9ba62f68d",
"CreateDate": "2024-11-21T05:04:17.483053-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-11-21T05:04:17.483053-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "76fd5998-9820-48d9-8db5-160e1a0f04cb",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "741b7e2b-bf60-42eb-af91-48e2b8b637c1",
"CreateDate": "2024-11-21T05:04:17.483053-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-11-21T05:04:17.483053-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2024-11-21T05:04:17.483053-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c1f3515c-3142-44e9-b538-0cd484ad5a48",
"CreateDate": "2024-11-21T05:04:17.483053-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-11-21T05:04:17.483053-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}