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": "f152c5e5-027e-4b89-a299-8e1388bedd7d",
"Asset": {
"AssetId": "afa533cc-bf65-4cd0-ba67-3beb4a97ec02",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a961dd05-df79-4a65-855e-dbfc5390ff6e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "43084e70-d6cb-4117-8ad1-047ee681aac8",
"CreateDate": "2026-09-23T15:08:26.8083096-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-23T15:08:26.8083096-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "2568e8f1-8f83-4246-88e9-0da467d8abb2",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-23T15:08:26.8083096-07:00",
"MeasurementValueNeededDate": "2026-09-23T15:08:26.8083096-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2f7e1b15-7bc6-4758-ad8c-ae8edbea9be2",
"CreateDate": "2026-09-23T15:08:26.8083096-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-23T15:08:26.8083096-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-09-23T15:08:26.8083096-07:00",
"MeasurementValueNeededDate": "2026-09-23T15:08:26.8083096-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e0a842ed-5e10-4e10-a28f-dfdda6eb2c73",
"CreateDate": "2026-09-23T15:08:26.8083096-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-23T15:08:26.8083096-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "4172cdb7-47c7-4a78-9b43-bfb0eedb5920",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "25e2e5f5-090a-4239-abcf-803cb7521930",
"CreateDate": "2026-09-23T15:08:26.8083096-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-23T15:08:26.8083096-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-23T15:08:26.8083096-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "66e00c53-7c42-487d-bd44-a360bc5af186",
"CreateDate": "2026-09-23T15:08:26.8083096-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-23T15:08:26.8083096-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "f152c5e5-027e-4b89-a299-8e1388bedd7d",
"Asset": {
"AssetId": "afa533cc-bf65-4cd0-ba67-3beb4a97ec02",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a961dd05-df79-4a65-855e-dbfc5390ff6e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "43084e70-d6cb-4117-8ad1-047ee681aac8",
"CreateDate": "2026-09-23T15:08:26.8083096-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-23T15:08:26.8083096-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "2568e8f1-8f83-4246-88e9-0da467d8abb2",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-23T15:08:26.8083096-07:00",
"MeasurementValueNeededDate": "2026-09-23T15:08:26.8083096-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2f7e1b15-7bc6-4758-ad8c-ae8edbea9be2",
"CreateDate": "2026-09-23T15:08:26.8083096-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-23T15:08:26.8083096-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-09-23T15:08:26.8083096-07:00",
"MeasurementValueNeededDate": "2026-09-23T15:08:26.8083096-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e0a842ed-5e10-4e10-a28f-dfdda6eb2c73",
"CreateDate": "2026-09-23T15:08:26.8083096-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-23T15:08:26.8083096-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "4172cdb7-47c7-4a78-9b43-bfb0eedb5920",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "25e2e5f5-090a-4239-abcf-803cb7521930",
"CreateDate": "2026-09-23T15:08:26.8083096-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-23T15:08:26.8083096-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-23T15:08:26.8083096-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "66e00c53-7c42-487d-bd44-a360bc5af186",
"CreateDate": "2026-09-23T15:08:26.8083096-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-23T15:08:26.8083096-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}