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": "1b5232a0-7f61-4860-88fc-ef284b4bfda6",
"Asset": {
"AssetId": "887746d7-5dd3-4201-a795-7dbd73f58d58",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a6779d4f-a563-45c9-ae32-ec5a22db9a06",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0f9cae99-541e-4d32-91da-a115fa19fdca",
"CreateDate": "2026-04-21T00:00:11.9104265-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-21T00:00:11.9104265-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "67f95572-1a4d-4d24-b29f-e8c0d4b22877",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-21T00:00:11.9104265-07:00",
"MeasurementValueNeededDate": "2026-04-21T00:00:11.9104265-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "25cb8ce5-d58d-4633-9c06-d442fdb4c696",
"CreateDate": "2026-04-21T00:00:11.9104265-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-21T00:00:11.9104265-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "a9ade296-1de1-495e-bc31-4d91bee68c86",
"EffectiveDate": "2026-04-21T00:00:11.9104265-07:00",
"StateType": {
"StateTypeId": "199feea1-3f70-4e08-acca-be25a4e47c1a",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "a6779d4f-a563-45c9-ae32-ec5a22db9a06",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0f9cae99-541e-4d32-91da-a115fa19fdca",
"CreateDate": "2026-04-21T00:00:11.9104265-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-21T00:00:11.9104265-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "aefd9c2c-f363-4f5c-bfe7-1525cc8c9cc5",
"CreateDate": "2026-04-21T00:00:11.9104265-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-21T00:00:11.9104265-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f80fb0ef-3942-4e35-9cf9-3fc65a7055c3",
"CreateDate": "2026-04-21T00:00:11.9104265-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-21T00:00:11.9104265-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "437377f1-1994-452a-9448-1a09bb24ec7b",
"EffectiveDate": "2026-04-21T00:00:11.9104265-07:00",
"StatusType": {
"StatusTypeId": "cce71b66-0f58-4605-9489-d4d3590e01d2",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "a6779d4f-a563-45c9-ae32-ec5a22db9a06",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0f9cae99-541e-4d32-91da-a115fa19fdca",
"CreateDate": "2026-04-21T00:00:11.9104265-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-21T00:00:11.9104265-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "f000e120-afd1-47c1-af13-eeed5e0858cc",
"CreateDate": "2026-04-21T00:00:11.9104265-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-21T00:00:11.9104265-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "bed0a819-e68b-4727-9b37-9d82fc373abc",
"CreateDate": "2026-04-21T00:00:11.9104265-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-21T00:00:11.9104265-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "48fd5175-3ca7-4f59-a04d-377b5ee707dc",
"EffectiveDate": "2026-04-21T00:00:11.9104265-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "1294b0c2-d62f-48f6-b480-94fb8e18d1ad",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "cc02ea4c-90d8-4547-85df-882b1afa5278",
"CreateDate": "2026-04-21T00:00:11.9104265-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-21T00:00:11.9104265-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e68fba1a-3bce-42d3-8680-95d915b278ec",
"CreateDate": "2026-04-21T00:00:11.9104265-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-21T00:00:11.9104265-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-04-21T00:00:11.9104265-07:00",
"MeasurementValueNeededDate": "2026-04-21T00:00:11.9104265-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "87beea4c-812e-40cf-9a70-1897cdce10b9",
"CreateDate": "2026-04-21T00:00:11.9104265-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-21T00:00:11.9104265-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "9f95af1b-8b4a-405d-9ba1-b9a46fcec810",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d6ee1567-af5b-41e4-ba3d-740d88ab691e",
"CreateDate": "2026-04-21T00:00:11.9104265-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-21T00:00:11.9104265-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-04-21T00:00:11.9104265-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d69f333e-290c-4bac-9ba1-51779b2c9894",
"CreateDate": "2026-04-21T00:00:11.9104265-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-21T00:00:11.9104265-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": "650602e1-b5a9-4d8c-8d7b-245d9f56bf51",
"Asset": {
"AssetId": "b7d797ea-f363-493b-80ec-1fb6b16de006",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "37a82923-baf1-4552-84e8-724167325aba",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c8489dd0-def2-446b-bebf-a39610ddcc2f",
"CreateDate": "2026-04-21T00:00:11.9104265-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-21T00:00:11.9104265-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "e7c73ad1-a062-4dff-affc-445f595fd37b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-21T00:00:11.9104265-07:00",
"MeasurementValueNeededDate": "2026-04-21T00:00:11.9104265-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a92c06f6-7a09-4ea3-b440-bce6b7d4ceda",
"CreateDate": "2026-04-21T00:00:11.9104265-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-21T00:00:11.9104265-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "283cb726-da30-406a-b6fe-1f3130996b09",
"EffectiveDate": "2026-04-21T00:00:11.9104265-07:00",
"StateType": {
"StateTypeId": "0e67bc96-855c-4bed-b38c-559dbad4d906",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "37a82923-baf1-4552-84e8-724167325aba",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c8489dd0-def2-446b-bebf-a39610ddcc2f",
"CreateDate": "2026-04-21T00:00:11.9104265-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-21T00:00:11.9104265-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "7e7ab30a-0dd4-44b7-9675-452b940b1370",
"CreateDate": "2026-04-21T00:00:11.9104265-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-21T00:00:11.9104265-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "53b83510-21a6-44ac-af33-f9ac57165ff8",
"CreateDate": "2026-04-21T00:00:11.9104265-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-21T00:00:11.9104265-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "8017f3df-fa78-43bf-95e7-53ed78ecf9a1",
"EffectiveDate": "2026-04-21T00:00:11.9104265-07:00",
"StatusType": {
"StatusTypeId": "7c602592-4bac-4fa4-b7b7-48eb64c74a7e",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "37a82923-baf1-4552-84e8-724167325aba",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c8489dd0-def2-446b-bebf-a39610ddcc2f",
"CreateDate": "2026-04-21T00:00:11.9104265-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-21T00:00:11.9104265-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "15bf1f2f-5b82-40e2-b7cc-c8e74b01e80c",
"CreateDate": "2026-04-21T00:00:11.9104265-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-21T00:00:11.9104265-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d6506e1b-0a70-4a1b-b9f1-46b3b6cabce8",
"CreateDate": "2026-04-21T00:00:11.9104265-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-21T00:00:11.9104265-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "4c6268fc-d650-4314-8f1c-bf5c5aec6d7c",
"EffectiveDate": "2026-04-21T00:00:11.9104265-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "98fa487a-d5f7-45c1-b796-83221c4c0c15",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c2083dae-bb02-4ee5-b7d3-cb3c05b4353f",
"CreateDate": "2026-04-21T00:00:11.9104265-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-21T00:00:11.9104265-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "349df3e7-6f87-477d-b7fd-a6fc53148dc2",
"CreateDate": "2026-04-21T00:00:11.9104265-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-21T00:00:11.9104265-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-04-21T00:00:11.9104265-07:00",
"MeasurementValueNeededDate": "2026-04-21T00:00:11.9104265-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "926de2bb-cd5c-4382-a531-6c9a89f5cf00",
"CreateDate": "2026-04-21T00:00:11.9104265-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-21T00:00:11.9104265-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "6adf706b-405c-43db-89d9-7bc4fa41b40a",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f549dc12-8983-4c4e-8ef6-5ec4c741243c",
"CreateDate": "2026-04-21T00:00:11.9104265-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-21T00:00:11.9104265-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-04-21T00:00:11.9104265-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5bb5b575-7681-4e96-8d65-d7af84193d16",
"CreateDate": "2026-04-21T00:00:11.9104265-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-21T00:00:11.9104265-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}