GET Notes/ByEffectiveDate?assetId={assetId}&beginDate={beginDate}&endDate={endDate}
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. |
| beginDate |
Beginning effective date of the notes to retrieve |
date |
None. |
| endDate |
Ending effective date of the notes to retrieve |
date |
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": "373528ba-782a-417c-82b4-40b2ab1bc50b",
"Asset": {
"AssetId": "5aa32c6e-1195-4a98-9820-52c283af08b7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "855dc76b-9b45-4198-8f07-b96dc2643df4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b4ee88fd-72f7-4da3-9c44-2016f544ec66",
"CreateDate": "2026-05-04T12:30:21.7660501-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-04T12:30:21.7660501-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "acd89f62-e404-4c47-b767-1ce2a1329a6f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-04T12:30:21.7660501-07:00",
"MeasurementValueNeededDate": "2026-05-04T12:30:21.7660501-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "1d7d8e3b-0095-431c-9542-26f7c28a0d2e",
"CreateDate": "2026-05-04T12:30:21.7660501-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-04T12:30:21.7660501-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-05-04T12:30:21.7660501-07:00",
"MeasurementValueNeededDate": "2026-05-04T12:30:21.7660501-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "5d6f4b59-6302-4c41-9170-c5cee8dd80e7",
"CreateDate": "2026-05-04T12:30:21.7660501-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-04T12:30:21.7660501-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "d04b3408-04e6-4067-b7d7-77e8622e4153",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "54f5b18d-7f07-419a-b920-fc2305b59eb3",
"CreateDate": "2026-05-04T12:30:21.7660501-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-04T12:30:21.7660501-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-05-04T12:30:21.7660501-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e37e9ce9-cfaa-460e-8d77-857bca2deb08",
"CreateDate": "2026-05-04T12:30:21.7660501-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-04T12:30:21.7660501-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "373528ba-782a-417c-82b4-40b2ab1bc50b",
"Asset": {
"AssetId": "5aa32c6e-1195-4a98-9820-52c283af08b7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "855dc76b-9b45-4198-8f07-b96dc2643df4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b4ee88fd-72f7-4da3-9c44-2016f544ec66",
"CreateDate": "2026-05-04T12:30:21.7660501-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-04T12:30:21.7660501-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "acd89f62-e404-4c47-b767-1ce2a1329a6f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-04T12:30:21.7660501-07:00",
"MeasurementValueNeededDate": "2026-05-04T12:30:21.7660501-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "1d7d8e3b-0095-431c-9542-26f7c28a0d2e",
"CreateDate": "2026-05-04T12:30:21.7660501-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-04T12:30:21.7660501-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-05-04T12:30:21.7660501-07:00",
"MeasurementValueNeededDate": "2026-05-04T12:30:21.7660501-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "5d6f4b59-6302-4c41-9170-c5cee8dd80e7",
"CreateDate": "2026-05-04T12:30:21.7660501-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-04T12:30:21.7660501-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "d04b3408-04e6-4067-b7d7-77e8622e4153",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "54f5b18d-7f07-419a-b920-fc2305b59eb3",
"CreateDate": "2026-05-04T12:30:21.7660501-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-04T12:30:21.7660501-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-05-04T12:30:21.7660501-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e37e9ce9-cfaa-460e-8d77-857bca2deb08",
"CreateDate": "2026-05-04T12:30:21.7660501-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-04T12:30:21.7660501-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}