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": "1b8a311e-e551-453f-8eb5-d0543791369b", "Asset": { "AssetId": "e420e7bc-eee0-4f3a-882b-6137933dccea", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "10b1f8f3-7798-4d1f-be1f-f2dce807d9a2", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5c9e8bfb-9f31-440d-8505-c73c97ed2ecf", "CreateDate": "2024-07-26T19:16:03.1184372-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-07-26T19:16:03.1184372-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "50857dc1-08ee-4705-952d-f04d1c7029e9", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-07-26T19:16:03.1184372-07:00", "MeasurementValueNeededDate": "2024-07-26T19:16:03.1184372-07:00", "SourceSystemId": "sample string 3", "CompanyId": "1ffb2ee7-e0bb-48aa-91dd-9d9d469f19f9", "CreateDate": "2024-07-26T19:16:03.1184372-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-07-26T19:16:03.1184372-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "147e91e1-eabb-4eef-bae6-830ffbf75fde", "EffectiveDate": "2024-07-26T19:16:03.1184372-07:00", "StateType": { "StateTypeId": "f715aa74-ddee-44cf-a85c-e63cf79badfc", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "10b1f8f3-7798-4d1f-be1f-f2dce807d9a2", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5c9e8bfb-9f31-440d-8505-c73c97ed2ecf", "CreateDate": "2024-07-26T19:16:03.1184372-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-07-26T19:16:03.1184372-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "c76d44ae-4093-4912-b2e3-404317b1517e", "CreateDate": "2024-07-26T19:16:03.1184372-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-07-26T19:16:03.1184372-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "28bbea56-a444-436f-9597-936d8b73806b", "CreateDate": "2024-07-26T19:16:03.1184372-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-07-26T19:16:03.1184372-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "d11708ee-6f3e-49ec-8bf4-4099cd539f30", "EffectiveDate": "2024-07-26T19:16:03.1184372-07:00", "StatusType": { "StatusTypeId": "2cbd06cd-e4db-4e8c-bafb-a17d7cf65bff", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "10b1f8f3-7798-4d1f-be1f-f2dce807d9a2", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5c9e8bfb-9f31-440d-8505-c73c97ed2ecf", "CreateDate": "2024-07-26T19:16:03.1184372-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-07-26T19:16:03.1184372-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "23a0b61d-3e50-48b0-8c10-7e80272d4679", "CreateDate": "2024-07-26T19:16:03.1184372-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-07-26T19:16:03.1184372-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "d278954f-4308-4024-a043-3db25757f691", "CreateDate": "2024-07-26T19:16:03.1184372-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-07-26T19:16:03.1184372-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "a1196a5d-5981-4dde-bcc1-793a81614fff", "EffectiveDate": "2024-07-26T19:16:03.1184372-07:00", "WellPurposeType": { "WellPurposeTypeId": "4cef540e-1280-4bad-b35a-92d3e69e6417", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "c1aef6b1-6529-4e25-9706-a42e5a711343", "CreateDate": "2024-07-26T19:16:03.1184372-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-07-26T19:16:03.1184372-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "3fa52eb4-7fb6-4199-95a0-a3a47da2728b", "CreateDate": "2024-07-26T19:16:03.1184372-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-07-26T19:16:03.1184372-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-07-26T19:16:03.1184372-07:00", "MeasurementValueNeededDate": "2024-07-26T19:16:03.1184372-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "3a068bf4-e8c7-4180-9de0-f813faae89c4", "CreateDate": "2024-07-26T19:16:03.1184372-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-07-26T19:16:03.1184372-07:00", "LastModifiedUser": "sample string 8" }, "NoteCategory": { "NoteCategoryId": "b1ec8f60-ac11-4992-8fee-7e97a2da3a79", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "5f1d42f9-e056-4c7b-b76e-b884882f5d5c", "CreateDate": "2024-07-26T19:16:03.1184372-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-07-26T19:16:03.1184372-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2024-07-26T19:16:03.1184372-07:00", "NoteHTML": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "77d1e282-33f8-4d79-931a-80e296b2e30d", "CreateDate": "2024-07-26T19:16:03.1184372-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-07-26T19:16:03.1184372-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": "8a7bf9f5-b8ad-4850-ae2b-4e353380804e", "Asset": { "AssetId": "0a64b07f-49c5-4d45-9a45-ae8dae39a765", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "4b4fd175-f4ac-43e1-bf80-e90b6af08ba7", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "3d9a9b9d-e960-4bd2-b539-3a50c735a1d1", "CreateDate": "2024-07-26T19:16:03.1340603-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-07-26T19:16:03.1340603-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "b5101446-b5ce-4cf3-b282-a6ed12365c1c", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-07-26T19:16:03.1340603-07:00", "MeasurementValueNeededDate": "2024-07-26T19:16:03.1340603-07:00", "SourceSystemId": "sample string 3", "CompanyId": "c127f2b0-76b1-48dd-81f3-4a2c250d5b6f", "CreateDate": "2024-07-26T19:16:03.1340603-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-07-26T19:16:03.1340603-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "1225cb13-362e-424a-9d67-5d522ee961ab", "EffectiveDate": "2024-07-26T19:16:03.1340603-07:00", "StateType": { "StateTypeId": "769c4993-dce2-4bea-ac95-1bb190134f33", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "4b4fd175-f4ac-43e1-bf80-e90b6af08ba7", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "3d9a9b9d-e960-4bd2-b539-3a50c735a1d1", "CreateDate": "2024-07-26T19:16:03.1340603-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-07-26T19:16:03.1340603-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "8628596c-6093-4bb2-9a2d-22cce2c2e192", "CreateDate": "2024-07-26T19:16:03.1340603-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-07-26T19:16:03.1340603-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "0c1948fb-e17f-41bd-a981-f16f3ba6e15c", "CreateDate": "2024-07-26T19:16:03.1340603-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-07-26T19:16:03.1340603-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "5b3fa13d-eb04-435a-b785-fee7b87d9564", "EffectiveDate": "2024-07-26T19:16:03.1340603-07:00", "StatusType": { "StatusTypeId": "831d5c5c-92a1-4745-aa6a-4d932dcc1277", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "4b4fd175-f4ac-43e1-bf80-e90b6af08ba7", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "3d9a9b9d-e960-4bd2-b539-3a50c735a1d1", "CreateDate": "2024-07-26T19:16:03.1340603-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-07-26T19:16:03.1340603-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "777b463e-ea2b-4e35-a894-9b04bda7c00c", "CreateDate": "2024-07-26T19:16:03.1340603-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-07-26T19:16:03.1340603-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "a746e575-4fca-437e-a5dd-b9a949d79535", "CreateDate": "2024-07-26T19:16:03.1340603-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-07-26T19:16:03.1340603-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "2e60576b-5bb5-42d3-9321-ae2a8ab7b665", "EffectiveDate": "2024-07-26T19:16:03.1340603-07:00", "WellPurposeType": { "WellPurposeTypeId": "87015749-d5e4-4969-b460-679d7d96f138", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "b87f7bfb-3499-4383-9db4-3aadb4ba20f3", "CreateDate": "2024-07-26T19:16:03.1340603-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-07-26T19:16:03.1340603-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "a2eac522-49a8-4fe6-9be4-4af13f5de505", "CreateDate": "2024-07-26T19:16:03.1340603-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-07-26T19:16:03.1340603-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-07-26T19:16:03.1340603-07:00", "MeasurementValueNeededDate": "2024-07-26T19:16:03.1340603-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "dbada94a-7156-4498-a06e-6cf2f3e67cf2", "CreateDate": "2024-07-26T19:16:03.1340603-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-07-26T19:16:03.1340603-07:00", "LastModifiedUser": "sample string 8" }, "NoteCategory": { "NoteCategoryId": "677d3d7f-7335-41ba-8aa3-4344ee951161", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "86b6b4c0-d8f7-4909-86a6-75deaff52f67", "CreateDate": "2024-07-26T19:16:03.1340603-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-07-26T19:16:03.1340603-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2024-07-26T19:16:03.1340603-07:00", "NoteHTML": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "5379dd22-2f14-4ad4-b300-aee144166e0a", "CreateDate": "2024-07-26T19:16:03.1340603-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-07-26T19:16:03.1340603-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }