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": "4254ff7e-de76-444d-9c94-eeafce1a4bd4",
"Asset": {
"AssetId": "8419fcd0-11f4-4180-b557-3698659a4c10",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "7d8ba6b2-a58b-4312-b8b2-05cb7c0aeb8c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "45839754-2fb7-4586-a379-97cfd346b7df",
"CreateDate": "2025-10-20T21:58:50.2771799-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-20T21:58:50.2771799-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "a0b352c8-1cc5-4b53-b0f8-eb97f1974d0b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-20T21:58:50.2771799-07:00",
"MeasurementValueNeededDate": "2025-10-20T21:58:50.2771799-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "de4b1e98-f5c7-44dc-b911-121de366aca0",
"CreateDate": "2025-10-20T21:58:50.2771799-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-20T21:58:50.2771799-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-10-20T21:58:50.2771799-07:00",
"MeasurementValueNeededDate": "2025-10-20T21:58:50.2771799-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b5c9040e-bf97-4870-ac71-cbaa12dbfb5c",
"CreateDate": "2025-10-20T21:58:50.2771799-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-20T21:58:50.2771799-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "46878556-ce0f-40ad-b6e0-7ade2ff9d559",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "300cf2ca-4ec7-4ce6-a6fc-68bc5603c257",
"CreateDate": "2025-10-20T21:58:50.2771799-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-20T21:58:50.2771799-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-10-20T21:58:50.2771799-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "ac3980aa-9234-4ee1-886a-7da74df8165c",
"CreateDate": "2025-10-20T21:58:50.2771799-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-20T21:58:50.2771799-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "4254ff7e-de76-444d-9c94-eeafce1a4bd4",
"Asset": {
"AssetId": "8419fcd0-11f4-4180-b557-3698659a4c10",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "7d8ba6b2-a58b-4312-b8b2-05cb7c0aeb8c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "45839754-2fb7-4586-a379-97cfd346b7df",
"CreateDate": "2025-10-20T21:58:50.2771799-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-20T21:58:50.2771799-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "a0b352c8-1cc5-4b53-b0f8-eb97f1974d0b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-20T21:58:50.2771799-07:00",
"MeasurementValueNeededDate": "2025-10-20T21:58:50.2771799-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "de4b1e98-f5c7-44dc-b911-121de366aca0",
"CreateDate": "2025-10-20T21:58:50.2771799-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-20T21:58:50.2771799-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-10-20T21:58:50.2771799-07:00",
"MeasurementValueNeededDate": "2025-10-20T21:58:50.2771799-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b5c9040e-bf97-4870-ac71-cbaa12dbfb5c",
"CreateDate": "2025-10-20T21:58:50.2771799-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-20T21:58:50.2771799-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "46878556-ce0f-40ad-b6e0-7ade2ff9d559",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "300cf2ca-4ec7-4ce6-a6fc-68bc5603c257",
"CreateDate": "2025-10-20T21:58:50.2771799-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-20T21:58:50.2771799-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-10-20T21:58:50.2771799-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "ac3980aa-9234-4ee1-886a-7da74df8165c",
"CreateDate": "2025-10-20T21:58:50.2771799-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-20T21:58:50.2771799-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}