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": "99729f98-9376-4594-a9d3-84da6f13a76d",
"Asset": {
"AssetId": "a7aba686-22a4-4fd3-b16a-ae983c7c24af",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2b45f8ce-a0da-4124-b920-4e03b4058dca",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9b0dcf38-80f3-4aa1-b2cb-caacd819e9ef",
"CreateDate": "2026-04-28T22:08:34.4241086-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-28T22:08:34.4241086-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "59e81381-725c-417b-93d8-684fb5d07bd1",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-28T22:08:34.4241086-07:00",
"MeasurementValueNeededDate": "2026-04-28T22:08:34.4241086-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "701a8851-9aff-4ff4-8f05-50dc65dc0f6a",
"CreateDate": "2026-04-28T22:08:34.4241086-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-28T22:08:34.4241086-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "a5b37016-0691-4f9a-8da1-78c0a65edfdd",
"EffectiveDate": "2026-04-28T22:08:34.4241086-07:00",
"StateType": {
"StateTypeId": "3cdf7391-8b70-4161-8aba-70d0b69cd2ae",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "2b45f8ce-a0da-4124-b920-4e03b4058dca",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9b0dcf38-80f3-4aa1-b2cb-caacd819e9ef",
"CreateDate": "2026-04-28T22:08:34.4241086-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-28T22:08:34.4241086-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "cbc7e143-8d37-4084-a3ea-9903984b05c6",
"CreateDate": "2026-04-28T22:08:34.4241086-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-28T22:08:34.4241086-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a58d7aaa-2897-4684-a132-c92579c7ee35",
"CreateDate": "2026-04-28T22:08:34.4241086-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-28T22:08:34.4241086-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "dcc659f5-4c5f-49bf-ab4c-829416074c6e",
"EffectiveDate": "2026-04-28T22:08:34.4241086-07:00",
"StatusType": {
"StatusTypeId": "6e02834b-34bd-4884-8daa-43a19e7ab125",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "2b45f8ce-a0da-4124-b920-4e03b4058dca",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9b0dcf38-80f3-4aa1-b2cb-caacd819e9ef",
"CreateDate": "2026-04-28T22:08:34.4241086-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-28T22:08:34.4241086-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "881d3ced-1be2-44d9-bcec-81f504db122a",
"CreateDate": "2026-04-28T22:08:34.4241086-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-28T22:08:34.4241086-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "25044e6f-6737-42b6-92e2-87f21c041b96",
"CreateDate": "2026-04-28T22:08:34.4241086-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-28T22:08:34.4241086-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "fd4b89d0-b3fe-4874-91ab-4da802f630af",
"EffectiveDate": "2026-04-28T22:08:34.4241086-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "f05c76b5-14e6-4748-bc6b-1131aaa9babc",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1f552590-1621-4a08-9440-55b56b67b522",
"CreateDate": "2026-04-28T22:08:34.4241086-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-28T22:08:34.4241086-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d857c965-bfa7-4134-90a5-7e977cf46df0",
"CreateDate": "2026-04-28T22:08:34.4241086-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-28T22:08:34.4241086-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-04-28T22:08:34.4241086-07:00",
"MeasurementValueNeededDate": "2026-04-28T22:08:34.4241086-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "07ca5d3a-cc74-463c-ae9e-0733f4558414",
"CreateDate": "2026-04-28T22:08:34.4241086-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-28T22:08:34.4241086-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "348e72b5-708e-4f45-be7a-82e34668acf2",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c8881f01-550d-4dc2-9ea0-e75dbc1d4d4d",
"CreateDate": "2026-04-28T22:08:34.4241086-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-28T22:08:34.4241086-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-04-28T22:08:34.4241086-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "dcbd05b9-1ac8-4f33-b4b3-6dd748cd0f70",
"CreateDate": "2026-04-28T22:08:34.4241086-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-28T22:08:34.4241086-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": "fd4ac197-7f78-4657-a0c3-5a170e9306a6",
"Asset": {
"AssetId": "9ec160ac-3f32-4247-9d3d-2ed210aab641",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "bd46d65f-726a-4bab-a225-b697c53b172f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "01ae3b3e-b233-4dc8-ab97-cab7e0891d33",
"CreateDate": "2026-04-28T22:08:34.4241086-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-28T22:08:34.4241086-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "8e23889e-96bc-4047-88a8-932802354cfa",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-28T22:08:34.4241086-07:00",
"MeasurementValueNeededDate": "2026-04-28T22:08:34.4241086-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f43aa85c-fde0-4d71-b313-8bf3371e90cb",
"CreateDate": "2026-04-28T22:08:34.4241086-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-28T22:08:34.4241086-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "db76551f-1176-454b-a208-3cf39c251af4",
"EffectiveDate": "2026-04-28T22:08:34.4241086-07:00",
"StateType": {
"StateTypeId": "d54f4e19-b5e5-43ba-956d-ee14fbd1f7a2",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "bd46d65f-726a-4bab-a225-b697c53b172f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "01ae3b3e-b233-4dc8-ab97-cab7e0891d33",
"CreateDate": "2026-04-28T22:08:34.4241086-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-28T22:08:34.4241086-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "ed2d8fbb-1ae3-4c16-b812-d1fda5f3ab4f",
"CreateDate": "2026-04-28T22:08:34.4241086-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-28T22:08:34.4241086-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "74b787f1-6d4d-4433-a68f-c44f116278be",
"CreateDate": "2026-04-28T22:08:34.4241086-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-28T22:08:34.4241086-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "ae5f71b3-b4e6-4329-9e76-10995487ad14",
"EffectiveDate": "2026-04-28T22:08:34.4241086-07:00",
"StatusType": {
"StatusTypeId": "72eabfd3-4184-40d6-8f64-9603b35c4fd8",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "bd46d65f-726a-4bab-a225-b697c53b172f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "01ae3b3e-b233-4dc8-ab97-cab7e0891d33",
"CreateDate": "2026-04-28T22:08:34.4241086-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-28T22:08:34.4241086-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "a37a368f-38f9-4214-bde0-a3d97290f8ea",
"CreateDate": "2026-04-28T22:08:34.4241086-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-28T22:08:34.4241086-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9f282426-c650-49a0-a095-1af218246a4a",
"CreateDate": "2026-04-28T22:08:34.4241086-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-28T22:08:34.4241086-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "f7d7315a-cc44-46f5-a6fb-9a98aecf45f7",
"EffectiveDate": "2026-04-28T22:08:34.4241086-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "00f30c07-4936-4a39-9dcc-1108d439a653",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "bfe48031-c25f-4e4e-8a9d-0a3d115228d9",
"CreateDate": "2026-04-28T22:08:34.4241086-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-28T22:08:34.4241086-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3fd93227-3cc6-4449-a325-30cd3cf0b6f7",
"CreateDate": "2026-04-28T22:08:34.4241086-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-28T22:08:34.4241086-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-04-28T22:08:34.4241086-07:00",
"MeasurementValueNeededDate": "2026-04-28T22:08:34.4241086-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "91ea2c9d-4932-4e9e-93fa-be33f43ad64a",
"CreateDate": "2026-04-28T22:08:34.4241086-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-28T22:08:34.4241086-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "d95e2f32-9fb7-4c45-8d93-367ceabdb9a9",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0e38b0dd-b657-435b-b770-2ca33fdc5244",
"CreateDate": "2026-04-28T22:08:34.4241086-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-28T22:08:34.4241086-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-04-28T22:08:34.4241086-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "caf9298f-4fe5-4bb5-a54c-11ac65319a17",
"CreateDate": "2026-04-28T22:08:34.4241086-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-28T22:08:34.4241086-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}