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": "7e274519-d59f-4113-9a0f-1a688d570ccb",
"Asset": {
"AssetId": "1faa92a4-6fb5-408b-a738-656d6361e275",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "0fa6dfb3-0a72-43b9-8a92-e8923972f66b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "caa6e39f-e36e-49bc-8dd6-76144b147df6",
"CreateDate": "2026-09-28T06:37:46.1343158-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-28T06:37:46.1343158-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "9a341b22-39fe-4baa-9d97-3b4c1defdb38",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-28T06:37:46.1343158-07:00",
"MeasurementValueNeededDate": "2026-09-28T06:37:46.1343158-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "4ef626fc-9a5a-4660-abca-610ec401f843",
"CreateDate": "2026-09-28T06:37:46.1343158-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-28T06:37:46.1343158-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "d3f543e5-f179-4740-896a-fa814f95c81b",
"EffectiveDate": "2026-09-28T06:37:46.1343158-07:00",
"StateType": {
"StateTypeId": "8126a48d-fa31-4fdf-b947-8572ecfe4fd2",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "0fa6dfb3-0a72-43b9-8a92-e8923972f66b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "caa6e39f-e36e-49bc-8dd6-76144b147df6",
"CreateDate": "2026-09-28T06:37:46.1343158-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-28T06:37:46.1343158-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "81961b73-bd97-469b-b1ad-265440808ae3",
"CreateDate": "2026-09-28T06:37:46.1343158-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-28T06:37:46.1343158-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "72c43a9e-075f-4fe8-b8a3-ab398fdbb9f7",
"CreateDate": "2026-09-28T06:37:46.1343158-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-28T06:37:46.1343158-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "2cb08c82-c44b-4395-8cc1-687751d9538a",
"EffectiveDate": "2026-09-28T06:37:46.1343158-07:00",
"StatusType": {
"StatusTypeId": "4055a7e1-0000-4bc1-96c6-b0b788ba6444",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "0fa6dfb3-0a72-43b9-8a92-e8923972f66b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "caa6e39f-e36e-49bc-8dd6-76144b147df6",
"CreateDate": "2026-09-28T06:37:46.1343158-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-28T06:37:46.1343158-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "12ce068e-04b8-4c20-b558-919b9cf910ed",
"CreateDate": "2026-09-28T06:37:46.1343158-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-28T06:37:46.1343158-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "8ec708ca-b87b-4845-9b92-04741966ab0b",
"CreateDate": "2026-09-28T06:37:46.1343158-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-28T06:37:46.1343158-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "59601261-f05d-4ef0-9533-29c80bdc16ba",
"EffectiveDate": "2026-09-28T06:37:46.1343158-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "49cf947b-28ff-4ec3-87ec-50558e793da5",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "5536a44a-e298-4300-b728-2ad42b73a672",
"CreateDate": "2026-09-28T06:37:46.1343158-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-28T06:37:46.1343158-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4b2acaf6-18a2-4ca2-9452-9aeedb53d3e6",
"CreateDate": "2026-09-28T06:37:46.1343158-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-28T06:37:46.1343158-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-09-28T06:37:46.1343158-07:00",
"MeasurementValueNeededDate": "2026-09-28T06:37:46.1343158-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "503c5d25-85b8-4106-a29d-cf645832d43a",
"CreateDate": "2026-09-28T06:37:46.1343158-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-28T06:37:46.1343158-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "71fc38df-1b46-46d5-9388-ecc05aca1d1d",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "728eae2e-beae-4ab4-b58d-d3f2d0c03b11",
"CreateDate": "2026-09-28T06:37:46.1343158-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-28T06:37:46.1343158-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-28T06:37:46.1343158-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1258fef9-6cd6-448a-b2cc-53065e98199c",
"CreateDate": "2026-09-28T06:37:46.1343158-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-28T06:37:46.1343158-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": "7da860c7-86d1-4d57-a374-c53f6d3026d1",
"Asset": {
"AssetId": "1772f0c0-5e97-480f-9940-634444d6c2b1",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "73556aba-45f3-4a97-b7e6-e3dd54f8b8a6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e04df480-63eb-43ef-95ec-7cc19519ebf2",
"CreateDate": "2026-09-28T06:37:46.1343158-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-28T06:37:46.1343158-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "a2ce087c-324b-4276-ac6c-dc0f8d091802",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-28T06:37:46.1343158-07:00",
"MeasurementValueNeededDate": "2026-09-28T06:37:46.1343158-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ac15b7b4-debc-418d-8c4c-c64fc4881022",
"CreateDate": "2026-09-28T06:37:46.1343158-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-28T06:37:46.1343158-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "08eaa899-0eeb-493e-a211-f551bae27ce0",
"EffectiveDate": "2026-09-28T06:37:46.1343158-07:00",
"StateType": {
"StateTypeId": "3352a079-d3d8-4207-8d73-9d6b5fff9f54",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "73556aba-45f3-4a97-b7e6-e3dd54f8b8a6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e04df480-63eb-43ef-95ec-7cc19519ebf2",
"CreateDate": "2026-09-28T06:37:46.1343158-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-28T06:37:46.1343158-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "e94065c9-f057-499a-a3df-3ea0f2cda295",
"CreateDate": "2026-09-28T06:37:46.1343158-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-28T06:37:46.1343158-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "dad894f2-aa87-4f98-ab48-f0a6b03f1b3c",
"CreateDate": "2026-09-28T06:37:46.1343158-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-28T06:37:46.1343158-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "21fd7487-2348-4143-a4a5-fbd3f3b3d1fb",
"EffectiveDate": "2026-09-28T06:37:46.1343158-07:00",
"StatusType": {
"StatusTypeId": "2bd94fdf-b43f-42e3-afc2-2d92fce4e91f",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "73556aba-45f3-4a97-b7e6-e3dd54f8b8a6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e04df480-63eb-43ef-95ec-7cc19519ebf2",
"CreateDate": "2026-09-28T06:37:46.1343158-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-28T06:37:46.1343158-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "44176900-1f11-4f10-9d60-a87713a7a802",
"CreateDate": "2026-09-28T06:37:46.1343158-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-28T06:37:46.1343158-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "38cf1ce0-330a-4ef3-88b4-9f2cefca0028",
"CreateDate": "2026-09-28T06:37:46.1343158-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-28T06:37:46.1343158-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "5647c595-2511-44e7-9e91-bb043a0abaef",
"EffectiveDate": "2026-09-28T06:37:46.1343158-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "7d1877ed-2b3d-4f6e-bb33-e767a7b8a661",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ed3755cd-ceeb-476d-9095-9ae82e103d02",
"CreateDate": "2026-09-28T06:37:46.1343158-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-28T06:37:46.1343158-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "59870f7b-9a16-4b4f-b0a4-508cf746f232",
"CreateDate": "2026-09-28T06:37:46.1343158-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-28T06:37:46.1343158-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-09-28T06:37:46.1343158-07:00",
"MeasurementValueNeededDate": "2026-09-28T06:37:46.1343158-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d2fb09bd-6d32-471f-89f2-a0f9d2e9030a",
"CreateDate": "2026-09-28T06:37:46.1343158-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-28T06:37:46.1343158-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "9248a519-c178-4a00-8421-8c72801ee7c4",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "2a2169f1-210e-4b1d-aad5-8dbff5e45a3f",
"CreateDate": "2026-09-28T06:37:46.1343158-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-28T06:37:46.1343158-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-28T06:37:46.1343158-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "4ddc3e01-ef82-4b15-bbf2-b42bcbaff247",
"CreateDate": "2026-09-28T06:37:46.1343158-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-28T06:37:46.1343158-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}