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": "12e4ff71-9aa9-41ea-96f4-de6ffeb22318",
"Asset": {
"AssetId": "59ad6813-4b56-4a5a-86fb-a420ef92f641",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1485eec9-1ca2-4a3c-8bbd-0c6c92d237af",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8518dfed-08f7-44e5-acad-eee4017088f1",
"CreateDate": "2025-06-02T14:46:27.0170411-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-02T14:46:27.0170411-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "3c765c0e-5191-4d87-be26-7ed784c26e92",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-02T14:46:27.0170411-07:00",
"MeasurementValueNeededDate": "2025-06-02T14:46:27.0170411-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a77d00e0-1705-49e2-8a23-379efa1e8d1c",
"CreateDate": "2025-06-02T14:46:27.0170411-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-02T14:46:27.0170411-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "f70ccf2d-fdad-4ecc-b2da-6fc486bc7607",
"EffectiveDate": "2025-06-02T14:46:27.0170411-07:00",
"StateType": {
"StateTypeId": "3f0cebe9-c4a8-4ad2-9d44-6143022418c3",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "1485eec9-1ca2-4a3c-8bbd-0c6c92d237af",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8518dfed-08f7-44e5-acad-eee4017088f1",
"CreateDate": "2025-06-02T14:46:27.0170411-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-02T14:46:27.0170411-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "3f225262-69a8-4b59-9f3d-b6d966883c10",
"CreateDate": "2025-06-02T14:46:27.0170411-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-02T14:46:27.0170411-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "093bb2a4-54f1-461b-baf9-71d4e5590fd3",
"CreateDate": "2025-06-02T14:46:27.0170411-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-02T14:46:27.0170411-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "dac4c172-067a-43d5-906c-80f830ddf0ba",
"EffectiveDate": "2025-06-02T14:46:27.0170411-07:00",
"StatusType": {
"StatusTypeId": "49a37487-6ef3-4a39-89da-ec3d14353eb2",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "1485eec9-1ca2-4a3c-8bbd-0c6c92d237af",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8518dfed-08f7-44e5-acad-eee4017088f1",
"CreateDate": "2025-06-02T14:46:27.0170411-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-02T14:46:27.0170411-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "f79c3eea-9851-4fea-9dcf-29271b454973",
"CreateDate": "2025-06-02T14:46:27.0170411-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-02T14:46:27.0170411-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "be930fb6-f46d-43c0-92a3-72f19c9404ee",
"CreateDate": "2025-06-02T14:46:27.0170411-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-02T14:46:27.0170411-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "08e0d9fc-f9bc-443e-a7f5-7d76d95ded04",
"EffectiveDate": "2025-06-02T14:46:27.0170411-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "8bf290f0-9969-45a6-b6db-65c4af95f52b",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f2376224-3d72-4ac6-b62a-88115a78c3ce",
"CreateDate": "2025-06-02T14:46:27.0170411-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-02T14:46:27.0170411-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c889ee32-458d-448a-81e3-01cfa7d85b76",
"CreateDate": "2025-06-02T14:46:27.0170411-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-02T14:46:27.0170411-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-06-02T14:46:27.0170411-07:00",
"MeasurementValueNeededDate": "2025-06-02T14:46:27.0170411-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "a119daef-cbc0-4df0-ae27-bd0f7e93a0cb",
"CreateDate": "2025-06-02T14:46:27.0170411-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-02T14:46:27.0170411-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "a341b28d-ebef-4433-8def-0632bbb5916a",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e83fbfab-2bcb-434f-bf41-e793b0c8140c",
"CreateDate": "2025-06-02T14:46:27.0170411-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-02T14:46:27.0170411-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-02T14:46:27.0170411-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f5b9b2de-df4b-4508-a93e-c8cbfab16378",
"CreateDate": "2025-06-02T14:46:27.0170411-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-02T14:46:27.0170411-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": "6aa74d39-6c8c-4134-bfd4-69e6605eee63",
"Asset": {
"AssetId": "7a33926f-12dd-408a-a3ae-ef4f22fe2dca",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "4524dd10-71ab-41df-aba5-64f74202b747",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5905a101-31cb-46ae-9673-1b8d44ceba74",
"CreateDate": "2025-06-02T14:46:27.0170411-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-02T14:46:27.0170411-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "d4a7e90a-e47b-44bb-acce-ff4095b2c276",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-02T14:46:27.0170411-07:00",
"MeasurementValueNeededDate": "2025-06-02T14:46:27.0170411-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "725528fe-3e4e-4cc6-b701-0a09c494c9e4",
"CreateDate": "2025-06-02T14:46:27.0170411-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-02T14:46:27.0170411-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "8dd8aeb9-b1f5-4de6-9eeb-e7f798b4b31d",
"EffectiveDate": "2025-06-02T14:46:27.0170411-07:00",
"StateType": {
"StateTypeId": "9eadf5e3-9e85-4dc3-aff3-61a857b176ec",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "4524dd10-71ab-41df-aba5-64f74202b747",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5905a101-31cb-46ae-9673-1b8d44ceba74",
"CreateDate": "2025-06-02T14:46:27.0170411-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-02T14:46:27.0170411-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "84378dc9-63f6-43d7-b87e-4a893fbfe906",
"CreateDate": "2025-06-02T14:46:27.0170411-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-02T14:46:27.0170411-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "edb93a21-9aef-42c9-81ce-96e2a500e041",
"CreateDate": "2025-06-02T14:46:27.0170411-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-02T14:46:27.0170411-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "79a2bd1e-134f-4c31-b9e5-e82c5f6eda7b",
"EffectiveDate": "2025-06-02T14:46:27.0170411-07:00",
"StatusType": {
"StatusTypeId": "bb91df53-3f79-4411-b2b5-558e9df47b0a",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "4524dd10-71ab-41df-aba5-64f74202b747",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5905a101-31cb-46ae-9673-1b8d44ceba74",
"CreateDate": "2025-06-02T14:46:27.0170411-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-02T14:46:27.0170411-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "afde6374-003d-45c8-a346-ffc2a955a97c",
"CreateDate": "2025-06-02T14:46:27.0170411-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-02T14:46:27.0170411-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "36d98232-b51e-4a97-b445-befd00afb1d9",
"CreateDate": "2025-06-02T14:46:27.0170411-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-02T14:46:27.0170411-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "04549c99-bfa7-46b9-8d38-92025695fe96",
"EffectiveDate": "2025-06-02T14:46:27.0170411-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "19aa93ec-9e84-4de9-89d8-6447f3f906c0",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b4d89f01-d890-492e-ab9c-91be9a363e22",
"CreateDate": "2025-06-02T14:46:27.0170411-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-02T14:46:27.0170411-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "32d937da-4013-4312-9223-7621e79ae680",
"CreateDate": "2025-06-02T14:46:27.0170411-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-02T14:46:27.0170411-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-06-02T14:46:27.0170411-07:00",
"MeasurementValueNeededDate": "2025-06-02T14:46:27.0170411-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6f70e173-7ce9-4920-ad8d-225784f04134",
"CreateDate": "2025-06-02T14:46:27.0170411-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-02T14:46:27.0170411-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "e0427214-83cf-4468-b2f7-469a58185e71",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e083ade3-7c3c-48af-a44f-189dadb007f2",
"CreateDate": "2025-06-02T14:46:27.0170411-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-02T14:46:27.0170411-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-02T14:46:27.0170411-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f5ec41da-996e-46bf-9521-92050b76ab37",
"CreateDate": "2025-06-02T14:46:27.0170411-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-02T14:46:27.0170411-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}