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": "c04203da-5eb1-4ef8-9e48-9a61bb13ea8b",
"Asset": {
"AssetId": "8a87e603-de53-4677-bf1b-2626f261f963",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a282ab97-fd67-458d-be62-e727efd5dbf1",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0009fe51-8930-4b81-911c-cef503865878",
"CreateDate": "2026-04-27T20:29:18.1175905-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-27T20:29:18.1175905-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "bb45d927-f44e-48dd-9fc5-836adc60e6c2",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-27T20:29:18.1175905-07:00",
"MeasurementValueNeededDate": "2026-04-27T20:29:18.1175905-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "efceed0e-cd7f-4c6f-8835-de36142948f4",
"CreateDate": "2026-04-27T20:29:18.1175905-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T20:29:18.1175905-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-04-27T20:29:18.1175905-07:00",
"MeasurementValueNeededDate": "2026-04-27T20:29:18.1175905-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "14fb0bf6-6ee9-4ac3-9ec4-ec0160c3c4b9",
"CreateDate": "2026-04-27T20:29:18.1175905-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-27T20:29:18.1175905-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "ae4f22a9-6eee-4b25-9e32-14e9583ccd8e",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "5df44657-5890-4957-b823-0ddc7990d7ab",
"CreateDate": "2026-04-27T20:29:18.1175905-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-27T20:29:18.1175905-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-04-27T20:29:18.1175905-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "40748e04-a3f8-4477-84fb-cfc0de73dca5",
"CreateDate": "2026-04-27T20:29:18.1175905-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-27T20:29:18.1175905-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "c04203da-5eb1-4ef8-9e48-9a61bb13ea8b",
"Asset": {
"AssetId": "8a87e603-de53-4677-bf1b-2626f261f963",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a282ab97-fd67-458d-be62-e727efd5dbf1",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0009fe51-8930-4b81-911c-cef503865878",
"CreateDate": "2026-04-27T20:29:18.1175905-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-27T20:29:18.1175905-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "bb45d927-f44e-48dd-9fc5-836adc60e6c2",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-27T20:29:18.1175905-07:00",
"MeasurementValueNeededDate": "2026-04-27T20:29:18.1175905-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "efceed0e-cd7f-4c6f-8835-de36142948f4",
"CreateDate": "2026-04-27T20:29:18.1175905-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T20:29:18.1175905-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-04-27T20:29:18.1175905-07:00",
"MeasurementValueNeededDate": "2026-04-27T20:29:18.1175905-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "14fb0bf6-6ee9-4ac3-9ec4-ec0160c3c4b9",
"CreateDate": "2026-04-27T20:29:18.1175905-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-27T20:29:18.1175905-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "ae4f22a9-6eee-4b25-9e32-14e9583ccd8e",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "5df44657-5890-4957-b823-0ddc7990d7ab",
"CreateDate": "2026-04-27T20:29:18.1175905-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-27T20:29:18.1175905-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-04-27T20:29:18.1175905-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "40748e04-a3f8-4477-84fb-cfc0de73dca5",
"CreateDate": "2026-04-27T20:29:18.1175905-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-27T20:29:18.1175905-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}