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": "53dbb4a9-a03c-4127-904d-d2b278209f67",
"Asset": {
"AssetId": "f5383d5d-6773-4319-952b-146e99fa26e7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a592d843-9b14-4671-9b09-60832c55d2f3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "747fef61-bd18-4179-aa9b-1c6c7e1e37ab",
"CreateDate": "2026-03-02T05:37:22.0041784-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-02T05:37:22.0041784-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "c49f526d-e96e-4269-9eac-b938e4686c01",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-02T05:37:22.0041784-08:00",
"MeasurementValueNeededDate": "2026-03-02T05:37:22.0041784-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e979b41e-5366-417b-8b94-4d1640b71d91",
"CreateDate": "2026-03-02T05:37:22.0041784-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-02T05:37:22.0041784-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "c6bca5cb-43ca-4cf0-b54c-5190dd827f9b",
"EffectiveDate": "2026-03-02T05:37:22.0041784-08:00",
"StateType": {
"StateTypeId": "bb2a867f-60d6-4a23-9945-3c3348af39f5",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "a592d843-9b14-4671-9b09-60832c55d2f3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "747fef61-bd18-4179-aa9b-1c6c7e1e37ab",
"CreateDate": "2026-03-02T05:37:22.0041784-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-02T05:37:22.0041784-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "ced0437b-d635-4001-b834-d410ec39674e",
"CreateDate": "2026-03-02T05:37:22.0041784-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-02T05:37:22.0041784-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "362b629c-1276-425d-a20c-dacf0ac7d0d2",
"CreateDate": "2026-03-02T05:37:22.0041784-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-02T05:37:22.0041784-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "2a64aba5-95a2-485e-93a9-6d008c189fd1",
"EffectiveDate": "2026-03-02T05:37:22.0041784-08:00",
"StatusType": {
"StatusTypeId": "d0c0d58f-19b4-4e8c-9699-db2f1c467565",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "a592d843-9b14-4671-9b09-60832c55d2f3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "747fef61-bd18-4179-aa9b-1c6c7e1e37ab",
"CreateDate": "2026-03-02T05:37:22.0041784-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-02T05:37:22.0041784-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "f074453f-a771-4873-9e8b-d6f1a95729b7",
"CreateDate": "2026-03-02T05:37:22.0041784-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-02T05:37:22.0041784-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "8fe7df30-4406-43da-9888-ff9e2724c216",
"CreateDate": "2026-03-02T05:37:22.0041784-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-02T05:37:22.0041784-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "df9235e8-5ed7-4cb0-b577-77f71ccf621a",
"EffectiveDate": "2026-03-02T05:37:22.0041784-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "bb6fadb8-3d8f-4e5b-82f7-435cbdd88c46",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ebfca219-0532-4a02-b213-35e5f275dcdf",
"CreateDate": "2026-03-02T05:37:22.0041784-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-02T05:37:22.0041784-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "cf5e5fc4-92cb-4e7f-9b23-4eb50972e842",
"CreateDate": "2026-03-02T05:37:22.0041784-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-02T05:37:22.0041784-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-02T05:37:22.0041784-08:00",
"MeasurementValueNeededDate": "2026-03-02T05:37:22.0041784-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "c07d5df7-e96c-46b5-8266-0fa8b924613f",
"CreateDate": "2026-03-02T05:37:22.0041784-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-02T05:37:22.0041784-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "30d37121-a57c-4c2b-83c4-d887e5f5f864",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "fb907d45-d26b-4e1e-8700-71ac937d93b4",
"CreateDate": "2026-03-02T05:37:22.0041784-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-02T05:37:22.0041784-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-02T05:37:22.0041784-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a7dd1d74-477c-4476-bc46-635b6fc86d42",
"CreateDate": "2026-03-02T05:37:22.0041784-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-02T05:37:22.0041784-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": "8184f28f-bb58-461a-be68-383dc12c9857",
"Asset": {
"AssetId": "8379e31e-a1f7-462f-bf0c-1d10475e2179",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a9ff9a57-5170-4c1c-8775-e3bcb00e544a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ded0c933-88a2-4e82-aaf0-1d1acb08e840",
"CreateDate": "2026-03-02T05:37:22.0041784-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-02T05:37:22.0041784-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "e7fa3f71-8984-4c5b-ab87-438effae21dd",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-02T05:37:22.0041784-08:00",
"MeasurementValueNeededDate": "2026-03-02T05:37:22.0041784-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "75aa5f9b-895e-46cd-93e1-3cbc9942688f",
"CreateDate": "2026-03-02T05:37:22.0041784-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-02T05:37:22.0041784-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "8bca9888-d5cf-4c2b-8955-be39d1418656",
"EffectiveDate": "2026-03-02T05:37:22.0197937-08:00",
"StateType": {
"StateTypeId": "e7a9777b-09b3-4817-b0e5-3aed1338121d",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "a9ff9a57-5170-4c1c-8775-e3bcb00e544a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ded0c933-88a2-4e82-aaf0-1d1acb08e840",
"CreateDate": "2026-03-02T05:37:22.0041784-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-02T05:37:22.0041784-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "6f0967ee-3dc5-420e-8b94-4b4c35cb2328",
"CreateDate": "2026-03-02T05:37:22.0197937-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-02T05:37:22.0197937-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "28053863-1faa-4a28-90aa-1f24ed03c3cf",
"CreateDate": "2026-03-02T05:37:22.0197937-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-02T05:37:22.0197937-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "d8a6410f-957c-4d03-9b2d-208bfa4556e0",
"EffectiveDate": "2026-03-02T05:37:22.0197937-08:00",
"StatusType": {
"StatusTypeId": "e3d11e2c-896f-4474-8ac6-faebd2135e6a",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "a9ff9a57-5170-4c1c-8775-e3bcb00e544a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ded0c933-88a2-4e82-aaf0-1d1acb08e840",
"CreateDate": "2026-03-02T05:37:22.0041784-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-02T05:37:22.0041784-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "233cab32-f724-4f4a-aa70-b636799532e7",
"CreateDate": "2026-03-02T05:37:22.0197937-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-02T05:37:22.0197937-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "82540e23-0189-4df8-a8a5-bb572ab4cb97",
"CreateDate": "2026-03-02T05:37:22.0197937-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-02T05:37:22.0197937-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "a8e0febd-e1fd-44ed-a641-a1b413a833c4",
"EffectiveDate": "2026-03-02T05:37:22.0197937-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "b80c95f3-c537-4b14-b626-3e8bf8e240d5",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "8c5f5217-687e-433d-a439-5c898ba8a72c",
"CreateDate": "2026-03-02T05:37:22.0197937-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-02T05:37:22.0197937-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "47385c44-8b52-4256-85dc-fa22292f9f1a",
"CreateDate": "2026-03-02T05:37:22.0197937-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-02T05:37:22.0197937-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-02T05:37:22.0197937-08:00",
"MeasurementValueNeededDate": "2026-03-02T05:37:22.0197937-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "58c84352-6e45-4aa9-a80e-dbb317d4b4a0",
"CreateDate": "2026-03-02T05:37:22.0197937-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-02T05:37:22.0197937-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "5dc6c13a-a675-4cb5-a064-54e04e4a086d",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "a33014bd-0785-48c2-b14e-e0862d0992cc",
"CreateDate": "2026-03-02T05:37:22.0197937-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-02T05:37:22.0197937-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-02T05:37:22.0197937-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "01af345e-ca1f-46c4-9976-9be6ff027954",
"CreateDate": "2026-03-02T05:37:22.0197937-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-02T05:37:22.0197937-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}