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": "9b5753ee-2868-4d06-aca7-3373140dad78",
"Asset": {
"AssetId": "f4c2bd27-6230-473d-a8e1-cca1d26b0400",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "996245fd-93a9-45be-b2fa-cdc01b83546f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "56a69b9e-7b2a-4654-92a4-e92ef88de727",
"CreateDate": "2025-07-17T08:25:22.0009468-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-17T08:25:22.0009468-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "c98228a3-0bfd-4f21-bbe9-b19da8b6e2c3",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-07-17T08:25:22.0009468-07:00",
"MeasurementValueNeededDate": "2025-07-17T08:25:22.0009468-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a17bc749-b8fe-4b40-a244-2121a12aadfa",
"CreateDate": "2025-07-17T08:25:22.0009468-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-17T08:25:22.0009468-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-07-17T08:25:22.0009468-07:00",
"MeasurementValueNeededDate": "2025-07-17T08:25:22.0009468-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "46da0de3-57d5-4177-823a-b54eada77d84",
"CreateDate": "2025-07-17T08:25:22.0009468-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-17T08:25:22.0009468-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "87aa6dd2-f20e-4b88-a196-d1753e0e8927",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "8e47a165-822f-4c62-9aeb-047628c548a0",
"CreateDate": "2025-07-17T08:25:22.0009468-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-17T08:25:22.0009468-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-07-17T08:25:22.0009468-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "978a62d9-fa58-4f11-8168-04a7d3bc3548",
"CreateDate": "2025-07-17T08:25:22.0009468-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-17T08:25:22.0009468-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "9b5753ee-2868-4d06-aca7-3373140dad78",
"Asset": {
"AssetId": "f4c2bd27-6230-473d-a8e1-cca1d26b0400",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "996245fd-93a9-45be-b2fa-cdc01b83546f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "56a69b9e-7b2a-4654-92a4-e92ef88de727",
"CreateDate": "2025-07-17T08:25:22.0009468-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-17T08:25:22.0009468-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "c98228a3-0bfd-4f21-bbe9-b19da8b6e2c3",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-07-17T08:25:22.0009468-07:00",
"MeasurementValueNeededDate": "2025-07-17T08:25:22.0009468-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a17bc749-b8fe-4b40-a244-2121a12aadfa",
"CreateDate": "2025-07-17T08:25:22.0009468-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-17T08:25:22.0009468-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-07-17T08:25:22.0009468-07:00",
"MeasurementValueNeededDate": "2025-07-17T08:25:22.0009468-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "46da0de3-57d5-4177-823a-b54eada77d84",
"CreateDate": "2025-07-17T08:25:22.0009468-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-17T08:25:22.0009468-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "87aa6dd2-f20e-4b88-a196-d1753e0e8927",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "8e47a165-822f-4c62-9aeb-047628c548a0",
"CreateDate": "2025-07-17T08:25:22.0009468-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-17T08:25:22.0009468-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-07-17T08:25:22.0009468-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "978a62d9-fa58-4f11-8168-04a7d3bc3548",
"CreateDate": "2025-07-17T08:25:22.0009468-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-17T08:25:22.0009468-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}