PUT Notes
Updates the given note.
Request Information
URI Parameters
None.
Body Parameters
The note to update
NoteName | Description | Type | Additional information |
---|---|---|---|
NoteId | globally unique identifier |
None. |
|
Asset | Asset |
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": "e13b81ab-c418-442a-a628-f6ebc4d43024", "Asset": { "AssetId": "5c995e38-5d76-41e9-a077-10f213963cac", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "9a20a94b-4f00-4ddf-993f-6bc492b5f336", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "9f7ae698-9ce6-403a-bd0f-93b6cf5b863b", "CreateDate": "2024-04-28T19:37:16.8442389-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T19:37:16.8442389-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "299701c8-9ed5-41fc-aae5-1aeb8af1ef70", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T19:37:16.8442389-07:00", "MeasurementValueNeededDate": "2024-04-28T19:37:16.8442389-07:00", "SourceSystemId": "sample string 3", "CompanyId": "da4bdd74-0b52-421d-b6bd-4ade6c09003e", "CreateDate": "2024-04-28T19:37:16.8442389-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T19:37:16.8442389-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "cff5d681-58c7-406c-89fc-1eaf739c4a01", "EffectiveDate": "2024-04-28T19:37:16.8442389-07:00", "StateType": { "StateTypeId": "04ac2d17-e262-417a-99d1-b8d743dcd5df", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "9a20a94b-4f00-4ddf-993f-6bc492b5f336", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "9f7ae698-9ce6-403a-bd0f-93b6cf5b863b", "CreateDate": "2024-04-28T19:37:16.8442389-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T19:37:16.8442389-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "5991b724-e1bc-4342-8f26-dd8ac461ce36", "CreateDate": "2024-04-28T19:37:16.8442389-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T19:37:16.8442389-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "cc107277-5deb-4822-8a63-6d69d1c6659c", "CreateDate": "2024-04-28T19:37:16.8442389-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T19:37:16.8442389-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "4ff271e6-1558-4f96-917d-8f43a04aa7a0", "EffectiveDate": "2024-04-28T19:37:16.8442389-07:00", "StatusType": { "StatusTypeId": "bfe90e91-336e-4796-936f-8663d52ac0d1", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "9a20a94b-4f00-4ddf-993f-6bc492b5f336", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "9f7ae698-9ce6-403a-bd0f-93b6cf5b863b", "CreateDate": "2024-04-28T19:37:16.8442389-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T19:37:16.8442389-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "4f142f6f-0e3f-4f96-b56b-7eb690504d2c", "CreateDate": "2024-04-28T19:37:16.8442389-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T19:37:16.8442389-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "edf65f76-a53a-4a54-9f93-6a0bd67a5f1b", "CreateDate": "2024-04-28T19:37:16.8442389-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T19:37:16.8442389-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "5c0f3bee-b3c9-483b-b37d-44e6ddb39584", "EffectiveDate": "2024-04-28T19:37:16.8442389-07:00", "WellPurposeType": { "WellPurposeTypeId": "1eaa0119-2c89-4e6c-bb82-52516d4f8a5d", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "d9c7fdca-da58-46b7-ab8c-75421f63a553", "CreateDate": "2024-04-28T19:37:16.8442389-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T19:37:16.8442389-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "5c3ce4f7-cbc2-42b4-b5f1-98962e4f299c", "CreateDate": "2024-04-28T19:37:16.8442389-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T19:37:16.8442389-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-04-28T19:37:16.8442389-07:00", "MeasurementValueNeededDate": "2024-04-28T19:37:16.8442389-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "ba65c9f1-cb74-41d2-b658-bb5762c6bf0e", "CreateDate": "2024-04-28T19:37:16.8442389-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T19:37:16.8442389-07:00", "LastModifiedUser": "sample string 8" }, "NoteCategory": { "NoteCategoryId": "e04d7f67-59ec-4ddb-9311-0b4552ec74bd", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "777da505-9b94-4a62-b70a-7b7b851912d6", "CreateDate": "2024-04-28T19:37:16.8442389-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-04-28T19:37:16.8442389-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2024-04-28T19:37:16.8442389-07:00", "NoteHTML": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "2bbc39cb-6d4e-4e83-b6b6-96dc9836cc62", "CreateDate": "2024-04-28T19:37:16.8442389-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-04-28T19:37:16.8442389-07:00", "LastModifiedUser": "sample string 5" }
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": "800dfbc4-4b1c-4700-ad42-d15784f40e25", "Asset": { "AssetId": "db9c5f54-6a75-49ec-9020-358c2a2329a5", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "f7d17e2e-c723-4711-a672-cc74c5f400e6", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "67ccb7cf-a28f-434d-a80e-b0e455c55a24", "CreateDate": "2024-04-28T19:37:16.8598161-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T19:37:16.8598161-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "893ccea6-85de-4f06-9303-bef05dd3ca74", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T19:37:16.8598161-07:00", "MeasurementValueNeededDate": "2024-04-28T19:37:16.8598161-07:00", "SourceSystemId": "sample string 3", "CompanyId": "1ac5742b-73c9-41e9-97e6-fee1ba3af2f2", "CreateDate": "2024-04-28T19:37:16.8598161-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T19:37:16.8598161-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "1f29d9cc-24c4-4b12-837e-c85a86d596ab", "EffectiveDate": "2024-04-28T19:37:16.8598161-07:00", "StateType": { "StateTypeId": "cde2c24a-6b7e-4003-98bd-e6bed0d7621e", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "f7d17e2e-c723-4711-a672-cc74c5f400e6", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "67ccb7cf-a28f-434d-a80e-b0e455c55a24", "CreateDate": "2024-04-28T19:37:16.8598161-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T19:37:16.8598161-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "a6a5b052-5e4f-4007-aeac-8d28e90d3303", "CreateDate": "2024-04-28T19:37:16.8598161-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T19:37:16.8598161-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "c7be3dbf-ab96-4932-90d3-3abb251f0d6f", "CreateDate": "2024-04-28T19:37:16.8598161-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T19:37:16.8598161-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "fbd605f0-b319-4cd9-8ab3-660801d76899", "EffectiveDate": "2024-04-28T19:37:16.8598161-07:00", "StatusType": { "StatusTypeId": "87be9797-f223-4bdd-b913-f2cc07642719", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "f7d17e2e-c723-4711-a672-cc74c5f400e6", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "67ccb7cf-a28f-434d-a80e-b0e455c55a24", "CreateDate": "2024-04-28T19:37:16.8598161-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T19:37:16.8598161-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "98bee729-da86-4840-ad43-1627af71a019", "CreateDate": "2024-04-28T19:37:16.8598161-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T19:37:16.8598161-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "fd77f9df-47d4-4c16-89e4-3f474c882df0", "CreateDate": "2024-04-28T19:37:16.8598161-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T19:37:16.8598161-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "1d0f4d30-eec9-498b-84c5-2b17e82261d7", "EffectiveDate": "2024-04-28T19:37:16.8598161-07:00", "WellPurposeType": { "WellPurposeTypeId": "5eb093c1-403a-488d-a420-0a2db4f0264e", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "aeda3913-65e8-40a5-a0ff-412aa53113cb", "CreateDate": "2024-04-28T19:37:16.8598161-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T19:37:16.8598161-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "776b818c-6029-452a-ba53-0810580e5941", "CreateDate": "2024-04-28T19:37:16.8598161-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T19:37:16.8598161-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-04-28T19:37:16.8598161-07:00", "MeasurementValueNeededDate": "2024-04-28T19:37:16.8598161-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "bddc50ae-593c-47d7-95af-b2e9e72e8e2f", "CreateDate": "2024-04-28T19:37:16.8598161-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T19:37:16.8598161-07:00", "LastModifiedUser": "sample string 8" }, "NoteCategory": { "NoteCategoryId": "7ac67a88-28ea-4d89-9eb4-1bb30608c77f", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "1f729121-1c9b-47f7-a87e-ac8e7c6cfcc6", "CreateDate": "2024-04-28T19:37:16.8598161-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-04-28T19:37:16.8598161-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2024-04-28T19:37:16.8598161-07:00", "NoteHTML": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "5531f860-b3af-49cb-9d58-21e485e08134", "CreateDate": "2024-04-28T19:37:16.8598161-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-04-28T19:37:16.8598161-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }