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": "5630a622-eeb1-4de6-b2fe-a7f306b0f43b",
"Asset": {
"AssetId": "5516d6f0-04d7-454c-a210-1b792e78a58e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "25aa44d8-7aca-43d1-8c82-b235ac29e2e2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "bf18510f-f5d8-450d-aaa3-cbebfe8eeb87",
"CreateDate": "2026-04-07T00:21:08.5750903-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-07T00:21:08.5750903-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "9bc5ebe0-e8e9-4c46-aee7-bbc628816e98",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-07T00:21:08.5750903-07:00",
"MeasurementValueNeededDate": "2026-04-07T00:21:08.5750903-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "14bef3da-6e1b-48e4-b1af-cef9ebaefccb",
"CreateDate": "2026-04-07T00:21:08.5750903-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-07T00:21:08.5750903-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "a009b8f3-a499-4f71-bfb2-a2ef61cb11ab",
"EffectiveDate": "2026-04-07T00:21:08.5750903-07:00",
"StateType": {
"StateTypeId": "c3b6246e-5e75-4227-bafb-0f084ad1e27c",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "25aa44d8-7aca-43d1-8c82-b235ac29e2e2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "bf18510f-f5d8-450d-aaa3-cbebfe8eeb87",
"CreateDate": "2026-04-07T00:21:08.5750903-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-07T00:21:08.5750903-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "5f006624-383e-4ac1-8df7-429544740f38",
"CreateDate": "2026-04-07T00:21:08.5750903-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-07T00:21:08.5750903-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2259a3a6-0b52-4322-8777-c988853da906",
"CreateDate": "2026-04-07T00:21:08.5750903-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-07T00:21:08.5750903-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "8f2fa8ba-9488-408c-b085-ab21ed25c3fe",
"EffectiveDate": "2026-04-07T00:21:08.5750903-07:00",
"StatusType": {
"StatusTypeId": "db2604c3-b3c6-4c41-a56e-d4588d703887",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "25aa44d8-7aca-43d1-8c82-b235ac29e2e2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "bf18510f-f5d8-450d-aaa3-cbebfe8eeb87",
"CreateDate": "2026-04-07T00:21:08.5750903-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-07T00:21:08.5750903-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "a369d944-6144-4ce7-8454-348523eb6f02",
"CreateDate": "2026-04-07T00:21:08.5750903-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-07T00:21:08.5750903-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1f363ee0-a6a1-4194-a06b-17ea44ad84d1",
"CreateDate": "2026-04-07T00:21:08.5750903-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-07T00:21:08.5750903-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "cc072cdc-974a-4e1a-a7e2-be57e05ec338",
"EffectiveDate": "2026-04-07T00:21:08.5750903-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "1d05cc70-b78c-4ff0-bd3f-2d4e803cbbdd",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4a4052cd-117f-431f-bcd3-ff1b904bd0e5",
"CreateDate": "2026-04-07T00:21:08.5750903-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-07T00:21:08.5750903-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a2666fe0-dd61-486e-94d1-ad8343b5c8f2",
"CreateDate": "2026-04-07T00:21:08.5750903-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-07T00:21:08.5750903-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-04-07T00:21:08.5750903-07:00",
"MeasurementValueNeededDate": "2026-04-07T00:21:08.5750903-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "17d68788-35de-4940-9049-86081a2d5fad",
"CreateDate": "2026-04-07T00:21:08.5750903-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-07T00:21:08.5750903-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "f43ebe60-4af7-4b35-8949-e8da085ff408",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "69162d3e-ec96-4231-9996-bebbc0f48eee",
"CreateDate": "2026-04-07T00:21:08.5750903-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-07T00:21:08.5750903-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-04-07T00:21:08.5750903-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6762afcc-5e03-4ef9-8f64-c0cdbffe1728",
"CreateDate": "2026-04-07T00:21:08.5750903-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-07T00:21:08.5750903-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": "54f13933-907a-4aa1-9365-65e6a588112e",
"Asset": {
"AssetId": "2c5819e7-4f13-4962-8b10-1bcbc8535972",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "006fcb58-e530-42dd-9eeb-0d7ae31ff517",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4567b428-7b48-4700-8033-f0e900a22bc3",
"CreateDate": "2026-04-07T00:21:08.5750903-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-07T00:21:08.5750903-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "21844361-c39d-478b-883f-8fa0a2a0118e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-07T00:21:08.5750903-07:00",
"MeasurementValueNeededDate": "2026-04-07T00:21:08.5750903-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "89e7cc26-493c-4bb7-a21e-7b9ac483748d",
"CreateDate": "2026-04-07T00:21:08.5750903-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-07T00:21:08.5750903-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "a915ec59-3bbd-4031-8803-fb1e427c2f12",
"EffectiveDate": "2026-04-07T00:21:08.5750903-07:00",
"StateType": {
"StateTypeId": "0aed9b09-bf40-4e86-ad59-44736e67f27b",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "006fcb58-e530-42dd-9eeb-0d7ae31ff517",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4567b428-7b48-4700-8033-f0e900a22bc3",
"CreateDate": "2026-04-07T00:21:08.5750903-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-07T00:21:08.5750903-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "516cbf42-c85c-45f9-9d81-17dab0fb2cbc",
"CreateDate": "2026-04-07T00:21:08.5750903-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-07T00:21:08.5750903-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2cc8e1fe-9d25-4745-a193-f9187015a75c",
"CreateDate": "2026-04-07T00:21:08.5750903-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-07T00:21:08.5750903-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "1d940149-dcc3-4b05-b045-14c722e72212",
"EffectiveDate": "2026-04-07T00:21:08.5750903-07:00",
"StatusType": {
"StatusTypeId": "d7cd4876-df0d-401a-888a-ed995edbd79d",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "006fcb58-e530-42dd-9eeb-0d7ae31ff517",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4567b428-7b48-4700-8033-f0e900a22bc3",
"CreateDate": "2026-04-07T00:21:08.5750903-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-07T00:21:08.5750903-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "e4b2634f-00d3-4c44-be78-e97f68aab0bb",
"CreateDate": "2026-04-07T00:21:08.5750903-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-07T00:21:08.5750903-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "62476c5a-d9ed-4872-8aca-4fc4f831e0ac",
"CreateDate": "2026-04-07T00:21:08.5750903-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-07T00:21:08.5750903-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "5f5df00c-3e47-430e-aca7-05eea3473418",
"EffectiveDate": "2026-04-07T00:21:08.5750903-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "498ddfd6-7ba0-4463-9e39-4db1833a4d49",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e69d1d0a-421c-4ae5-b9f6-91d6378143d0",
"CreateDate": "2026-04-07T00:21:08.5750903-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-07T00:21:08.5750903-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "8cf8f578-df58-4bc1-a117-43ed6f07ef34",
"CreateDate": "2026-04-07T00:21:08.5750903-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-07T00:21:08.5750903-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-04-07T00:21:08.5750903-07:00",
"MeasurementValueNeededDate": "2026-04-07T00:21:08.5750903-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "1a1712c5-0c37-4f3c-b9bf-a2832e5dd787",
"CreateDate": "2026-04-07T00:21:08.5750903-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-07T00:21:08.5750903-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "74ff3b71-05db-488e-ba12-1469e65566a7",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "10947de3-595c-454a-9803-59f8854581ed",
"CreateDate": "2026-04-07T00:21:08.5750903-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-07T00:21:08.5750903-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-04-07T00:21:08.5750903-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6fd68486-10f8-4b4a-88d4-cd8622f7b8ef",
"CreateDate": "2026-04-07T00:21:08.5750903-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-07T00:21:08.5750903-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}