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": "97b51735-b603-4df9-bc84-53026f9ba278",
"Asset": {
"AssetId": "7515e2de-4665-48ab-8d0a-b42ef8ced2d4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "8fd8da06-33e6-41dc-8302-0d4891f7c371",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "be660df8-cf15-405e-b010-2f324c2d66b4",
"CreateDate": "2026-03-27T01:31:38.7051394-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-27T01:31:38.7051394-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "e67be61b-59a0-4e15-afe9-f4cd621dd668",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-27T01:31:38.7051394-07:00",
"MeasurementValueNeededDate": "2026-03-27T01:31:38.7051394-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7c0b6ec6-61aa-472d-90e0-55ddf4d33260",
"CreateDate": "2026-03-27T01:31:38.7051394-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-27T01:31:38.7051394-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "543b7691-ea17-432b-aa41-2993e174f95e",
"EffectiveDate": "2026-03-27T01:31:38.7051394-07:00",
"StateType": {
"StateTypeId": "ff54ac28-f3cf-44cf-bc07-ba0dbad322d5",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "8fd8da06-33e6-41dc-8302-0d4891f7c371",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "be660df8-cf15-405e-b010-2f324c2d66b4",
"CreateDate": "2026-03-27T01:31:38.7051394-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-27T01:31:38.7051394-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "6e08505f-b664-4953-8f6b-ee06a301f7d1",
"CreateDate": "2026-03-27T01:31:38.7051394-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-27T01:31:38.7051394-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "8147fc03-783a-4b8a-bcd8-717ef008f2ba",
"CreateDate": "2026-03-27T01:31:38.7051394-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-27T01:31:38.7051394-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "b11050d5-c583-498a-8a9b-a49362a05dea",
"EffectiveDate": "2026-03-27T01:31:38.7051394-07:00",
"StatusType": {
"StatusTypeId": "44fd70c5-8ee3-4755-999d-d2e593929437",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "8fd8da06-33e6-41dc-8302-0d4891f7c371",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "be660df8-cf15-405e-b010-2f324c2d66b4",
"CreateDate": "2026-03-27T01:31:38.7051394-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-27T01:31:38.7051394-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "6621a612-e547-4b11-9cdc-4e27e99ff5b7",
"CreateDate": "2026-03-27T01:31:38.7051394-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-27T01:31:38.7051394-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "bfd9d174-34c9-4c9f-ab5d-b3910a09f4d9",
"CreateDate": "2026-03-27T01:31:38.7051394-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-27T01:31:38.7051394-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "7ad1f012-dfca-44d2-a6db-d24b1080192e",
"EffectiveDate": "2026-03-27T01:31:38.7051394-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "380e74c3-c85b-4bd1-bc31-d657796f1e3e",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "51b1cf98-982e-4539-bb7f-38ea507cd850",
"CreateDate": "2026-03-27T01:31:38.7051394-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-27T01:31:38.7051394-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4e17f9fa-e0cd-46f5-8590-2bd572128c5b",
"CreateDate": "2026-03-27T01:31:38.7051394-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-27T01:31:38.7051394-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-27T01:31:38.7051394-07:00",
"MeasurementValueNeededDate": "2026-03-27T01:31:38.7051394-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "859fb229-7003-4a7f-8490-48b346ddfd98",
"CreateDate": "2026-03-27T01:31:38.7051394-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-27T01:31:38.7051394-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "7c05a814-d617-4df6-93c8-dcc809f78ddb",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "aaf46724-91ad-483d-872c-5192b6254bf9",
"CreateDate": "2026-03-27T01:31:38.7051394-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-27T01:31:38.7051394-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-27T01:31:38.7051394-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ae8152e3-a78e-4e7c-b12a-8410ac40f445",
"CreateDate": "2026-03-27T01:31:38.7051394-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-27T01:31:38.7051394-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": "c30649ea-021f-4049-a9cc-13e90d782012",
"Asset": {
"AssetId": "1dc09ca1-1792-4fda-8fb5-286843e9f14c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "97cb63f5-ddf7-417e-a3b2-abf6e4b89f8d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5267e597-d56d-4869-80e6-bad85f072518",
"CreateDate": "2026-03-27T01:31:38.7051394-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-27T01:31:38.7051394-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "1db511e2-a77f-47ef-8bfd-d70e8ac697d4",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-27T01:31:38.7051394-07:00",
"MeasurementValueNeededDate": "2026-03-27T01:31:38.7051394-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "10ef97f6-bc4d-4f43-bf96-b2e9e9c0093d",
"CreateDate": "2026-03-27T01:31:38.7051394-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-27T01:31:38.7051394-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "fd35f6ed-f1a5-4351-a2d0-ad465bbb0302",
"EffectiveDate": "2026-03-27T01:31:38.7051394-07:00",
"StateType": {
"StateTypeId": "d89bad31-84eb-4d7d-a27d-be178aacc95e",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "97cb63f5-ddf7-417e-a3b2-abf6e4b89f8d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5267e597-d56d-4869-80e6-bad85f072518",
"CreateDate": "2026-03-27T01:31:38.7051394-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-27T01:31:38.7051394-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "4fe694a7-f7f5-4c2c-9810-dbbabaf34d07",
"CreateDate": "2026-03-27T01:31:38.7051394-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-27T01:31:38.7051394-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "606cace6-9f84-4b1f-92b5-ce2e4f4ad259",
"CreateDate": "2026-03-27T01:31:38.7051394-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-27T01:31:38.7051394-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "3d0ad774-488f-4d46-b6e7-ec7615e4ce47",
"EffectiveDate": "2026-03-27T01:31:38.7051394-07:00",
"StatusType": {
"StatusTypeId": "a6a24f73-40e2-4610-aaf5-ed5ecb2d772b",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "97cb63f5-ddf7-417e-a3b2-abf6e4b89f8d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5267e597-d56d-4869-80e6-bad85f072518",
"CreateDate": "2026-03-27T01:31:38.7051394-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-27T01:31:38.7051394-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "fb734b35-c4ac-4e9f-91df-7efd91f0d8a7",
"CreateDate": "2026-03-27T01:31:38.7051394-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-27T01:31:38.7051394-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5c2c8d07-e9cd-4d82-8b8f-92c72843b5f3",
"CreateDate": "2026-03-27T01:31:38.7051394-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-27T01:31:38.7051394-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "d3198585-5c1e-40f3-b9cd-e1d8e5006560",
"EffectiveDate": "2026-03-27T01:31:38.7051394-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "42b83d8d-2ffa-40a9-8bed-e12d6d507b5e",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "845b2383-ef4f-4952-bbdc-76d59aa13eaf",
"CreateDate": "2026-03-27T01:31:38.7051394-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-27T01:31:38.7051394-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c89c1f33-1b90-4cfd-8d57-188b3931177e",
"CreateDate": "2026-03-27T01:31:38.7051394-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-27T01:31:38.7051394-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-27T01:31:38.7051394-07:00",
"MeasurementValueNeededDate": "2026-03-27T01:31:38.7051394-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "87b66fad-9671-43cd-8427-73dc9dcddfa5",
"CreateDate": "2026-03-27T01:31:38.7051394-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-27T01:31:38.7051394-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "af5d158b-c87a-4b63-aa50-cc54c2a3a379",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "df4a03f5-8c63-4fe8-9912-4c4f85e57294",
"CreateDate": "2026-03-27T01:31:38.7051394-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-27T01:31:38.7051394-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-27T01:31:38.7051394-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0fe949a0-3371-490a-aea5-c0ba1914cb08",
"CreateDate": "2026-03-27T01:31:38.7051394-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-27T01:31:38.7051394-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}