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": "f8cd26f8-1940-4d72-8349-d118301c1118",
"Asset": {
"AssetId": "69d2c949-684b-409c-9c71-13734472837a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2173463b-aebb-4a79-8840-64ecd50c159c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c660e108-c645-445f-8c73-1e5e9dd2776f",
"CreateDate": "2026-07-26T21:33:02.8884487-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-26T21:33:02.8884487-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "6695a144-4321-41fc-a252-0581dab2733a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-26T21:33:02.8884487-07:00",
"MeasurementValueNeededDate": "2026-07-26T21:33:02.8884487-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a8df399d-0af0-4ba2-88c3-0a06871cd1cf",
"CreateDate": "2026-07-26T21:33:02.8884487-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-26T21:33:02.8884487-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "564eb84f-c814-4c52-8c5e-5156fdca2c25",
"EffectiveDate": "2026-07-26T21:33:02.8884487-07:00",
"StateType": {
"StateTypeId": "628e7b6f-44f4-49ad-b1ea-ab18f15c17f5",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "2173463b-aebb-4a79-8840-64ecd50c159c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c660e108-c645-445f-8c73-1e5e9dd2776f",
"CreateDate": "2026-07-26T21:33:02.8884487-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-26T21:33:02.8884487-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "7d804f39-5417-45f3-8a1a-ee59b0b7fb5a",
"CreateDate": "2026-07-26T21:33:02.8884487-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-26T21:33:02.8884487-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3ae43188-2fa1-4f9c-bd6f-c3af2250376d",
"CreateDate": "2026-07-26T21:33:02.8884487-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-26T21:33:02.8884487-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "6d09897d-fa9d-4794-9b56-1ed98721ac1f",
"EffectiveDate": "2026-07-26T21:33:02.8884487-07:00",
"StatusType": {
"StatusTypeId": "41cc6a2d-e264-4765-b7a1-e2fa0c1fb301",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "2173463b-aebb-4a79-8840-64ecd50c159c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c660e108-c645-445f-8c73-1e5e9dd2776f",
"CreateDate": "2026-07-26T21:33:02.8884487-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-26T21:33:02.8884487-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "9c9b8c4e-0756-4b84-8ff2-4c150d354dac",
"CreateDate": "2026-07-26T21:33:02.8884487-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-26T21:33:02.8884487-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "7004bc30-a34c-49cf-8a2c-4f1ddffdd768",
"CreateDate": "2026-07-26T21:33:02.8884487-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-26T21:33:02.8884487-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "dbdd6c5f-dc7a-423c-a26f-f71ab5500951",
"EffectiveDate": "2026-07-26T21:33:02.8884487-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "08ba4fe1-16b7-4917-a2bf-3d843d0e1867",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "51ca5b01-1401-45d6-a34b-e248189e3220",
"CreateDate": "2026-07-26T21:33:02.8884487-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-26T21:33:02.8884487-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ad40ddb1-7ada-44b6-b8f4-47ef0d02f015",
"CreateDate": "2026-07-26T21:33:02.8884487-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-26T21:33:02.8884487-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-07-26T21:33:02.8884487-07:00",
"MeasurementValueNeededDate": "2026-07-26T21:33:02.8884487-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "7fb53921-c031-4beb-8011-d512349aacd5",
"CreateDate": "2026-07-26T21:33:02.8884487-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-26T21:33:02.8884487-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "eadfca3f-8b9b-4c89-b718-dedf076204f2",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c42519e3-a07f-4aab-9c2b-90042d75c585",
"CreateDate": "2026-07-26T21:33:02.8884487-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-07-26T21:33:02.8884487-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-07-26T21:33:02.8884487-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "038f3602-5beb-4b48-a5df-a43d3c7f27e0",
"CreateDate": "2026-07-26T21:33:02.8884487-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-26T21:33:02.8884487-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": "30935fc0-02fe-446d-a30e-6faeafa995de",
"Asset": {
"AssetId": "cd7a75de-520c-4986-815b-87cd25264828",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "8fd1188f-8260-43c2-a27c-40f42c8b3d00",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5605556d-35e1-4ed5-99c3-32670d1443a1",
"CreateDate": "2026-07-26T21:33:02.9041298-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-26T21:33:02.9041298-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "286ff671-7916-444e-8340-e47cf828eb81",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-26T21:33:02.9041298-07:00",
"MeasurementValueNeededDate": "2026-07-26T21:33:02.9041298-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9bddbf8e-8387-4983-9abe-aa70fb814cbb",
"CreateDate": "2026-07-26T21:33:02.9041298-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-26T21:33:02.9041298-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "33850a9c-a78e-42a3-bd1a-c8b332ca5ea4",
"EffectiveDate": "2026-07-26T21:33:02.9041298-07:00",
"StateType": {
"StateTypeId": "6d6d96e5-12f9-47ae-8987-2ebe96d079a1",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "8fd1188f-8260-43c2-a27c-40f42c8b3d00",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5605556d-35e1-4ed5-99c3-32670d1443a1",
"CreateDate": "2026-07-26T21:33:02.9041298-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-26T21:33:02.9041298-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "a4724337-3056-4720-b513-d77c484f082d",
"CreateDate": "2026-07-26T21:33:02.9041298-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-26T21:33:02.9041298-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "040c25c6-a87a-44dc-9a14-7d5095332600",
"CreateDate": "2026-07-26T21:33:02.9041298-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-26T21:33:02.9041298-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "1a3064b9-51a9-447b-be95-62be56b7dc03",
"EffectiveDate": "2026-07-26T21:33:02.9041298-07:00",
"StatusType": {
"StatusTypeId": "13fba63c-f8f2-426a-b15a-978b7135969b",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "8fd1188f-8260-43c2-a27c-40f42c8b3d00",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5605556d-35e1-4ed5-99c3-32670d1443a1",
"CreateDate": "2026-07-26T21:33:02.9041298-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-26T21:33:02.9041298-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "d47a8701-97ab-4d56-9b21-df3832eb36cc",
"CreateDate": "2026-07-26T21:33:02.9041298-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-26T21:33:02.9041298-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6531d222-9a86-4408-b7a4-9219c8739513",
"CreateDate": "2026-07-26T21:33:02.9041298-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-26T21:33:02.9041298-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "85da240b-2723-44b3-8840-0b19175958f6",
"EffectiveDate": "2026-07-26T21:33:02.9041298-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "eecb5199-be63-4d19-9519-13885ef5cd45",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "49a807d2-5529-41d0-b7b9-74897f5a8816",
"CreateDate": "2026-07-26T21:33:02.9041298-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-26T21:33:02.9041298-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6e631573-abf3-4c7c-85d6-3c0faab57c8c",
"CreateDate": "2026-07-26T21:33:02.9041298-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-26T21:33:02.9041298-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-07-26T21:33:02.9041298-07:00",
"MeasurementValueNeededDate": "2026-07-26T21:33:02.9041298-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "ad74b1fe-4b7f-44de-8978-c8f8c61a414a",
"CreateDate": "2026-07-26T21:33:02.9041298-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-26T21:33:02.9041298-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "107608cd-db06-4478-b22e-59d30ce21b57",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "ec014a91-b189-43bc-8fab-76a7c471d059",
"CreateDate": "2026-07-26T21:33:02.9041298-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-07-26T21:33:02.9041298-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-07-26T21:33:02.9041298-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "23980071-2af6-405b-a641-46e42eac5c9b",
"CreateDate": "2026-07-26T21:33:02.9041298-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-26T21:33:02.9041298-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}