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": "4420ace2-bca4-4c21-b9d4-ccfcad7673ed",
"Asset": {
"AssetId": "b194ba6a-604b-4451-811d-311be1f40792",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "b92e5728-c739-4c57-9048-cd27d57c3042",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9d6393f3-0194-4443-8db1-4ae774f743c8",
"CreateDate": "2026-09-07T00:31:17.1486253-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-07T00:31:17.1486253-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "54bb64fe-96af-4a49-9b80-d99427e88726",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-07T00:31:17.1486253-07:00",
"MeasurementValueNeededDate": "2026-09-07T00:31:17.1486253-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "70eaff5f-b827-4aa6-a9f6-4e7b93f6f31e",
"CreateDate": "2026-09-07T00:31:17.1486253-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-07T00:31:17.1486253-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "af00dfd9-658d-483b-9478-4adcedcafe36",
"EffectiveDate": "2026-09-07T00:31:17.1486253-07:00",
"StateType": {
"StateTypeId": "0f0d8137-52fa-4ec1-bec5-59a98bef9fb0",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "b92e5728-c739-4c57-9048-cd27d57c3042",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9d6393f3-0194-4443-8db1-4ae774f743c8",
"CreateDate": "2026-09-07T00:31:17.1486253-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-07T00:31:17.1486253-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "3b1b9292-9e0a-4afc-8e8c-d9912d5f88c0",
"CreateDate": "2026-09-07T00:31:17.1486253-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-07T00:31:17.1486253-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "311e3907-b0ca-4646-858b-1833c49a1705",
"CreateDate": "2026-09-07T00:31:17.1486253-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-07T00:31:17.1486253-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "751d25eb-4ddc-4e8e-8f9c-61b20eed3ac6",
"EffectiveDate": "2026-09-07T00:31:17.1486253-07:00",
"StatusType": {
"StatusTypeId": "159f0163-a296-48eb-b821-f7ef01c632f1",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "b92e5728-c739-4c57-9048-cd27d57c3042",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9d6393f3-0194-4443-8db1-4ae774f743c8",
"CreateDate": "2026-09-07T00:31:17.1486253-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-07T00:31:17.1486253-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "0241f3d4-e796-48f0-9cf2-5d92c5ea4a36",
"CreateDate": "2026-09-07T00:31:17.1486253-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-07T00:31:17.1486253-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c18d65f2-4d43-4ddc-b58a-847472dde806",
"CreateDate": "2026-09-07T00:31:17.1486253-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-07T00:31:17.1486253-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "5c89a8c5-9d9d-430e-ad08-2184d5f870e8",
"EffectiveDate": "2026-09-07T00:31:17.1486253-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "48700b46-4b87-4e02-b01e-78fcdca893a2",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c1e21489-84bc-4cff-94ea-8c6bc6fe1c6f",
"CreateDate": "2026-09-07T00:31:17.1486253-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-07T00:31:17.1486253-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c63289b5-603a-4ea3-ab7c-d11dab4009a3",
"CreateDate": "2026-09-07T00:31:17.1486253-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-07T00:31:17.1486253-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-09-07T00:31:17.1486253-07:00",
"MeasurementValueNeededDate": "2026-09-07T00:31:17.1486253-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "cdf6aab8-342b-44f6-a455-cc11663569a8",
"CreateDate": "2026-09-07T00:31:17.1486253-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-07T00:31:17.1486253-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "389103f5-5d94-4283-895d-cde726beefbd",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e3d190a8-273a-4d5e-88c1-6ecad13183c7",
"CreateDate": "2026-09-07T00:31:17.1486253-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-07T00:31:17.1486253-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-07T00:31:17.1486253-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "3ff72e0f-1fe6-4957-b8b2-6ecdd8ffdbe2",
"CreateDate": "2026-09-07T00:31:17.1486253-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-07T00:31:17.1486253-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": "8371fe10-3568-4a4c-b946-e0f57f82adbe",
"Asset": {
"AssetId": "94958b84-ec6b-4a1c-bdad-3d06ce9b1465",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "c7d40fa4-db2a-457e-91a8-4f062b211bf5",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9e13d1f9-d8a8-4bf9-9b8e-0474b11a7814",
"CreateDate": "2026-09-07T00:31:17.1486253-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-07T00:31:17.1486253-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "37ded583-b31a-4139-aa5b-d4b838b3505f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-07T00:31:17.1486253-07:00",
"MeasurementValueNeededDate": "2026-09-07T00:31:17.1486253-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3f2f6872-410d-4807-bfe8-c7d99a5e80f6",
"CreateDate": "2026-09-07T00:31:17.1486253-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-07T00:31:17.1486253-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "136e1a3f-b24d-43da-a6ac-79a363fa36f5",
"EffectiveDate": "2026-09-07T00:31:17.1486253-07:00",
"StateType": {
"StateTypeId": "01e0ff43-45ea-4096-ad3c-5448573ec7f6",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "c7d40fa4-db2a-457e-91a8-4f062b211bf5",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9e13d1f9-d8a8-4bf9-9b8e-0474b11a7814",
"CreateDate": "2026-09-07T00:31:17.1486253-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-07T00:31:17.1486253-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "98444155-0389-4e69-99e0-729e9f4b15d7",
"CreateDate": "2026-09-07T00:31:17.1486253-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-07T00:31:17.1486253-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9c83a96a-0a6c-49a0-ae72-d464d3b4a203",
"CreateDate": "2026-09-07T00:31:17.1486253-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-07T00:31:17.1486253-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "51a99748-399d-4501-bf4d-4b7cb8ea3beb",
"EffectiveDate": "2026-09-07T00:31:17.1486253-07:00",
"StatusType": {
"StatusTypeId": "d7b7268a-d0e0-4b3b-a363-f5baa85d0175",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "c7d40fa4-db2a-457e-91a8-4f062b211bf5",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9e13d1f9-d8a8-4bf9-9b8e-0474b11a7814",
"CreateDate": "2026-09-07T00:31:17.1486253-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-07T00:31:17.1486253-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "102bb988-a3ed-4cc7-876b-813c32b7120f",
"CreateDate": "2026-09-07T00:31:17.1486253-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-07T00:31:17.1486253-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3dde474b-f9ee-4ae4-b116-7f9d033e11b6",
"CreateDate": "2026-09-07T00:31:17.1486253-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-07T00:31:17.1486253-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "bd2d04e2-d5c6-48b9-9258-8e3eb32c4f5f",
"EffectiveDate": "2026-09-07T00:31:17.1486253-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "8986b40f-fdf2-491c-b924-98018264457b",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e147bd01-92cf-4da2-98b2-6f0341e250c1",
"CreateDate": "2026-09-07T00:31:17.1486253-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-07T00:31:17.1486253-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "20845ae3-cd28-4af3-9743-c95fd8f68ebf",
"CreateDate": "2026-09-07T00:31:17.1486253-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-07T00:31:17.1486253-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-09-07T00:31:17.1486253-07:00",
"MeasurementValueNeededDate": "2026-09-07T00:31:17.1486253-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f5ea23fd-958c-4e95-b0e0-a38a35fa90c8",
"CreateDate": "2026-09-07T00:31:17.1486253-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-07T00:31:17.1486253-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "f6e93a2b-011c-4ace-b8e1-73727d606780",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0537b4db-69a6-4b75-af3b-e99c8adca23e",
"CreateDate": "2026-09-07T00:31:17.1486253-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-07T00:31:17.1486253-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-07T00:31:17.1486253-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c25b38ad-2c7b-4122-8958-3119e4975185",
"CreateDate": "2026-09-07T00:31:17.1486253-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-07T00:31:17.1486253-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}