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": "08ef05be-caa4-44c4-9d85-978f0e3005d2", "Asset": { "AssetId": "893c9815-66f1-41bf-b8e1-e8da69e1a7f5", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "f8842272-d152-4814-acc1-cf463f4508e0", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "22d9f16d-76bb-4485-8208-7d8c9100ff47", "CreateDate": "2024-04-20T02:40:18.7547115-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-20T02:40:18.7547115-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "91834b73-a1f2-4a8b-8671-c424863726ce", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-20T02:40:18.7547115-07:00", "MeasurementValueNeededDate": "2024-04-20T02:40:18.7547115-07:00", "SourceSystemId": "sample string 3", "CompanyId": "ef6ac0b8-4d2b-442a-97ff-3a522807ff89", "CreateDate": "2024-04-20T02:40:18.7547115-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-20T02:40:18.7547115-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "f0469693-1c65-4687-ac82-5e6101f3f1ff", "EffectiveDate": "2024-04-20T02:40:18.7547115-07:00", "StateType": { "StateTypeId": "48610d24-e845-49c4-9e03-6b95a4341f1f", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "f8842272-d152-4814-acc1-cf463f4508e0", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "22d9f16d-76bb-4485-8208-7d8c9100ff47", "CreateDate": "2024-04-20T02:40:18.7547115-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-20T02:40:18.7547115-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "96ba0dbb-15d4-492a-bb91-bd140765936f", "CreateDate": "2024-04-20T02:40:18.7547115-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-20T02:40:18.7547115-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "c0d16266-dc4f-4fcb-ab4a-b2e2ede7f935", "CreateDate": "2024-04-20T02:40:18.7547115-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-20T02:40:18.7547115-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "39587ba4-4412-45c6-9bdb-ecdf89c6418a", "EffectiveDate": "2024-04-20T02:40:18.7547115-07:00", "StatusType": { "StatusTypeId": "34442df9-69d1-4b6e-a11a-6ab6c453fe65", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "f8842272-d152-4814-acc1-cf463f4508e0", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "22d9f16d-76bb-4485-8208-7d8c9100ff47", "CreateDate": "2024-04-20T02:40:18.7547115-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-20T02:40:18.7547115-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "c4aaa32b-f7ae-47cc-88bd-9073d6e20e97", "CreateDate": "2024-04-20T02:40:18.7547115-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-20T02:40:18.7547115-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "a76aba44-90c7-4d9c-a802-cc9f26af93e0", "CreateDate": "2024-04-20T02:40:18.7547115-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-20T02:40:18.7547115-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "78410fdf-a359-4887-b79f-3f5e741e92d9", "EffectiveDate": "2024-04-20T02:40:18.7547115-07:00", "WellPurposeType": { "WellPurposeTypeId": "bc69a855-834d-4a38-ba57-d3af1df14258", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "37fa45b9-513b-41b2-925a-29ce17b48475", "CreateDate": "2024-04-20T02:40:18.7547115-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-20T02:40:18.7547115-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "8110a43b-85c0-47d9-8c54-cacee83a7cdf", "CreateDate": "2024-04-20T02:40:18.7547115-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-20T02:40:18.7547115-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-04-20T02:40:18.7547115-07:00", "MeasurementValueNeededDate": "2024-04-20T02:40:18.7547115-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "9465111e-af11-4760-a007-207a51e6b6c8", "CreateDate": "2024-04-20T02:40:18.7547115-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-20T02:40:18.7547115-07:00", "LastModifiedUser": "sample string 8" }, "NoteCategory": { "NoteCategoryId": "92c82969-85a1-417f-bfcf-0008e76167b1", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "6d2fcc91-2202-4d4c-9869-c9d520ac20de", "CreateDate": "2024-04-20T02:40:18.7547115-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-04-20T02:40:18.7547115-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2024-04-20T02:40:18.7547115-07:00", "NoteHTML": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "507bc38d-0a77-4d3e-94a9-761795b99649", "CreateDate": "2024-04-20T02:40:18.7547115-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-04-20T02:40:18.7547115-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": "6f84eb47-b648-4136-ba37-92b4c1c550b9", "Asset": { "AssetId": "225c64b2-3523-485f-b1b8-42152ffe9f93", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "53ad8b48-0565-485c-8687-8fd2d992e803", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5bbb7270-2dba-4a51-9ec8-36c12daa5606", "CreateDate": "2024-04-20T02:40:18.7547115-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-20T02:40:18.7547115-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "f1d80754-8e61-41ea-82a1-6b9046ff4f79", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-20T02:40:18.7547115-07:00", "MeasurementValueNeededDate": "2024-04-20T02:40:18.7547115-07:00", "SourceSystemId": "sample string 3", "CompanyId": "70613ae3-2d6b-4d2c-adfc-e0df1d0c0a40", "CreateDate": "2024-04-20T02:40:18.7547115-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-20T02:40:18.7547115-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "8bc4720f-da20-4ae0-ac56-2e7a04e6576c", "EffectiveDate": "2024-04-20T02:40:18.7547115-07:00", "StateType": { "StateTypeId": "37799ed5-324d-497d-8b3b-719450ec41a1", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "53ad8b48-0565-485c-8687-8fd2d992e803", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5bbb7270-2dba-4a51-9ec8-36c12daa5606", "CreateDate": "2024-04-20T02:40:18.7547115-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-20T02:40:18.7547115-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "ef7bda18-3b64-4915-afe0-05a6610f5960", "CreateDate": "2024-04-20T02:40:18.7547115-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-20T02:40:18.7547115-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "152808b6-9fbb-47b7-90da-28cf90fb74d1", "CreateDate": "2024-04-20T02:40:18.7547115-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-20T02:40:18.7547115-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "9a2552f9-5b81-4917-8bc9-5a96d236eefa", "EffectiveDate": "2024-04-20T02:40:18.7547115-07:00", "StatusType": { "StatusTypeId": "e11bbc63-9033-40f6-9c1f-c6ff99a1ebf3", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "53ad8b48-0565-485c-8687-8fd2d992e803", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5bbb7270-2dba-4a51-9ec8-36c12daa5606", "CreateDate": "2024-04-20T02:40:18.7547115-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-20T02:40:18.7547115-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "1109382a-3b4e-46b4-89e0-1bfa22071224", "CreateDate": "2024-04-20T02:40:18.7547115-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-20T02:40:18.7547115-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "7958495c-54ab-4a78-9fab-b9caa1fff94d", "CreateDate": "2024-04-20T02:40:18.7547115-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-20T02:40:18.7547115-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "2196ca5d-ba3e-4297-8283-71024fd12421", "EffectiveDate": "2024-04-20T02:40:18.7547115-07:00", "WellPurposeType": { "WellPurposeTypeId": "07dba15c-4675-4ee8-b03f-a83924bd48e0", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "0c0ce176-afa5-4521-ad1b-343734b61bd0", "CreateDate": "2024-04-20T02:40:18.7547115-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-20T02:40:18.7547115-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "2afca9e3-4874-4bc8-b977-5c41f2dca938", "CreateDate": "2024-04-20T02:40:18.7547115-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-20T02:40:18.7547115-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-04-20T02:40:18.7547115-07:00", "MeasurementValueNeededDate": "2024-04-20T02:40:18.7547115-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "eff95995-2353-44f1-b618-861035698a90", "CreateDate": "2024-04-20T02:40:18.7547115-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-20T02:40:18.7547115-07:00", "LastModifiedUser": "sample string 8" }, "NoteCategory": { "NoteCategoryId": "02117798-ed5c-4ad4-950c-22ce41cf1d4d", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "2f26924c-5c80-47f9-aa98-d340d821f102", "CreateDate": "2024-04-20T02:40:18.7547115-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-04-20T02:40:18.7547115-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2024-04-20T02:40:18.7547115-07:00", "NoteHTML": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "c97ff125-dc51-4265-8fb2-2210c4a23fd0", "CreateDate": "2024-04-20T02:40:18.7547115-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-04-20T02:40:18.7547115-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }