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": "a1d67fc5-49a2-44d7-99e1-e7bac6eb2f3e",
"Asset": {
"AssetId": "01578f25-f039-4564-b491-464cfbeef8b6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "8dbd1dd8-2063-44cb-87fd-7685c1176700",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "115c7eaf-6897-45d9-ab13-a33add7dab4f",
"CreateDate": "2026-03-24T08:03:08.4007943-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-24T08:03:08.4007943-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "98873f1e-ca45-424d-b81d-39ae20823f13",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-24T08:03:08.4007943-07:00",
"MeasurementValueNeededDate": "2026-03-24T08:03:08.4007943-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a30a6bc9-6de9-4510-aabf-557f3225454e",
"CreateDate": "2026-03-24T08:03:08.4007943-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-24T08:03:08.4007943-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-03-24T08:03:08.4007943-07:00",
"MeasurementValueNeededDate": "2026-03-24T08:03:08.4007943-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "00ad9168-69a7-4f4e-8e30-7649b41c14b9",
"CreateDate": "2026-03-24T08:03:08.4007943-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-24T08:03:08.4007943-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "02d06b21-17e4-40a4-9e5d-5a32b6cbf1a6",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "b918e849-f27d-46ab-9172-06ebe5b76da9",
"CreateDate": "2026-03-24T08:03:08.4007943-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-24T08:03:08.4007943-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-24T08:03:08.4007943-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f75e424a-3f94-412a-b461-b7e5a30a2a96",
"CreateDate": "2026-03-24T08:03:08.4007943-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-24T08:03:08.4007943-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "a1d67fc5-49a2-44d7-99e1-e7bac6eb2f3e",
"Asset": {
"AssetId": "01578f25-f039-4564-b491-464cfbeef8b6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "8dbd1dd8-2063-44cb-87fd-7685c1176700",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "115c7eaf-6897-45d9-ab13-a33add7dab4f",
"CreateDate": "2026-03-24T08:03:08.4007943-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-24T08:03:08.4007943-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "98873f1e-ca45-424d-b81d-39ae20823f13",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-24T08:03:08.4007943-07:00",
"MeasurementValueNeededDate": "2026-03-24T08:03:08.4007943-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a30a6bc9-6de9-4510-aabf-557f3225454e",
"CreateDate": "2026-03-24T08:03:08.4007943-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-24T08:03:08.4007943-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-03-24T08:03:08.4007943-07:00",
"MeasurementValueNeededDate": "2026-03-24T08:03:08.4007943-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "00ad9168-69a7-4f4e-8e30-7649b41c14b9",
"CreateDate": "2026-03-24T08:03:08.4007943-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-24T08:03:08.4007943-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "02d06b21-17e4-40a4-9e5d-5a32b6cbf1a6",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "b918e849-f27d-46ab-9172-06ebe5b76da9",
"CreateDate": "2026-03-24T08:03:08.4007943-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-24T08:03:08.4007943-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-24T08:03:08.4007943-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f75e424a-3f94-412a-b461-b7e5a30a2a96",
"CreateDate": "2026-03-24T08:03:08.4007943-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-24T08:03:08.4007943-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}