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": "52f72faa-7613-446b-bab8-60a25ac8c76c",
"Asset": {
"AssetId": "517b1aba-f8eb-4ef8-b87f-8cfb6fed865d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "0fbfa691-1bde-4ba2-9714-1cbb7e5ba23f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "48717d55-03bf-4c45-bcc7-096b6ba774ca",
"CreateDate": "2024-12-08T16:57:41.7501471-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-12-08T16:57:41.7501471-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "a838865a-8215-4213-a422-f7c7c3d5b9b8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-12-08T16:57:41.7501471-08:00",
"MeasurementValueNeededDate": "2024-12-08T16:57:41.7501471-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "69f946e1-4eee-4afe-9c8c-0b9961520fc1",
"CreateDate": "2024-12-08T16:57:41.7501471-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-08T16:57:41.7501471-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2024-12-08T16:57:41.7501471-08:00",
"MeasurementValueNeededDate": "2024-12-08T16:57:41.7501471-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "c01a4755-73b0-44bd-85c1-e1aa2c48d757",
"CreateDate": "2024-12-08T16:57:41.7501471-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-12-08T16:57:41.7501471-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "06811f79-455c-4758-8a05-804051f3444e",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "5cfdc0aa-4c73-4420-aca9-7ee6ac04ca50",
"CreateDate": "2024-12-08T16:57:41.7501471-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-12-08T16:57:41.7501471-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2024-12-08T16:57:41.7501471-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f18c5a8d-d976-42e4-bb0a-0eac5a95da58",
"CreateDate": "2024-12-08T16:57:41.7501471-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-12-08T16:57:41.7501471-08:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "52f72faa-7613-446b-bab8-60a25ac8c76c",
"Asset": {
"AssetId": "517b1aba-f8eb-4ef8-b87f-8cfb6fed865d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "0fbfa691-1bde-4ba2-9714-1cbb7e5ba23f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "48717d55-03bf-4c45-bcc7-096b6ba774ca",
"CreateDate": "2024-12-08T16:57:41.7501471-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-12-08T16:57:41.7501471-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "a838865a-8215-4213-a422-f7c7c3d5b9b8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-12-08T16:57:41.7501471-08:00",
"MeasurementValueNeededDate": "2024-12-08T16:57:41.7501471-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "69f946e1-4eee-4afe-9c8c-0b9961520fc1",
"CreateDate": "2024-12-08T16:57:41.7501471-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-08T16:57:41.7501471-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2024-12-08T16:57:41.7501471-08:00",
"MeasurementValueNeededDate": "2024-12-08T16:57:41.7501471-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "c01a4755-73b0-44bd-85c1-e1aa2c48d757",
"CreateDate": "2024-12-08T16:57:41.7501471-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-12-08T16:57:41.7501471-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "06811f79-455c-4758-8a05-804051f3444e",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "5cfdc0aa-4c73-4420-aca9-7ee6ac04ca50",
"CreateDate": "2024-12-08T16:57:41.7501471-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-12-08T16:57:41.7501471-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2024-12-08T16:57:41.7501471-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f18c5a8d-d976-42e4-bb0a-0eac5a95da58",
"CreateDate": "2024-12-08T16:57:41.7501471-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-12-08T16:57:41.7501471-08:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}