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": "23aef39e-3afa-49f6-a4b8-4f79419db99b",
"Asset": {
"AssetId": "0ad0f7c9-d7b7-46a8-9bad-f539fc76ef59",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "33b1f560-3cd7-4eb6-8023-ef5d540b2810",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "bf1b611e-af08-464a-9c32-6cbe8a8ca89a",
"CreateDate": "2025-12-26T21:20:18.7094274-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-26T21:20:18.7094274-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "7e525724-c28f-42a9-8138-cdc1eb3d829f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-26T21:20:18.7094274-08:00",
"MeasurementValueNeededDate": "2025-12-26T21:20:18.7094274-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "789340bd-3f49-4c17-b99e-7147c11f1745",
"CreateDate": "2025-12-26T21:20:18.7094274-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-26T21:20:18.7094274-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "3d458b7c-161c-4784-9eeb-fcc254c9db0e",
"EffectiveDate": "2025-12-26T21:20:18.7094274-08:00",
"StateType": {
"StateTypeId": "d0cd25a4-e4a6-4622-9280-290f47c3a44f",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "33b1f560-3cd7-4eb6-8023-ef5d540b2810",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "bf1b611e-af08-464a-9c32-6cbe8a8ca89a",
"CreateDate": "2025-12-26T21:20:18.7094274-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-26T21:20:18.7094274-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "847c06bc-de3d-4cf4-a47d-68b27d02bc75",
"CreateDate": "2025-12-26T21:20:18.7094274-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-26T21:20:18.7094274-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6236adde-0c43-417f-bbd2-42934ff8316c",
"CreateDate": "2025-12-26T21:20:18.7094274-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-26T21:20:18.7094274-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "54c97b79-b718-458a-9c17-f32d0b92854f",
"EffectiveDate": "2025-12-26T21:20:18.7094274-08:00",
"StatusType": {
"StatusTypeId": "ffff855b-bbd0-477c-b044-e27b5918a9af",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "33b1f560-3cd7-4eb6-8023-ef5d540b2810",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "bf1b611e-af08-464a-9c32-6cbe8a8ca89a",
"CreateDate": "2025-12-26T21:20:18.7094274-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-26T21:20:18.7094274-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "a30f6f26-e35f-4459-aa06-ab60937e79e1",
"CreateDate": "2025-12-26T21:20:18.7094274-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-26T21:20:18.7094274-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b1366a89-99c8-4b36-a604-07f55fe6e461",
"CreateDate": "2025-12-26T21:20:18.7094274-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-26T21:20:18.7094274-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "e45deaad-4b3c-4321-89ad-c2beb80a968c",
"EffectiveDate": "2025-12-26T21:20:18.7094274-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "0c41ab9c-f20b-447c-b555-0a8eae069e98",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e65be556-a280-433d-89b7-59feb7118e3d",
"CreateDate": "2025-12-26T21:20:18.7094274-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-26T21:20:18.7094274-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f3015cfe-d6eb-4e29-82ef-af6947a50cee",
"CreateDate": "2025-12-26T21:20:18.7094274-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-26T21:20:18.7094274-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-12-26T21:20:18.7094274-08:00",
"MeasurementValueNeededDate": "2025-12-26T21:20:18.7094274-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "5512ed64-4c84-44fb-bfec-da2da5df6342",
"CreateDate": "2025-12-26T21:20:18.7094274-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-26T21:20:18.7094274-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "652a6544-f0bc-453e-b2a3-4c4ec763c8c9",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "017e48a9-73d2-4d68-8a97-048d998ae213",
"CreateDate": "2025-12-26T21:20:18.7094274-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-26T21:20:18.7094274-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-26T21:20:18.7094274-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f5a5e928-da70-4d1f-a2b0-c6c08b9ea4df",
"CreateDate": "2025-12-26T21:20:18.7094274-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-26T21:20:18.7094274-08: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": "5fbcc35e-b3f5-4abb-b4fc-0eefba9bd72d",
"Asset": {
"AssetId": "7e8eda2c-b944-4293-99b4-c62a68a35dd0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "7a83875a-752c-4ea9-a0be-ea551aff399e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "55dbfdfd-4cc0-4f5d-870c-c8d1b741f724",
"CreateDate": "2025-12-26T21:20:18.7094274-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-26T21:20:18.7094274-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "b18d0a98-c602-484e-8781-92d04d26bd4e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-26T21:20:18.7094274-08:00",
"MeasurementValueNeededDate": "2025-12-26T21:20:18.7094274-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e110f7bf-2f5d-4418-ac3b-d92841170a0a",
"CreateDate": "2025-12-26T21:20:18.7094274-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-26T21:20:18.7094274-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "ad7f8def-41b8-4006-84e8-d026b9ce3325",
"EffectiveDate": "2025-12-26T21:20:18.7094274-08:00",
"StateType": {
"StateTypeId": "6d199592-66ed-41eb-8992-0b6af09c8cc9",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "7a83875a-752c-4ea9-a0be-ea551aff399e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "55dbfdfd-4cc0-4f5d-870c-c8d1b741f724",
"CreateDate": "2025-12-26T21:20:18.7094274-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-26T21:20:18.7094274-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "9a349e14-10b8-44e8-8e0a-8e8fae7a505f",
"CreateDate": "2025-12-26T21:20:18.7094274-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-26T21:20:18.7094274-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "59512459-30d8-47e6-a7cf-63fdce07a24c",
"CreateDate": "2025-12-26T21:20:18.7094274-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-26T21:20:18.7094274-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "25a1806e-defb-437d-b9d3-c2915fd5e495",
"EffectiveDate": "2025-12-26T21:20:18.7094274-08:00",
"StatusType": {
"StatusTypeId": "4c18e401-652d-4117-bf29-187148fd15b2",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "7a83875a-752c-4ea9-a0be-ea551aff399e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "55dbfdfd-4cc0-4f5d-870c-c8d1b741f724",
"CreateDate": "2025-12-26T21:20:18.7094274-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-26T21:20:18.7094274-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "ea1d99b7-d19d-4bea-a32d-8acc4fceb097",
"CreateDate": "2025-12-26T21:20:18.7094274-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-26T21:20:18.7094274-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ea401303-164b-4d9d-b271-0d4ad3649990",
"CreateDate": "2025-12-26T21:20:18.7094274-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-26T21:20:18.7094274-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "f25a6cc0-829f-4b38-81b3-7c105b88fed0",
"EffectiveDate": "2025-12-26T21:20:18.7094274-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "a3be53fb-750b-4747-aa18-38ede99ec00e",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d8701cf5-1173-43b4-b1c0-5efb53cb581f",
"CreateDate": "2025-12-26T21:20:18.7094274-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-26T21:20:18.7094274-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e0b67023-50b5-42cd-afec-650319fc0819",
"CreateDate": "2025-12-26T21:20:18.7094274-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-26T21:20:18.7094274-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-12-26T21:20:18.7094274-08:00",
"MeasurementValueNeededDate": "2025-12-26T21:20:18.7094274-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "ea57569d-9140-4496-9e40-aa5723409bd4",
"CreateDate": "2025-12-26T21:20:18.7094274-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-26T21:20:18.7094274-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "c4231921-6558-40eb-ab67-f01112f13b0b",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e461151e-8c80-4a1d-92e7-f80ca0c10c8f",
"CreateDate": "2025-12-26T21:20:18.7094274-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-26T21:20:18.7094274-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-26T21:20:18.7094274-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c565a7c7-3b04-4d14-85cd-2153a45ee33d",
"CreateDate": "2025-12-26T21:20:18.7094274-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-26T21:20:18.7094274-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}