GET Notes?assetId={assetId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves notes for the given parameters. All parameters are optional.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| assetId |
Id of the asset |
globally unique identifier |
None. |
| take |
Number of notes to retrieve. Default is all notes |
integer |
None. |
| skip |
Number of notes to skip before retrieval |
integer |
Default value is 0 |
| sort |
List of sorting rules to describe how to sort the notes before retrieval |
Collection of Sort |
None. |
| Operator | string |
None. |
|
| Field | string |
None. |
|
| Value | string |
None. |
|
| Logic | string |
None. |
|
| Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of notes.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Collection of Note |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": [
{
"NoteId": "ae6b5446-65fd-470a-b067-ebbfe474efeb",
"Asset": {
"AssetId": "3a3028d4-7354-4578-b18d-dd361015b4a4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a5e29503-160e-4780-8b59-3578f4cb713e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0f902b8a-929d-43a2-a784-966d98fd771a",
"CreateDate": "2025-04-25T15:44:57.0498799-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-25T15:44:57.0498799-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "823f47a4-89fa-4d11-bb09-9942b96bac5b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-04-25T15:44:57.0498799-07:00",
"MeasurementValueNeededDate": "2025-04-25T15:44:57.0498799-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "242e1027-de7e-4bb7-8863-d13a0d9d0024",
"CreateDate": "2025-04-25T15:44:57.0498799-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-25T15:44:57.0498799-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "adcdf220-f21f-4e7f-b7b7-5846d5f2e16e",
"EffectiveDate": "2025-04-25T15:44:57.0498799-07:00",
"StateType": {
"StateTypeId": "f7c0decc-1771-4929-8547-2ccf6b4745f7",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "a5e29503-160e-4780-8b59-3578f4cb713e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0f902b8a-929d-43a2-a784-966d98fd771a",
"CreateDate": "2025-04-25T15:44:57.0498799-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-25T15:44:57.0498799-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "bda57023-685f-43c3-9433-f2896b92e458",
"CreateDate": "2025-04-25T15:44:57.0498799-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-25T15:44:57.0498799-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4011d1e8-e717-440f-9822-aa49d9fd6eb8",
"CreateDate": "2025-04-25T15:44:57.0498799-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-25T15:44:57.0498799-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "d19b60b4-a2ff-44c0-b1bb-4a82c16c7407",
"EffectiveDate": "2025-04-25T15:44:57.0498799-07:00",
"StatusType": {
"StatusTypeId": "fc36f0ea-1ec2-418a-8b71-2be39105f497",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "a5e29503-160e-4780-8b59-3578f4cb713e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0f902b8a-929d-43a2-a784-966d98fd771a",
"CreateDate": "2025-04-25T15:44:57.0498799-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-25T15:44:57.0498799-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "4ab77539-4f33-4c21-bb36-9e3455e16a20",
"CreateDate": "2025-04-25T15:44:57.0498799-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-25T15:44:57.0498799-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "7d262bc7-81e1-4956-b4d9-f25c13072297",
"CreateDate": "2025-04-25T15:44:57.0498799-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-25T15:44:57.0498799-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "dbd3da32-8f76-4eda-8a4f-b374790fefd9",
"EffectiveDate": "2025-04-25T15:44:57.0498799-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "061ac1d5-1372-4da1-8c02-0c5810103f4a",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "927eec9d-04fd-46cf-8e5d-cc30be9f3023",
"CreateDate": "2025-04-25T15:44:57.0498799-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-25T15:44:57.0498799-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "53645442-429d-4d2e-956f-ec25f0099477",
"CreateDate": "2025-04-25T15:44:57.0498799-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-25T15:44:57.0498799-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-04-25T15:44:57.0498799-07:00",
"MeasurementValueNeededDate": "2025-04-25T15:44:57.0498799-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "8b5be13c-2a4f-444a-9f81-96c5137dbe23",
"CreateDate": "2025-04-25T15:44:57.0498799-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-25T15:44:57.0498799-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "5884979d-a80d-4eb3-91b7-7686691942b2",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "69c73b03-a3c6-444f-8981-34c536bb426c",
"CreateDate": "2025-04-25T15:44:57.0498799-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-04-25T15:44:57.0498799-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-04-25T15:44:57.0498799-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "be94b61f-cf4c-4dc7-bd80-94d1bb4b35ce",
"CreateDate": "2025-04-25T15:44:57.0498799-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-25T15:44:57.0498799-07:00",
"LastModifiedUser": "sample string 6"
},
{
"NoteId": "ae6b5446-65fd-470a-b067-ebbfe474efeb",
"Asset": {
"AssetId": "3a3028d4-7354-4578-b18d-dd361015b4a4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a5e29503-160e-4780-8b59-3578f4cb713e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0f902b8a-929d-43a2-a784-966d98fd771a",
"CreateDate": "2025-04-25T15:44:57.0498799-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-25T15:44:57.0498799-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "823f47a4-89fa-4d11-bb09-9942b96bac5b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-04-25T15:44:57.0498799-07:00",
"MeasurementValueNeededDate": "2025-04-25T15:44:57.0498799-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "242e1027-de7e-4bb7-8863-d13a0d9d0024",
"CreateDate": "2025-04-25T15:44:57.0498799-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-25T15:44:57.0498799-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "adcdf220-f21f-4e7f-b7b7-5846d5f2e16e",
"EffectiveDate": "2025-04-25T15:44:57.0498799-07:00",
"StateType": {
"StateTypeId": "f7c0decc-1771-4929-8547-2ccf6b4745f7",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "a5e29503-160e-4780-8b59-3578f4cb713e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0f902b8a-929d-43a2-a784-966d98fd771a",
"CreateDate": "2025-04-25T15:44:57.0498799-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-25T15:44:57.0498799-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "bda57023-685f-43c3-9433-f2896b92e458",
"CreateDate": "2025-04-25T15:44:57.0498799-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-25T15:44:57.0498799-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4011d1e8-e717-440f-9822-aa49d9fd6eb8",
"CreateDate": "2025-04-25T15:44:57.0498799-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-25T15:44:57.0498799-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "d19b60b4-a2ff-44c0-b1bb-4a82c16c7407",
"EffectiveDate": "2025-04-25T15:44:57.0498799-07:00",
"StatusType": {
"StatusTypeId": "fc36f0ea-1ec2-418a-8b71-2be39105f497",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "a5e29503-160e-4780-8b59-3578f4cb713e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0f902b8a-929d-43a2-a784-966d98fd771a",
"CreateDate": "2025-04-25T15:44:57.0498799-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-25T15:44:57.0498799-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "4ab77539-4f33-4c21-bb36-9e3455e16a20",
"CreateDate": "2025-04-25T15:44:57.0498799-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-25T15:44:57.0498799-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "7d262bc7-81e1-4956-b4d9-f25c13072297",
"CreateDate": "2025-04-25T15:44:57.0498799-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-25T15:44:57.0498799-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "dbd3da32-8f76-4eda-8a4f-b374790fefd9",
"EffectiveDate": "2025-04-25T15:44:57.0498799-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "061ac1d5-1372-4da1-8c02-0c5810103f4a",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "927eec9d-04fd-46cf-8e5d-cc30be9f3023",
"CreateDate": "2025-04-25T15:44:57.0498799-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-25T15:44:57.0498799-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "53645442-429d-4d2e-956f-ec25f0099477",
"CreateDate": "2025-04-25T15:44:57.0498799-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-25T15:44:57.0498799-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-04-25T15:44:57.0498799-07:00",
"MeasurementValueNeededDate": "2025-04-25T15:44:57.0498799-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "8b5be13c-2a4f-444a-9f81-96c5137dbe23",
"CreateDate": "2025-04-25T15:44:57.0498799-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-25T15:44:57.0498799-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "5884979d-a80d-4eb3-91b7-7686691942b2",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "69c73b03-a3c6-444f-8981-34c536bb426c",
"CreateDate": "2025-04-25T15:44:57.0498799-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-04-25T15:44:57.0498799-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-04-25T15:44:57.0498799-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "be94b61f-cf4c-4dc7-bd80-94d1bb4b35ce",
"CreateDate": "2025-04-25T15:44:57.0498799-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-25T15:44:57.0498799-07:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}