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": "4e669938-47d6-488d-8185-b5db60a9e36f",
"Asset": {
"AssetId": "bdae0d6d-1361-4001-91cf-9cd0544e7366",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "f5680320-1c46-4d16-9b25-858e9c2ea017",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "68040f87-d805-4f51-936b-4b91a93caf0a",
"CreateDate": "2026-04-30T15:57:13.9079101-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-30T15:57:13.9079101-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "25ac4f2d-01d8-499e-94f3-53465d60b042",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-30T15:57:13.9079101-07:00",
"MeasurementValueNeededDate": "2026-04-30T15:57:13.9079101-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "54e41492-40db-41ae-a896-78922f9609b7",
"CreateDate": "2026-04-30T15:57:13.9079101-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-30T15:57:13.9079101-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-04-30T15:57:13.9079101-07:00",
"MeasurementValueNeededDate": "2026-04-30T15:57:13.9079101-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "48196cdc-5d06-4f5d-9a70-dd8ba14715fb",
"CreateDate": "2026-04-30T15:57:13.9079101-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-30T15:57:13.9079101-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "8f7887ec-8ed0-4fab-8e31-52c3a71a5bb2",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "5e27c06b-a5f4-4348-9a16-e6ee1e4568ff",
"CreateDate": "2026-04-30T15:57:13.9079101-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-30T15:57:13.9079101-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-04-30T15:57:13.9079101-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "79e3fdfe-c534-4a55-b251-6264852a7879",
"CreateDate": "2026-04-30T15:57:13.9079101-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-30T15:57:13.9079101-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "4e669938-47d6-488d-8185-b5db60a9e36f",
"Asset": {
"AssetId": "bdae0d6d-1361-4001-91cf-9cd0544e7366",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "f5680320-1c46-4d16-9b25-858e9c2ea017",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "68040f87-d805-4f51-936b-4b91a93caf0a",
"CreateDate": "2026-04-30T15:57:13.9079101-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-30T15:57:13.9079101-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "25ac4f2d-01d8-499e-94f3-53465d60b042",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-30T15:57:13.9079101-07:00",
"MeasurementValueNeededDate": "2026-04-30T15:57:13.9079101-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "54e41492-40db-41ae-a896-78922f9609b7",
"CreateDate": "2026-04-30T15:57:13.9079101-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-30T15:57:13.9079101-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-04-30T15:57:13.9079101-07:00",
"MeasurementValueNeededDate": "2026-04-30T15:57:13.9079101-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "48196cdc-5d06-4f5d-9a70-dd8ba14715fb",
"CreateDate": "2026-04-30T15:57:13.9079101-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-30T15:57:13.9079101-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "8f7887ec-8ed0-4fab-8e31-52c3a71a5bb2",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "5e27c06b-a5f4-4348-9a16-e6ee1e4568ff",
"CreateDate": "2026-04-30T15:57:13.9079101-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-30T15:57:13.9079101-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-04-30T15:57:13.9079101-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "79e3fdfe-c534-4a55-b251-6264852a7879",
"CreateDate": "2026-04-30T15:57:13.9079101-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-30T15:57:13.9079101-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}