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": "e83f1642-741e-4e7a-999d-21be8a9eb929",
"Asset": {
"AssetId": "f808b2e7-3902-4de0-b3ff-9b0b2b667ff1",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "44b6996d-1fd9-4e07-83db-b4dee2f9b635",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "86e87654-cc38-4efa-b4d3-75b970fcdfc6",
"CreateDate": "2025-11-04T16:36:50.0399263-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T16:36:50.0399263-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "3d04c605-1cce-400a-a851-f4d55147e784",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-04T16:36:50.0399263-08:00",
"MeasurementValueNeededDate": "2025-11-04T16:36:50.0399263-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "28101382-e7bb-4e6d-9576-b6a540044157",
"CreateDate": "2025-11-04T16:36:50.0399263-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T16:36:50.0399263-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "c8246f1f-729f-413e-9a12-f79c16fdc13e",
"EffectiveDate": "2025-11-04T16:36:50.0399263-08:00",
"StateType": {
"StateTypeId": "a4b9eca1-3aba-4327-befb-266ca5776c1c",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "44b6996d-1fd9-4e07-83db-b4dee2f9b635",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "86e87654-cc38-4efa-b4d3-75b970fcdfc6",
"CreateDate": "2025-11-04T16:36:50.0399263-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T16:36:50.0399263-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "c05c847f-4f6c-4f50-aa3b-7bde0d08d63c",
"CreateDate": "2025-11-04T16:36:50.0399263-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T16:36:50.0399263-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0537a539-96ee-415e-8ec5-895985ab4940",
"CreateDate": "2025-11-04T16:36:50.0399263-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-04T16:36:50.0399263-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "9d91dc47-d012-49f7-a94f-73143c1cbf63",
"EffectiveDate": "2025-11-04T16:36:50.0399263-08:00",
"StatusType": {
"StatusTypeId": "e0b1bcc8-b2c7-4b2e-8e9d-97e4068f4710",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "44b6996d-1fd9-4e07-83db-b4dee2f9b635",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "86e87654-cc38-4efa-b4d3-75b970fcdfc6",
"CreateDate": "2025-11-04T16:36:50.0399263-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T16:36:50.0399263-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "2666527c-2551-40dd-b785-5906937523bd",
"CreateDate": "2025-11-04T16:36:50.0399263-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-04T16:36:50.0399263-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6bfe02ef-0ca3-48c5-b492-1714d882733d",
"CreateDate": "2025-11-04T16:36:50.0399263-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-04T16:36:50.0399263-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "6c6f7425-b5c0-40a5-bf01-b2bb4c1d0491",
"EffectiveDate": "2025-11-04T16:36:50.0399263-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "1b0f7ec9-9386-4f27-b01c-9b14905524b2",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c1afeba1-c14d-4afc-a6a2-118147d0fc90",
"CreateDate": "2025-11-04T16:36:50.0399263-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-04T16:36:50.0399263-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1db0a1ae-7cba-44d5-875e-f1aedcb50271",
"CreateDate": "2025-11-04T16:36:50.0399263-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-04T16:36:50.0399263-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-11-04T16:36:50.0399263-08:00",
"MeasurementValueNeededDate": "2025-11-04T16:36:50.0399263-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "20e46738-9247-4bf6-93df-600ab976d597",
"CreateDate": "2025-11-04T16:36:50.0399263-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T16:36:50.0399263-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "c08fb9f8-de09-44b2-920f-e3c1b537bbbd",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "164c05ad-013c-4c3f-863d-688d35f0a324",
"CreateDate": "2025-11-04T16:36:50.0399263-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-04T16:36:50.0399263-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-11-04T16:36:50.0399263-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "522003e8-2f63-413f-9117-6fe02812a385",
"CreateDate": "2025-11-04T16:36:50.0399263-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T16:36:50.0399263-08: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": "99a2b376-aaa0-4e33-a91b-4f4cd99c056e",
"Asset": {
"AssetId": "b2ac127c-678b-4898-b5e4-cde854b81498",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "25d3a50a-a2f1-49ce-b0e1-d06703b152ed",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "28aae65a-5d3d-42b5-add0-35d21debed34",
"CreateDate": "2025-11-04T16:36:50.0399263-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T16:36:50.0399263-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "785baebe-277a-456b-9e0a-54a5bae79eb9",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-04T16:36:50.0399263-08:00",
"MeasurementValueNeededDate": "2025-11-04T16:36:50.0399263-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "6455d910-09f6-42e4-b598-adf8ca7b88d8",
"CreateDate": "2025-11-04T16:36:50.0399263-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T16:36:50.0399263-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "337d5183-61b4-4f8e-86db-ab92bcd52b08",
"EffectiveDate": "2025-11-04T16:36:50.0399263-08:00",
"StateType": {
"StateTypeId": "4b67ee32-c8e0-4e1d-bc9f-1d832727800f",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "25d3a50a-a2f1-49ce-b0e1-d06703b152ed",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "28aae65a-5d3d-42b5-add0-35d21debed34",
"CreateDate": "2025-11-04T16:36:50.0399263-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T16:36:50.0399263-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "c68e1dd1-d197-4299-ade2-8706ab19d221",
"CreateDate": "2025-11-04T16:36:50.0399263-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T16:36:50.0399263-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "714dcfdd-b7bc-4e58-9da1-8ad12eeb4a59",
"CreateDate": "2025-11-04T16:36:50.0399263-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-04T16:36:50.0399263-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "dcdfb2bd-6100-4b3d-baec-ba363cb38772",
"EffectiveDate": "2025-11-04T16:36:50.0399263-08:00",
"StatusType": {
"StatusTypeId": "36f3719f-c34b-4cc0-ae3c-7aacfdc49921",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "25d3a50a-a2f1-49ce-b0e1-d06703b152ed",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "28aae65a-5d3d-42b5-add0-35d21debed34",
"CreateDate": "2025-11-04T16:36:50.0399263-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T16:36:50.0399263-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "a87fa326-4876-4073-9feb-822217ae00e6",
"CreateDate": "2025-11-04T16:36:50.0399263-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-04T16:36:50.0399263-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "59e85f13-095b-4970-b5cc-8e75c5a0927d",
"CreateDate": "2025-11-04T16:36:50.0399263-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-04T16:36:50.0399263-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "4b898837-af99-40ca-a8c2-ada46f2f719b",
"EffectiveDate": "2025-11-04T16:36:50.0399263-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "5f2bb3bd-e9c6-474e-85c2-b28a683ffbec",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "711a6c34-a8c3-480f-95f3-5e18ce3f00ee",
"CreateDate": "2025-11-04T16:36:50.0399263-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-04T16:36:50.0399263-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d8fc9f1c-1086-40f7-ae34-7723cc679474",
"CreateDate": "2025-11-04T16:36:50.0399263-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-04T16:36:50.0399263-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-11-04T16:36:50.0399263-08:00",
"MeasurementValueNeededDate": "2025-11-04T16:36:50.0399263-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "3f16e7f4-bf3f-4c80-8567-1a7ba198e155",
"CreateDate": "2025-11-04T16:36:50.0399263-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T16:36:50.0399263-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "097c3334-61d9-4be0-96d9-acd655289322",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1cea298f-01b5-40b1-91dd-a2080f22ca76",
"CreateDate": "2025-11-04T16:36:50.0399263-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-04T16:36:50.0399263-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-11-04T16:36:50.0399263-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "64f3e5cf-b8a7-495f-8df0-4ceccce18549",
"CreateDate": "2025-11-04T16:36:50.0399263-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T16:36:50.0399263-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}