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": "b7a02796-e78d-4d63-94b9-b11beb2d4dd0",
"Asset": {
"AssetId": "63f886b1-34b3-44f7-9c31-168b13a98e35",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "7ae330de-06fb-4f47-8f7f-7465175cf176",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ad35c561-6c6e-4982-b807-c95189fe53e7",
"CreateDate": "2026-01-13T23:51:12.081982-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-13T23:51:12.081982-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "48aba7db-d8f6-4588-8645-15b7093ca3ca",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-13T23:51:12.081982-08:00",
"MeasurementValueNeededDate": "2026-01-13T23:51:12.081982-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c121c209-5a2e-467f-aac7-43a0e08e0706",
"CreateDate": "2026-01-13T23:51:12.081982-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-13T23:51:12.081982-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-01-13T23:51:12.081982-08:00",
"MeasurementValueNeededDate": "2026-01-13T23:51:12.081982-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "a709180f-6dcd-478e-89c4-77454d3b8817",
"CreateDate": "2026-01-13T23:51:12.081982-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-13T23:51:12.081982-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "86161281-7522-477d-ab34-a122ad27ea98",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f5a9f6c3-ada7-4692-a7fd-bf822ee73845",
"CreateDate": "2026-01-13T23:51:12.081982-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-01-13T23:51:12.081982-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-01-13T23:51:12.081982-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c67c7091-b54b-431f-a862-3f58524c1a22",
"CreateDate": "2026-01-13T23:51:12.081982-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-01-13T23:51:12.081982-08:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "b7a02796-e78d-4d63-94b9-b11beb2d4dd0",
"Asset": {
"AssetId": "63f886b1-34b3-44f7-9c31-168b13a98e35",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "7ae330de-06fb-4f47-8f7f-7465175cf176",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ad35c561-6c6e-4982-b807-c95189fe53e7",
"CreateDate": "2026-01-13T23:51:12.081982-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-13T23:51:12.081982-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "48aba7db-d8f6-4588-8645-15b7093ca3ca",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-13T23:51:12.081982-08:00",
"MeasurementValueNeededDate": "2026-01-13T23:51:12.081982-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c121c209-5a2e-467f-aac7-43a0e08e0706",
"CreateDate": "2026-01-13T23:51:12.081982-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-13T23:51:12.081982-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-01-13T23:51:12.081982-08:00",
"MeasurementValueNeededDate": "2026-01-13T23:51:12.081982-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "a709180f-6dcd-478e-89c4-77454d3b8817",
"CreateDate": "2026-01-13T23:51:12.081982-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-13T23:51:12.081982-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "86161281-7522-477d-ab34-a122ad27ea98",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f5a9f6c3-ada7-4692-a7fd-bf822ee73845",
"CreateDate": "2026-01-13T23:51:12.081982-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-01-13T23:51:12.081982-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-01-13T23:51:12.081982-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c67c7091-b54b-431f-a862-3f58524c1a22",
"CreateDate": "2026-01-13T23:51:12.081982-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-01-13T23:51:12.081982-08:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}