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. |
|
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": "1ad2aa5b-772c-4c74-af4c-418e72f52e90", "Asset": { "AssetId": "6cf83836-ec72-4d1a-b7b7-afccf7f75424", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "cd12ddd9-5af9-4042-add2-c8a3730b1c44", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "6d2512f9-0d0e-48d4-9418-68f097e753a9", "CreateDate": "2025-08-29T17:11:29.4143904-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-29T17:11:29.4143904-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "0d04d83e-bab8-4f9f-bca0-922b55afecfc", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-29T17:11:29.4143904-07:00", "MeasurementValueNeededDate": "2025-08-29T17:11:29.4143904-07:00", "SourceSystemId": "sample string 3", "CompanyId": "9366597b-3873-4b32-b08d-eaad0a560580", "CreateDate": "2025-08-29T17:11:29.4143904-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:11:29.4143904-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "d69046cf-4958-4181-a7ad-7971597fee6a", "EffectiveDate": "2025-08-29T17:11:29.4143904-07:00", "StateType": { "StateTypeId": "884792c2-cdd5-4cb9-af3c-30dbf00ab67b", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "cd12ddd9-5af9-4042-add2-c8a3730b1c44", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "6d2512f9-0d0e-48d4-9418-68f097e753a9", "CreateDate": "2025-08-29T17:11:29.4143904-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-29T17:11:29.4143904-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "7945a28e-f931-44ef-847c-7edbd26ad218", "CreateDate": "2025-08-29T17:11:29.4143904-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:11:29.4143904-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "14b3b9f8-1b9a-4a1b-9584-b97df535f5c4", "CreateDate": "2025-08-29T17:11:29.4143904-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-08-29T17:11:29.4143904-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "3e29ae51-dc39-4645-9a16-06b281f0db57", "EffectiveDate": "2025-08-29T17:11:29.4143904-07:00", "StatusType": { "StatusTypeId": "74f372b3-a773-4a26-b2d7-5b4bf7b0ff9a", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "cd12ddd9-5af9-4042-add2-c8a3730b1c44", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "6d2512f9-0d0e-48d4-9418-68f097e753a9", "CreateDate": "2025-08-29T17:11:29.4143904-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-29T17:11:29.4143904-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "8b277f92-ba9e-4dd9-9e37-49126398b9f8", "CreateDate": "2025-08-29T17:11:29.4143904-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-29T17:11:29.4143904-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "55d40207-f136-4dc3-b15e-e9def2d2a6b6", "CreateDate": "2025-08-29T17:11:29.4143904-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-08-29T17:11:29.4143904-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "b2d1d87e-0134-4dfe-ba13-77fa55b6f118", "EffectiveDate": "2025-08-29T17:11:29.4143904-07:00", "WellPurposeType": { "WellPurposeTypeId": "1920f787-5679-4159-9b7b-6d6a9c11fbd7", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "1019e9f6-8cd2-4d95-9f6b-faf557dd6105", "CreateDate": "2025-08-29T17:11:29.4143904-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-29T17:11:29.4143904-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "85c9dbfa-81fb-45d8-8318-c7c4da5dc8d6", "CreateDate": "2025-08-29T17:11:29.4143904-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-08-29T17:11:29.4143904-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-08-29T17:11:29.4143904-07:00", "MeasurementValueNeededDate": "2025-08-29T17:11:29.4143904-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "877a2167-8388-4ae1-b22f-b380a3c10f66", "CreateDate": "2025-08-29T17:11:29.4143904-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-29T17:11:29.4143904-07:00", "LastModifiedUser": "sample string 8" }, "OnBehalfOf": "sample string 1", "NoteCategory": { "NoteCategoryId": "3d38dea4-226a-4ce5-bfeb-8b12fad487f5", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "f3b92cf9-4efd-405f-8d5a-4b42f01c810b", "CreateDate": "2025-08-29T17:11:29.4143904-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-08-29T17:11:29.4143904-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2025-08-29T17:11:29.4143904-07:00", "NoteHTML": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "1da5adf3-c1da-4e23-92f0-09c52d3cc4aa", "CreateDate": "2025-08-29T17:11:29.4143904-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:11:29.4143904-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": "ed9e4686-1a23-4893-8313-1beb3ce7cd6d", "Asset": { "AssetId": "496313be-22ec-4a82-8907-8908d0d05a7a", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "7f608c0c-8498-4013-9a53-f6c1f159fdcf", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "147a4440-7e3a-4379-b664-3596b45a1249", "CreateDate": "2025-08-29T17:11:29.4300127-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-29T17:11:29.4300127-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "6f713370-a08d-4bbd-9267-39b140720c8d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-29T17:11:29.4300127-07:00", "MeasurementValueNeededDate": "2025-08-29T17:11:29.4300127-07:00", "SourceSystemId": "sample string 3", "CompanyId": "640df3bc-8414-4474-9312-2604871929ea", "CreateDate": "2025-08-29T17:11:29.4300127-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:11:29.4300127-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "4873d268-a3b4-483e-88b2-37558b15231a", "EffectiveDate": "2025-08-29T17:11:29.4300127-07:00", "StateType": { "StateTypeId": "3f2088b1-6e8f-4d96-afb5-817ba51135e7", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "7f608c0c-8498-4013-9a53-f6c1f159fdcf", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "147a4440-7e3a-4379-b664-3596b45a1249", "CreateDate": "2025-08-29T17:11:29.4300127-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-29T17:11:29.4300127-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "c207e872-9e55-4afc-92b1-de776a431364", "CreateDate": "2025-08-29T17:11:29.4300127-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:11:29.4300127-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "193c3426-651e-4eff-a5ed-664b549bd14a", "CreateDate": "2025-08-29T17:11:29.4300127-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-08-29T17:11:29.4300127-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "34eb1795-2efb-44a8-892e-fd0c40f83b3e", "EffectiveDate": "2025-08-29T17:11:29.4300127-07:00", "StatusType": { "StatusTypeId": "1ca4b796-b47d-48d4-94a4-d48effd8e638", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "7f608c0c-8498-4013-9a53-f6c1f159fdcf", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "147a4440-7e3a-4379-b664-3596b45a1249", "CreateDate": "2025-08-29T17:11:29.4300127-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-29T17:11:29.4300127-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "1e413dab-e62b-4e8f-b75b-ad49192a5a9a", "CreateDate": "2025-08-29T17:11:29.4300127-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-29T17:11:29.4300127-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "8482e81b-7b7c-4671-88bd-9cbddaba3930", "CreateDate": "2025-08-29T17:11:29.4300127-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-08-29T17:11:29.4300127-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "5b660fbd-d78e-4a29-8320-5f38c3f0c3ed", "EffectiveDate": "2025-08-29T17:11:29.4300127-07:00", "WellPurposeType": { "WellPurposeTypeId": "f6e5173b-dae4-4ee5-a4c7-d6831ebaffe6", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "683b9d2c-9ec7-40b9-b5f7-e41eff5ac182", "CreateDate": "2025-08-29T17:11:29.4300127-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-29T17:11:29.4300127-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "32441651-d42a-436a-8530-ffd159516a45", "CreateDate": "2025-08-29T17:11:29.4300127-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-08-29T17:11:29.4300127-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-08-29T17:11:29.4300127-07:00", "MeasurementValueNeededDate": "2025-08-29T17:11:29.4300127-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "d437e0df-c5d6-42f6-8303-9ac9441a5404", "CreateDate": "2025-08-29T17:11:29.4300127-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-29T17:11:29.4300127-07:00", "LastModifiedUser": "sample string 8" }, "OnBehalfOf": "sample string 1", "NoteCategory": { "NoteCategoryId": "c50f375c-e407-410c-8bd3-7c2f1070c5bd", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "6f0d3a68-97d0-4255-8a38-01c00b816d6f", "CreateDate": "2025-08-29T17:11:29.4300127-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-08-29T17:11:29.4300127-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2025-08-29T17:11:29.4300127-07:00", "NoteHTML": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "1b011f54-98f5-40fd-8dce-6c71d6a22b9b", "CreateDate": "2025-08-29T17:11:29.4300127-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:11:29.4300127-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }