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": "aff8aa75-414c-4c8e-a237-a18d44a244b1",
"Asset": {
"AssetId": "20daea00-129a-408f-83f6-5d92b1c5a1de",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "3105345b-d47f-4b80-a7e3-3721b0604cd7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "42adb8d2-5b04-41c6-a77f-283c48a63afa",
"CreateDate": "2026-06-12T20:23:19.024127-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-12T20:23:19.024127-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "f4f53a3c-2bd5-4435-8335-9842f40f8678",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-12T20:23:19.024127-07:00",
"MeasurementValueNeededDate": "2026-06-12T20:23:19.024127-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "204df745-fdef-46d8-8835-8a8d49e327ab",
"CreateDate": "2026-06-12T20:23:19.024127-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-12T20:23:19.024127-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-06-12T20:23:19.024127-07:00",
"MeasurementValueNeededDate": "2026-06-12T20:23:19.024127-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "0d95647e-2861-4f7e-baa5-dba9012cb018",
"CreateDate": "2026-06-12T20:23:19.024127-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-12T20:23:19.024127-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "177bde01-011b-4655-9924-4c9cbf585200",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "304fb9de-926a-49fd-9c0a-b0d2fe2d2f67",
"CreateDate": "2026-06-12T20:23:19.024127-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-12T20:23:19.024127-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-06-12T20:23:19.024127-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "db1568e4-3d26-416d-871c-5c8406965f85",
"CreateDate": "2026-06-12T20:23:19.024127-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-12T20:23:19.024127-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "aff8aa75-414c-4c8e-a237-a18d44a244b1",
"Asset": {
"AssetId": "20daea00-129a-408f-83f6-5d92b1c5a1de",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "3105345b-d47f-4b80-a7e3-3721b0604cd7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "42adb8d2-5b04-41c6-a77f-283c48a63afa",
"CreateDate": "2026-06-12T20:23:19.024127-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-12T20:23:19.024127-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "f4f53a3c-2bd5-4435-8335-9842f40f8678",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-12T20:23:19.024127-07:00",
"MeasurementValueNeededDate": "2026-06-12T20:23:19.024127-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "204df745-fdef-46d8-8835-8a8d49e327ab",
"CreateDate": "2026-06-12T20:23:19.024127-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-12T20:23:19.024127-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-06-12T20:23:19.024127-07:00",
"MeasurementValueNeededDate": "2026-06-12T20:23:19.024127-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "0d95647e-2861-4f7e-baa5-dba9012cb018",
"CreateDate": "2026-06-12T20:23:19.024127-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-12T20:23:19.024127-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "177bde01-011b-4655-9924-4c9cbf585200",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "304fb9de-926a-49fd-9c0a-b0d2fe2d2f67",
"CreateDate": "2026-06-12T20:23:19.024127-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-12T20:23:19.024127-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-06-12T20:23:19.024127-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "db1568e4-3d26-416d-871c-5c8406965f85",
"CreateDate": "2026-06-12T20:23:19.024127-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-12T20:23:19.024127-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}