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": "3866976b-652c-4e8e-8035-ebeb65529155",
"Asset": {
"AssetId": "4c47db29-8866-4f9b-9aa9-61e7b5027af0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a7e8cd30-7c4f-4a9a-972b-3e6eb69866cc",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "781dffe3-1fc3-4171-b3dd-78945b780114",
"CreateDate": "2026-09-02T00:35:18.3883218-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-02T00:35:18.3883218-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "18c1f910-5f1d-4764-afbb-70a3bc8d2b27",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-02T00:35:18.3883218-07:00",
"MeasurementValueNeededDate": "2026-09-02T00:35:18.3883218-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "6175ef27-b2bd-4d8e-bf5c-a19b072dc772",
"CreateDate": "2026-09-02T00:35:18.3883218-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-02T00:35:18.3883218-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-09-02T00:35:18.3883218-07:00",
"MeasurementValueNeededDate": "2026-09-02T00:35:18.3883218-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "cd033f45-b993-4824-9453-76977a1e4714",
"CreateDate": "2026-09-02T00:35:18.3883218-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-02T00:35:18.3883218-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "2bcc0bf4-8498-4c0b-8efa-944b9ba53104",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "36d1067f-fc34-4d53-a94b-6dd551e6f133",
"CreateDate": "2026-09-02T00:35:18.3883218-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-02T00:35:18.3883218-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-02T00:35:18.3883218-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e9d0c308-42d3-40d2-a28d-63f24da8781d",
"CreateDate": "2026-09-02T00:35:18.3883218-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-02T00:35:18.3883218-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "3866976b-652c-4e8e-8035-ebeb65529155",
"Asset": {
"AssetId": "4c47db29-8866-4f9b-9aa9-61e7b5027af0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a7e8cd30-7c4f-4a9a-972b-3e6eb69866cc",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "781dffe3-1fc3-4171-b3dd-78945b780114",
"CreateDate": "2026-09-02T00:35:18.3883218-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-02T00:35:18.3883218-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "18c1f910-5f1d-4764-afbb-70a3bc8d2b27",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-02T00:35:18.3883218-07:00",
"MeasurementValueNeededDate": "2026-09-02T00:35:18.3883218-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "6175ef27-b2bd-4d8e-bf5c-a19b072dc772",
"CreateDate": "2026-09-02T00:35:18.3883218-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-02T00:35:18.3883218-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-09-02T00:35:18.3883218-07:00",
"MeasurementValueNeededDate": "2026-09-02T00:35:18.3883218-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "cd033f45-b993-4824-9453-76977a1e4714",
"CreateDate": "2026-09-02T00:35:18.3883218-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-02T00:35:18.3883218-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "2bcc0bf4-8498-4c0b-8efa-944b9ba53104",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "36d1067f-fc34-4d53-a94b-6dd551e6f133",
"CreateDate": "2026-09-02T00:35:18.3883218-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-02T00:35:18.3883218-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-02T00:35:18.3883218-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e9d0c308-42d3-40d2-a28d-63f24da8781d",
"CreateDate": "2026-09-02T00:35:18.3883218-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-02T00:35:18.3883218-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}