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 DataFilter |
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": "71587650-7d91-4ff5-9f96-abe8e11e58fd",
"Asset": {
"AssetId": "cc000159-c9d0-47ff-a83a-37ea0ac8c212",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "6e1fc703-d43c-44d7-b753-d64d0dc18d6c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b5ecc8db-4f14-4922-90de-aec61465c87a",
"CreateDate": "2021-04-17T08:14:56.8925923-07:00",
"CreateUser": "sample string 6",
"CreateMachine": "sample string 7",
"LastModifiedDate": "2021-04-17T08:14:56.8925923-07:00",
"LastModifiedUser": "sample string 8",
"LastModifiedMachine": "sample string 9"
},
"AssetGroup": {
"AssetGroupId": "34698c47-c22b-47bd-8e28-f3d39ba49fd8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2021-04-17T08:14:56.8925923-07:00",
"MeasurementValueNeededDate": "2021-04-17T08:14:56.8925923-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "38ae6265-a77f-465b-aca6-f6213659ab28",
"CreateDate": "2021-04-17T08:14:56.8925923-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T08:14:56.8925923-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
"ParentAsset": null,
"WellKnownText": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2021-04-17T08:14:56.8925923-07:00",
"MeasurementValueNeededDate": "2021-04-17T08:14:56.8925923-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "74af47ee-0f39-435f-84a3-9ac4d2d77a19",
"CreateDate": "2021-04-17T08:14:56.8925923-07:00",
"CreateUser": "sample string 7",
"CreateMachine": "sample string 8",
"LastModifiedDate": "2021-04-17T08:14:56.8925923-07:00",
"LastModifiedUser": "sample string 9",
"LastModifiedMachine": "sample string 10"
},
"EffectiveDate": "2021-04-17T08:14:56.8925923-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "b07fed1d-de97-4bd6-abf4-c4c5179201f7",
"CreateDate": "2021-04-17T08:14:56.8925923-07:00",
"CreateUser": "sample string 4",
"CreateMachine": "sample string 5",
"LastModifiedDate": "2021-04-17T08:14:56.8925923-07:00",
"LastModifiedUser": "sample string 6",
"LastModifiedMachine": "sample string 7"
},
{
"NoteId": "71587650-7d91-4ff5-9f96-abe8e11e58fd",
"Asset": {
"AssetId": "cc000159-c9d0-47ff-a83a-37ea0ac8c212",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "6e1fc703-d43c-44d7-b753-d64d0dc18d6c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b5ecc8db-4f14-4922-90de-aec61465c87a",
"CreateDate": "2021-04-17T08:14:56.8925923-07:00",
"CreateUser": "sample string 6",
"CreateMachine": "sample string 7",
"LastModifiedDate": "2021-04-17T08:14:56.8925923-07:00",
"LastModifiedUser": "sample string 8",
"LastModifiedMachine": "sample string 9"
},
"AssetGroup": {
"AssetGroupId": "34698c47-c22b-47bd-8e28-f3d39ba49fd8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2021-04-17T08:14:56.8925923-07:00",
"MeasurementValueNeededDate": "2021-04-17T08:14:56.8925923-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "38ae6265-a77f-465b-aca6-f6213659ab28",
"CreateDate": "2021-04-17T08:14:56.8925923-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T08:14:56.8925923-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
"ParentAsset": null,
"WellKnownText": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2021-04-17T08:14:56.8925923-07:00",
"MeasurementValueNeededDate": "2021-04-17T08:14:56.8925923-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "74af47ee-0f39-435f-84a3-9ac4d2d77a19",
"CreateDate": "2021-04-17T08:14:56.8925923-07:00",
"CreateUser": "sample string 7",
"CreateMachine": "sample string 8",
"LastModifiedDate": "2021-04-17T08:14:56.8925923-07:00",
"LastModifiedUser": "sample string 9",
"LastModifiedMachine": "sample string 10"
},
"EffectiveDate": "2021-04-17T08:14:56.8925923-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "b07fed1d-de97-4bd6-abf4-c4c5179201f7",
"CreateDate": "2021-04-17T08:14:56.8925923-07:00",
"CreateUser": "sample string 4",
"CreateMachine": "sample string 5",
"LastModifiedDate": "2021-04-17T08:14:56.8925923-07:00",
"LastModifiedUser": "sample string 6",
"LastModifiedMachine": "sample string 7"
}
],
"Total": 1,
"Message": "sample string 1"
}