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": "d6cf0f15-04cb-44e4-8a9f-e4a89fceb7bc",
"Asset": {
"AssetId": "20d69090-0d38-43a5-9714-36667c4bcf32",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "73869bdd-d63a-4ec8-9ac4-b76a6b756cae",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "74eeab25-f3af-414d-8183-a5d9cd07ec44",
"CreateDate": "2025-07-03T19:42:08.0194595-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-03T19:42:08.0194595-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "555605d7-bb02-44aa-8e5b-5dce9160d0d8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-07-03T19:42:08.0194595-07:00",
"MeasurementValueNeededDate": "2025-07-03T19:42:08.0194595-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ae393b41-ac79-4575-928c-7c916f014c3b",
"CreateDate": "2025-07-03T19:42:08.0194595-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-03T19:42:08.0194595-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "720c205a-93bd-4407-952b-c7945d6a6e59",
"EffectiveDate": "2025-07-03T19:42:08.0194595-07:00",
"StateType": {
"StateTypeId": "57491db9-1c82-4119-92b8-9cad766b3277",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "73869bdd-d63a-4ec8-9ac4-b76a6b756cae",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "74eeab25-f3af-414d-8183-a5d9cd07ec44",
"CreateDate": "2025-07-03T19:42:08.0194595-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-03T19:42:08.0194595-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "f6c7657d-1c30-43c3-b9da-f1d777006f1f",
"CreateDate": "2025-07-03T19:42:08.0194595-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-03T19:42:08.0194595-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "fce60013-b4aa-4565-8569-9266fb8da677",
"CreateDate": "2025-07-03T19:42:08.0194595-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-03T19:42:08.0194595-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "3647788d-f3db-4b50-b7ea-7937bc0b18e5",
"EffectiveDate": "2025-07-03T19:42:08.0194595-07:00",
"StatusType": {
"StatusTypeId": "ddda8bb1-d4f9-49eb-a452-9d47d408c3bf",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "73869bdd-d63a-4ec8-9ac4-b76a6b756cae",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "74eeab25-f3af-414d-8183-a5d9cd07ec44",
"CreateDate": "2025-07-03T19:42:08.0194595-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-03T19:42:08.0194595-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "1f5ab88e-f2f7-4ce4-b34c-e8d3695bf636",
"CreateDate": "2025-07-03T19:42:08.0194595-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-03T19:42:08.0194595-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "10dbfa9b-14d0-4116-b7c0-4e8dd9e9ed0a",
"CreateDate": "2025-07-03T19:42:08.0194595-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-03T19:42:08.0194595-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "f8270b6b-1b9b-4890-833b-eddece353603",
"EffectiveDate": "2025-07-03T19:42:08.0194595-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "083d2852-8239-4bc1-b350-503dd3634d7b",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ede906c4-16c2-49d0-8113-513a58f3e9dc",
"CreateDate": "2025-07-03T19:42:08.0194595-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-03T19:42:08.0194595-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0f66a33a-6ab5-44ab-abfe-ec093bd4642d",
"CreateDate": "2025-07-03T19:42:08.0194595-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-03T19:42:08.0194595-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-07-03T19:42:08.0194595-07:00",
"MeasurementValueNeededDate": "2025-07-03T19:42:08.0194595-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "be8bba6d-fcae-499a-836f-7efd58e754c4",
"CreateDate": "2025-07-03T19:42:08.0194595-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-03T19:42:08.0194595-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "7a8667ce-7fa9-4090-b642-ac269c7f653c",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "384c79fb-cd43-4707-8a75-114eb332a2b3",
"CreateDate": "2025-07-03T19:42:08.0194595-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-03T19:42:08.0194595-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-07-03T19:42:08.0194595-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ead96910-b934-44a0-920a-229b81a05e45",
"CreateDate": "2025-07-03T19:42:08.0194595-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-03T19:42:08.0194595-07:00",
"LastModifiedUser": "sample string 6"
},
{
"NoteId": "d6cf0f15-04cb-44e4-8a9f-e4a89fceb7bc",
"Asset": {
"AssetId": "20d69090-0d38-43a5-9714-36667c4bcf32",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "73869bdd-d63a-4ec8-9ac4-b76a6b756cae",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "74eeab25-f3af-414d-8183-a5d9cd07ec44",
"CreateDate": "2025-07-03T19:42:08.0194595-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-03T19:42:08.0194595-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "555605d7-bb02-44aa-8e5b-5dce9160d0d8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-07-03T19:42:08.0194595-07:00",
"MeasurementValueNeededDate": "2025-07-03T19:42:08.0194595-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ae393b41-ac79-4575-928c-7c916f014c3b",
"CreateDate": "2025-07-03T19:42:08.0194595-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-03T19:42:08.0194595-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "720c205a-93bd-4407-952b-c7945d6a6e59",
"EffectiveDate": "2025-07-03T19:42:08.0194595-07:00",
"StateType": {
"StateTypeId": "57491db9-1c82-4119-92b8-9cad766b3277",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "73869bdd-d63a-4ec8-9ac4-b76a6b756cae",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "74eeab25-f3af-414d-8183-a5d9cd07ec44",
"CreateDate": "2025-07-03T19:42:08.0194595-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-03T19:42:08.0194595-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "f6c7657d-1c30-43c3-b9da-f1d777006f1f",
"CreateDate": "2025-07-03T19:42:08.0194595-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-03T19:42:08.0194595-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "fce60013-b4aa-4565-8569-9266fb8da677",
"CreateDate": "2025-07-03T19:42:08.0194595-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-03T19:42:08.0194595-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "3647788d-f3db-4b50-b7ea-7937bc0b18e5",
"EffectiveDate": "2025-07-03T19:42:08.0194595-07:00",
"StatusType": {
"StatusTypeId": "ddda8bb1-d4f9-49eb-a452-9d47d408c3bf",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "73869bdd-d63a-4ec8-9ac4-b76a6b756cae",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "74eeab25-f3af-414d-8183-a5d9cd07ec44",
"CreateDate": "2025-07-03T19:42:08.0194595-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-03T19:42:08.0194595-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "1f5ab88e-f2f7-4ce4-b34c-e8d3695bf636",
"CreateDate": "2025-07-03T19:42:08.0194595-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-03T19:42:08.0194595-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "10dbfa9b-14d0-4116-b7c0-4e8dd9e9ed0a",
"CreateDate": "2025-07-03T19:42:08.0194595-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-03T19:42:08.0194595-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "f8270b6b-1b9b-4890-833b-eddece353603",
"EffectiveDate": "2025-07-03T19:42:08.0194595-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "083d2852-8239-4bc1-b350-503dd3634d7b",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ede906c4-16c2-49d0-8113-513a58f3e9dc",
"CreateDate": "2025-07-03T19:42:08.0194595-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-03T19:42:08.0194595-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0f66a33a-6ab5-44ab-abfe-ec093bd4642d",
"CreateDate": "2025-07-03T19:42:08.0194595-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-03T19:42:08.0194595-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-07-03T19:42:08.0194595-07:00",
"MeasurementValueNeededDate": "2025-07-03T19:42:08.0194595-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "be8bba6d-fcae-499a-836f-7efd58e754c4",
"CreateDate": "2025-07-03T19:42:08.0194595-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-03T19:42:08.0194595-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "7a8667ce-7fa9-4090-b642-ac269c7f653c",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "384c79fb-cd43-4707-8a75-114eb332a2b3",
"CreateDate": "2025-07-03T19:42:08.0194595-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-03T19:42:08.0194595-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-07-03T19:42:08.0194595-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ead96910-b934-44a0-920a-229b81a05e45",
"CreateDate": "2025-07-03T19:42:08.0194595-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-03T19:42:08.0194595-07:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}