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": "54233b78-8a19-48df-b841-3756b29826c8",
"Asset": {
"AssetId": "12a439c0-1730-4faf-8c02-86dacc67b220",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "21146863-e2a6-42d7-b609-a12dd4467b16",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f85a526c-e621-4691-915b-99fb85184d31",
"CreateDate": "2024-10-10T04:06:16.475378-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-10-10T04:06:16.475378-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "f2f1dc9b-dd09-43e2-83fb-8d85bb4879ef",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-10-10T04:06:16.475378-07:00",
"MeasurementValueNeededDate": "2024-10-10T04:06:16.475378-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b40ee139-6ccb-46c8-bcc1-8b98316e6216",
"CreateDate": "2024-10-10T04:06:16.475378-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-10-10T04:06:16.475378-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2024-10-10T04:06:16.475378-07:00",
"MeasurementValueNeededDate": "2024-10-10T04:06:16.475378-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "1826875b-910a-4ea2-b82c-19c16d235317",
"CreateDate": "2024-10-10T04:06:16.475378-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-10-10T04:06:16.475378-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "1b3e9c7d-4123-4dfb-98d0-119f0f705cb6",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "5abd106e-57f6-4823-abe5-a903a1460cab",
"CreateDate": "2024-10-10T04:06:16.475378-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-10-10T04:06:16.475378-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2024-10-10T04:06:16.475378-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "a60aa374-a3b7-4287-b993-5c1377a40d12",
"CreateDate": "2024-10-10T04:06:16.475378-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-10-10T04:06:16.475378-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "54233b78-8a19-48df-b841-3756b29826c8",
"Asset": {
"AssetId": "12a439c0-1730-4faf-8c02-86dacc67b220",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "21146863-e2a6-42d7-b609-a12dd4467b16",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f85a526c-e621-4691-915b-99fb85184d31",
"CreateDate": "2024-10-10T04:06:16.475378-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-10-10T04:06:16.475378-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "f2f1dc9b-dd09-43e2-83fb-8d85bb4879ef",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-10-10T04:06:16.475378-07:00",
"MeasurementValueNeededDate": "2024-10-10T04:06:16.475378-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b40ee139-6ccb-46c8-bcc1-8b98316e6216",
"CreateDate": "2024-10-10T04:06:16.475378-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-10-10T04:06:16.475378-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2024-10-10T04:06:16.475378-07:00",
"MeasurementValueNeededDate": "2024-10-10T04:06:16.475378-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "1826875b-910a-4ea2-b82c-19c16d235317",
"CreateDate": "2024-10-10T04:06:16.475378-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-10-10T04:06:16.475378-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "1b3e9c7d-4123-4dfb-98d0-119f0f705cb6",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "5abd106e-57f6-4823-abe5-a903a1460cab",
"CreateDate": "2024-10-10T04:06:16.475378-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-10-10T04:06:16.475378-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2024-10-10T04:06:16.475378-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "a60aa374-a3b7-4287-b993-5c1377a40d12",
"CreateDate": "2024-10-10T04:06:16.475378-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-10-10T04:06:16.475378-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}