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": "b5c80bd8-5446-4fc1-90cb-c3b938eb7af1",
"Asset": {
"AssetId": "674af1a8-47d4-4a2c-994d-ffa9f8cfd225",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "6a744af8-c973-490c-a269-9df8bb179f34",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "da4f696e-2098-441d-8261-3d589d09fefd",
"CreateDate": "2025-09-17T07:52:49.4953832-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-17T07:52:49.4953832-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "0a736cce-be59-48b9-8e51-5f9c810b437f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-09-17T07:52:49.4953832-07:00",
"MeasurementValueNeededDate": "2025-09-17T07:52:49.4953832-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "40d5a5d9-01c3-4114-8fb2-9a02d1d31ce1",
"CreateDate": "2025-09-17T07:52:49.4953832-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-17T07:52:49.4953832-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "a096b128-8600-4892-ba96-5410c82eefc6",
"EffectiveDate": "2025-09-17T07:52:49.4953832-07:00",
"StateType": {
"StateTypeId": "36afafdd-03bd-4a8d-8196-bf38fa79bb7f",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "6a744af8-c973-490c-a269-9df8bb179f34",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "da4f696e-2098-441d-8261-3d589d09fefd",
"CreateDate": "2025-09-17T07:52:49.4953832-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-17T07:52:49.4953832-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "e1767dc1-e94e-42ec-b8a9-2e39c1fd510f",
"CreateDate": "2025-09-17T07:52:49.4953832-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-17T07:52:49.4953832-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "26b3c819-6caa-4c9a-a4ef-e4113e255df6",
"CreateDate": "2025-09-17T07:52:49.4953832-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-09-17T07:52:49.4953832-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "c2d607ba-31a2-4560-8c06-cd3812079e1f",
"EffectiveDate": "2025-09-17T07:52:49.4953832-07:00",
"StatusType": {
"StatusTypeId": "e0cdc901-bd85-4d79-80ab-44781300e815",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "6a744af8-c973-490c-a269-9df8bb179f34",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "da4f696e-2098-441d-8261-3d589d09fefd",
"CreateDate": "2025-09-17T07:52:49.4953832-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-17T07:52:49.4953832-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "b16475b2-24b7-4279-ad7a-f44abe6c5a1d",
"CreateDate": "2025-09-17T07:52:49.4953832-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-09-17T07:52:49.4953832-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "bff7bc5d-b2ab-435c-a424-3b94fe50587c",
"CreateDate": "2025-09-17T07:52:49.4953832-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-09-17T07:52:49.4953832-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "8a40d58b-47a8-4ca4-97d6-e7158d89f19f",
"EffectiveDate": "2025-09-17T07:52:49.4953832-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "5d545141-64bb-427e-9640-f5ea1a239f0e",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "8025d53d-440d-4f05-a1ab-ac313ce2ae36",
"CreateDate": "2025-09-17T07:52:49.4953832-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-09-17T07:52:49.4953832-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "185d3402-5412-4df3-9e13-2957e1b2e5aa",
"CreateDate": "2025-09-17T07:52:49.4953832-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-09-17T07:52:49.4953832-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-09-17T07:52:49.4953832-07:00",
"MeasurementValueNeededDate": "2025-09-17T07:52:49.4953832-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "305b5920-c062-4363-8162-6164da50cffd",
"CreateDate": "2025-09-17T07:52:49.4953832-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-17T07:52:49.4953832-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "a7f63b5c-2008-41a6-ba32-f43eea633712",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "dbd04215-5239-4653-84fa-e78b17039411",
"CreateDate": "2025-09-17T07:52:49.4953832-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-09-17T07:52:49.4953832-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-09-17T07:52:49.4953832-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "98839194-7a22-4629-8de1-0b1ea89fd80c",
"CreateDate": "2025-09-17T07:52:49.4953832-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-17T07:52:49.4953832-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": "02182ec6-432b-40e0-a284-0a4e011b80dd",
"Asset": {
"AssetId": "243226c9-0e2c-43c9-b5f6-af90f8700a57",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ba6b0df9-e68c-47d8-aaec-fe5550fe06a4",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7574dd74-ecab-4fe5-9e46-e7e54d76b803",
"CreateDate": "2025-09-17T07:52:49.4953832-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-17T07:52:49.4953832-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "095e18e5-d91c-40f2-bc3f-c75eb37218bc",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-09-17T07:52:49.4953832-07:00",
"MeasurementValueNeededDate": "2025-09-17T07:52:49.4953832-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9183dd65-d994-4685-9c20-8d14d1ffdf93",
"CreateDate": "2025-09-17T07:52:49.4953832-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-17T07:52:49.4953832-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "8d4708e9-f1ab-4db3-afb3-717a7eb6c7da",
"EffectiveDate": "2025-09-17T07:52:49.4953832-07:00",
"StateType": {
"StateTypeId": "c2eff2f1-7d7d-48a1-ae9e-1c797699d338",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "ba6b0df9-e68c-47d8-aaec-fe5550fe06a4",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7574dd74-ecab-4fe5-9e46-e7e54d76b803",
"CreateDate": "2025-09-17T07:52:49.4953832-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-17T07:52:49.4953832-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "077e5fcf-aa98-4f75-bd05-4207a162000f",
"CreateDate": "2025-09-17T07:52:49.4953832-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-17T07:52:49.4953832-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e88e457a-f32b-4fa1-879b-8e9cbb80c472",
"CreateDate": "2025-09-17T07:52:49.4953832-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-09-17T07:52:49.4953832-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "e6489e49-3d94-4c3c-96c4-3ead99d2e4af",
"EffectiveDate": "2025-09-17T07:52:49.4953832-07:00",
"StatusType": {
"StatusTypeId": "6d53d4ad-6b09-46c1-8d12-a1a4cc60e933",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "ba6b0df9-e68c-47d8-aaec-fe5550fe06a4",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7574dd74-ecab-4fe5-9e46-e7e54d76b803",
"CreateDate": "2025-09-17T07:52:49.4953832-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-17T07:52:49.4953832-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "dd824ebe-3754-4fc5-8f14-28d9d19c80b0",
"CreateDate": "2025-09-17T07:52:49.4953832-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-09-17T07:52:49.4953832-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a95195f4-5579-4ca3-ad4c-ebb8b507e75a",
"CreateDate": "2025-09-17T07:52:49.4953832-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-09-17T07:52:49.4953832-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "9f31bcca-c89f-488c-b1cb-e650566e7041",
"EffectiveDate": "2025-09-17T07:52:49.4953832-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "60e522d7-e0cb-452b-be42-80a15c6a9051",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0f7e2adb-4332-4384-81cc-ac184f2dc5a9",
"CreateDate": "2025-09-17T07:52:49.4953832-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-09-17T07:52:49.4953832-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5b2c0b60-a8e4-4df6-b35a-3c76144cffa2",
"CreateDate": "2025-09-17T07:52:49.4953832-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-09-17T07:52:49.4953832-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-09-17T07:52:49.4953832-07:00",
"MeasurementValueNeededDate": "2025-09-17T07:52:49.4953832-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6154887e-5429-49d2-967b-992190308ec6",
"CreateDate": "2025-09-17T07:52:49.4953832-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-17T07:52:49.4953832-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "c6d4f2e9-1f56-4f40-b185-65c48cc45d43",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c81f123a-d9ed-4699-8859-e2db9ca38efa",
"CreateDate": "2025-09-17T07:52:49.4953832-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-09-17T07:52:49.4953832-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-09-17T07:52:49.4953832-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "3449ed10-6207-43f1-870c-279ba4d35f9a",
"CreateDate": "2025-09-17T07:52:49.4953832-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-17T07:52:49.4953832-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}