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": "b63547f2-51e6-4601-b2dd-c63be0fde4f8",
"Asset": {
"AssetId": "d65231f9-18c7-4e46-8396-a4661d3f0979",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "08770128-b25d-4f45-ab2c-d03a2861cbdd",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1bc5b3a7-59b8-4735-989b-032b21209e17",
"CreateDate": "2026-04-16T18:18:08.8200737-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-16T18:18:08.8200737-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "ad809080-97cb-4802-9998-04342e7a8ece",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-16T18:18:08.8200737-07:00",
"MeasurementValueNeededDate": "2026-04-16T18:18:08.8200737-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "49712d32-eeca-4012-b75e-b7886799cdb0",
"CreateDate": "2026-04-16T18:18:08.8200737-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-16T18:18:08.8200737-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "169b8cc1-40f3-4bbe-b715-c1c835be8e29",
"EffectiveDate": "2026-04-16T18:18:08.8200737-07:00",
"StateType": {
"StateTypeId": "cdcc2da0-c66a-4e79-995a-3725af2ca4ff",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "08770128-b25d-4f45-ab2c-d03a2861cbdd",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1bc5b3a7-59b8-4735-989b-032b21209e17",
"CreateDate": "2026-04-16T18:18:08.8200737-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-16T18:18:08.8200737-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "e699dae2-2f62-4a90-b1f7-ae90e57acf63",
"CreateDate": "2026-04-16T18:18:08.8200737-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-16T18:18:08.8200737-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "93cc26ee-0e58-4014-8ee6-d6e016a580a0",
"CreateDate": "2026-04-16T18:18:08.8200737-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-16T18:18:08.8200737-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "c2f096e0-3de2-416b-a60f-b63fd821bcbd",
"EffectiveDate": "2026-04-16T18:18:08.8200737-07:00",
"StatusType": {
"StatusTypeId": "432236bb-2367-4ae8-af21-93761053e574",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "08770128-b25d-4f45-ab2c-d03a2861cbdd",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1bc5b3a7-59b8-4735-989b-032b21209e17",
"CreateDate": "2026-04-16T18:18:08.8200737-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-16T18:18:08.8200737-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "570ab98e-13ca-4515-9e34-fbde871453b4",
"CreateDate": "2026-04-16T18:18:08.8200737-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-16T18:18:08.8200737-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "dcf13867-245f-4101-8281-6664e2dd9108",
"CreateDate": "2026-04-16T18:18:08.8200737-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-16T18:18:08.8200737-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "46397fe2-020e-4872-8b8b-56dd787103d5",
"EffectiveDate": "2026-04-16T18:18:08.8200737-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "216d7a73-3323-4a9f-8b82-9ce0f147aeca",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3c3d59b6-fe2d-4d77-afd6-0b793e473a7d",
"CreateDate": "2026-04-16T18:18:08.8200737-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-16T18:18:08.8200737-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "641e9b3b-2f8d-4615-9cfd-11dac3b16ec6",
"CreateDate": "2026-04-16T18:18:08.8200737-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-16T18:18:08.8200737-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-04-16T18:18:08.8200737-07:00",
"MeasurementValueNeededDate": "2026-04-16T18:18:08.8200737-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "30c2a677-9c2c-43f0-a834-42be5bc96182",
"CreateDate": "2026-04-16T18:18:08.8200737-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-16T18:18:08.8200737-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "c38251ef-f99e-45d3-a353-e7f6237449a3",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "9820dfbb-e965-4475-86d0-4d06683fcb42",
"CreateDate": "2026-04-16T18:18:08.8200737-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-16T18:18:08.8200737-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-04-16T18:18:08.8200737-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ae900a36-2f37-430f-ad80-bc68576e9c09",
"CreateDate": "2026-04-16T18:18:08.8200737-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-16T18:18:08.8200737-07:00",
"LastModifiedUser": "sample string 6"
},
{
"NoteId": "b63547f2-51e6-4601-b2dd-c63be0fde4f8",
"Asset": {
"AssetId": "d65231f9-18c7-4e46-8396-a4661d3f0979",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "08770128-b25d-4f45-ab2c-d03a2861cbdd",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1bc5b3a7-59b8-4735-989b-032b21209e17",
"CreateDate": "2026-04-16T18:18:08.8200737-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-16T18:18:08.8200737-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "ad809080-97cb-4802-9998-04342e7a8ece",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-16T18:18:08.8200737-07:00",
"MeasurementValueNeededDate": "2026-04-16T18:18:08.8200737-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "49712d32-eeca-4012-b75e-b7886799cdb0",
"CreateDate": "2026-04-16T18:18:08.8200737-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-16T18:18:08.8200737-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "169b8cc1-40f3-4bbe-b715-c1c835be8e29",
"EffectiveDate": "2026-04-16T18:18:08.8200737-07:00",
"StateType": {
"StateTypeId": "cdcc2da0-c66a-4e79-995a-3725af2ca4ff",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "08770128-b25d-4f45-ab2c-d03a2861cbdd",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1bc5b3a7-59b8-4735-989b-032b21209e17",
"CreateDate": "2026-04-16T18:18:08.8200737-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-16T18:18:08.8200737-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "e699dae2-2f62-4a90-b1f7-ae90e57acf63",
"CreateDate": "2026-04-16T18:18:08.8200737-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-16T18:18:08.8200737-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "93cc26ee-0e58-4014-8ee6-d6e016a580a0",
"CreateDate": "2026-04-16T18:18:08.8200737-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-16T18:18:08.8200737-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "c2f096e0-3de2-416b-a60f-b63fd821bcbd",
"EffectiveDate": "2026-04-16T18:18:08.8200737-07:00",
"StatusType": {
"StatusTypeId": "432236bb-2367-4ae8-af21-93761053e574",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "08770128-b25d-4f45-ab2c-d03a2861cbdd",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1bc5b3a7-59b8-4735-989b-032b21209e17",
"CreateDate": "2026-04-16T18:18:08.8200737-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-16T18:18:08.8200737-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "570ab98e-13ca-4515-9e34-fbde871453b4",
"CreateDate": "2026-04-16T18:18:08.8200737-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-16T18:18:08.8200737-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "dcf13867-245f-4101-8281-6664e2dd9108",
"CreateDate": "2026-04-16T18:18:08.8200737-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-16T18:18:08.8200737-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "46397fe2-020e-4872-8b8b-56dd787103d5",
"EffectiveDate": "2026-04-16T18:18:08.8200737-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "216d7a73-3323-4a9f-8b82-9ce0f147aeca",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3c3d59b6-fe2d-4d77-afd6-0b793e473a7d",
"CreateDate": "2026-04-16T18:18:08.8200737-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-16T18:18:08.8200737-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "641e9b3b-2f8d-4615-9cfd-11dac3b16ec6",
"CreateDate": "2026-04-16T18:18:08.8200737-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-16T18:18:08.8200737-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-04-16T18:18:08.8200737-07:00",
"MeasurementValueNeededDate": "2026-04-16T18:18:08.8200737-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "30c2a677-9c2c-43f0-a834-42be5bc96182",
"CreateDate": "2026-04-16T18:18:08.8200737-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-16T18:18:08.8200737-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "c38251ef-f99e-45d3-a353-e7f6237449a3",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "9820dfbb-e965-4475-86d0-4d06683fcb42",
"CreateDate": "2026-04-16T18:18:08.8200737-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-16T18:18:08.8200737-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-04-16T18:18:08.8200737-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ae900a36-2f37-430f-ad80-bc68576e9c09",
"CreateDate": "2026-04-16T18:18:08.8200737-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-16T18:18:08.8200737-07:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}