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": "37c61274-dd2f-43e7-a1bf-3a2c029ca81b",
"Asset": {
"AssetId": "a944977d-0c6c-4105-847c-808a65e42e41",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "49515a90-42b1-43c2-8c32-82f7adb838a1",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b5b32a94-1813-4972-94d9-5a5a653cc9c9",
"CreateDate": "2022-11-27T04:53:12.1129571-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2022-11-27T04:53:12.1129571-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "0a3388d4-05e8-4318-8c85-191285a5bc82",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2022-11-27T04:53:12.1129571-08:00",
"MeasurementValueNeededDate": "2022-11-27T04:53:12.1129571-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "6e152d9d-18dc-4822-a6bb-f9c6416b9ba5",
"CreateDate": "2022-11-27T04:53:12.1129571-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2022-11-27T04:53:12.1129571-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2022-11-27T04:53:12.1129571-08:00",
"MeasurementValueNeededDate": "2022-11-27T04:53:12.1129571-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "fb3e7568-0ffc-4b2d-948d-3171879724e4",
"CreateDate": "2022-11-27T04:53:12.1129571-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2022-11-27T04:53:12.1129571-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "f674c830-fd4b-4e97-9575-2c79affd2e4e",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "03ec1533-cca9-4fb3-af16-110b27c16c10",
"CreateDate": "2022-11-27T04:53:12.1129571-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2022-11-27T04:53:12.1129571-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2022-11-27T04:53:12.1129571-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0efd32c3-f08a-4b27-8614-1c7728d968bd",
"CreateDate": "2022-11-27T04:53:12.1129571-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2022-11-27T04:53:12.1129571-08:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "37c61274-dd2f-43e7-a1bf-3a2c029ca81b",
"Asset": {
"AssetId": "a944977d-0c6c-4105-847c-808a65e42e41",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "49515a90-42b1-43c2-8c32-82f7adb838a1",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b5b32a94-1813-4972-94d9-5a5a653cc9c9",
"CreateDate": "2022-11-27T04:53:12.1129571-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2022-11-27T04:53:12.1129571-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "0a3388d4-05e8-4318-8c85-191285a5bc82",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2022-11-27T04:53:12.1129571-08:00",
"MeasurementValueNeededDate": "2022-11-27T04:53:12.1129571-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "6e152d9d-18dc-4822-a6bb-f9c6416b9ba5",
"CreateDate": "2022-11-27T04:53:12.1129571-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2022-11-27T04:53:12.1129571-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2022-11-27T04:53:12.1129571-08:00",
"MeasurementValueNeededDate": "2022-11-27T04:53:12.1129571-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "fb3e7568-0ffc-4b2d-948d-3171879724e4",
"CreateDate": "2022-11-27T04:53:12.1129571-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2022-11-27T04:53:12.1129571-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "f674c830-fd4b-4e97-9575-2c79affd2e4e",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "03ec1533-cca9-4fb3-af16-110b27c16c10",
"CreateDate": "2022-11-27T04:53:12.1129571-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2022-11-27T04:53:12.1129571-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2022-11-27T04:53:12.1129571-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0efd32c3-f08a-4b27-8614-1c7728d968bd",
"CreateDate": "2022-11-27T04:53:12.1129571-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2022-11-27T04:53:12.1129571-08:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}