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": "e8266b54-7690-4b5e-99a8-4ad679c466d4", "Asset": { "AssetId": "a005c78c-cee8-412d-a69b-c35fbc0c7bfa", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "af08c235-ba66-4d75-954c-66eb89c3810d", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "40d99962-3e92-4cfe-a902-d9ff1e2bfb0f", "CreateDate": "2025-07-06T14:54:45.6833563-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-06T14:54:45.6833563-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "36b7de1c-af02-4338-9d86-0d19f817e6a5", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-06T14:54:45.6833563-07:00", "MeasurementValueNeededDate": "2025-07-06T14:54:45.6833563-07:00", "SourceSystemId": "sample string 3", "CompanyId": "3b84b21d-358f-4809-b3c4-aa9b4182cce3", "CreateDate": "2025-07-06T14:54:45.6833563-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-06T14:54:45.6833563-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-07-06T14:54:45.6833563-07:00", "MeasurementValueNeededDate": "2025-07-06T14:54:45.6833563-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "5fd62e3c-5b6d-4137-980d-faca4495f1b2", "CreateDate": "2025-07-06T14:54:45.6833563-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-06T14:54:45.6833563-07:00", "LastModifiedUser": "sample string 8" }, "NoteCategory": { "NoteCategoryId": "41320013-c9c6-4dd2-914d-c358a0214c2a", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "099d567f-5f26-44bc-bbe9-1cb4830cfb23", "CreateDate": "2025-07-06T14:54:45.6833563-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-07-06T14:54:45.6833563-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2025-07-06T14:54:45.6833563-07:00", "NoteHTML": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "b694496f-7305-4054-aa81-f987180f00fe", "CreateDate": "2025-07-06T14:54:45.6833563-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-07-06T14:54:45.6833563-07:00", "LastModifiedUser": "sample string 5" }, { "NoteId": "e8266b54-7690-4b5e-99a8-4ad679c466d4", "Asset": { "AssetId": "a005c78c-cee8-412d-a69b-c35fbc0c7bfa", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "af08c235-ba66-4d75-954c-66eb89c3810d", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "40d99962-3e92-4cfe-a902-d9ff1e2bfb0f", "CreateDate": "2025-07-06T14:54:45.6833563-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-06T14:54:45.6833563-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "36b7de1c-af02-4338-9d86-0d19f817e6a5", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-06T14:54:45.6833563-07:00", "MeasurementValueNeededDate": "2025-07-06T14:54:45.6833563-07:00", "SourceSystemId": "sample string 3", "CompanyId": "3b84b21d-358f-4809-b3c4-aa9b4182cce3", "CreateDate": "2025-07-06T14:54:45.6833563-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-06T14:54:45.6833563-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-07-06T14:54:45.6833563-07:00", "MeasurementValueNeededDate": "2025-07-06T14:54:45.6833563-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "5fd62e3c-5b6d-4137-980d-faca4495f1b2", "CreateDate": "2025-07-06T14:54:45.6833563-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-06T14:54:45.6833563-07:00", "LastModifiedUser": "sample string 8" }, "NoteCategory": { "NoteCategoryId": "41320013-c9c6-4dd2-914d-c358a0214c2a", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "099d567f-5f26-44bc-bbe9-1cb4830cfb23", "CreateDate": "2025-07-06T14:54:45.6833563-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-07-06T14:54:45.6833563-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2025-07-06T14:54:45.6833563-07:00", "NoteHTML": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "b694496f-7305-4054-aa81-f987180f00fe", "CreateDate": "2025-07-06T14:54:45.6833563-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-07-06T14:54:45.6833563-07:00", "LastModifiedUser": "sample string 5" } ], "Total": 1, "Message": "sample string 1" }