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": "79b5c1c2-13a9-4ee6-8473-42972c1633f8", "Asset": { "AssetId": "79c4b19c-fe32-4b71-92f9-2070b00850f6", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "e66ecd37-3186-43f4-8bef-fbe6a60ac236", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "bef695d4-b5a2-4175-958f-3356db66c4eb", "CreateDate": "2025-06-22T23:43:23.1810627-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-22T23:43:23.1810627-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "0e15700c-6550-4fc2-a127-debb608e60c8", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-22T23:43:23.1810627-07:00", "MeasurementValueNeededDate": "2025-06-22T23:43:23.1810627-07:00", "SourceSystemId": "sample string 3", "CompanyId": "1c65b5fc-00f3-480c-82fe-a4ea204f7d4a", "CreateDate": "2025-06-22T23:43:23.1810627-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T23:43:23.1810627-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-06-22T23:43:23.1810627-07:00", "MeasurementValueNeededDate": "2025-06-22T23:43:23.1810627-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "d584c643-474a-45d2-8cf5-ac2f6f80d839", "CreateDate": "2025-06-22T23:43:23.1810627-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-22T23:43:23.1810627-07:00", "LastModifiedUser": "sample string 8" }, "NoteCategory": { "NoteCategoryId": "fbe41d42-69e5-4607-95fd-4c654221c3ae", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "9e9a9e5d-3302-46e5-bc57-efe8ed4d0366", "CreateDate": "2025-06-22T23:43:23.1810627-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-06-22T23:43:23.1810627-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2025-06-22T23:43:23.1810627-07:00", "NoteHTML": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "90707398-56d7-412b-850d-ed72bf67949e", "CreateDate": "2025-06-22T23:43:23.1810627-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-06-22T23:43:23.1810627-07:00", "LastModifiedUser": "sample string 5" }, { "NoteId": "79b5c1c2-13a9-4ee6-8473-42972c1633f8", "Asset": { "AssetId": "79c4b19c-fe32-4b71-92f9-2070b00850f6", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "e66ecd37-3186-43f4-8bef-fbe6a60ac236", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "bef695d4-b5a2-4175-958f-3356db66c4eb", "CreateDate": "2025-06-22T23:43:23.1810627-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-22T23:43:23.1810627-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "0e15700c-6550-4fc2-a127-debb608e60c8", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-22T23:43:23.1810627-07:00", "MeasurementValueNeededDate": "2025-06-22T23:43:23.1810627-07:00", "SourceSystemId": "sample string 3", "CompanyId": "1c65b5fc-00f3-480c-82fe-a4ea204f7d4a", "CreateDate": "2025-06-22T23:43:23.1810627-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T23:43:23.1810627-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-06-22T23:43:23.1810627-07:00", "MeasurementValueNeededDate": "2025-06-22T23:43:23.1810627-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "d584c643-474a-45d2-8cf5-ac2f6f80d839", "CreateDate": "2025-06-22T23:43:23.1810627-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-22T23:43:23.1810627-07:00", "LastModifiedUser": "sample string 8" }, "NoteCategory": { "NoteCategoryId": "fbe41d42-69e5-4607-95fd-4c654221c3ae", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "9e9a9e5d-3302-46e5-bc57-efe8ed4d0366", "CreateDate": "2025-06-22T23:43:23.1810627-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-06-22T23:43:23.1810627-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2025-06-22T23:43:23.1810627-07:00", "NoteHTML": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "90707398-56d7-412b-850d-ed72bf67949e", "CreateDate": "2025-06-22T23:43:23.1810627-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-06-22T23:43:23.1810627-07:00", "LastModifiedUser": "sample string 5" } ], "Total": 1, "Message": "sample string 1" }