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": "323848e7-0d7b-4d43-ae0c-ac00a533aff8",
"Asset": {
"AssetId": "a1e926a5-ea77-47fd-9b31-70859ff5acc3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "decbbb9d-a303-4d4a-9879-f7081c0f3b10",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1de07762-f8c6-4bc6-ad44-05e9b5c63393",
"CreateDate": "2025-10-27T20:56:56.4813284-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-27T20:56:56.4813284-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "acefb935-44f1-49a6-a7e7-16d7386f6944",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-27T20:56:56.4813284-07:00",
"MeasurementValueNeededDate": "2025-10-27T20:56:56.4813284-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "51cac020-67e0-4ba8-b4ad-7d882522353d",
"CreateDate": "2025-10-27T20:56:56.4813284-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-27T20:56:56.4813284-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-10-27T20:56:56.4813284-07:00",
"MeasurementValueNeededDate": "2025-10-27T20:56:56.4813284-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e8f5ab8f-41c3-4a63-8909-7b35701e06a9",
"CreateDate": "2025-10-27T20:56:56.4813284-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-27T20:56:56.4813284-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "36a693be-b720-4a18-a987-89b5e62b3187",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "58cff2eb-b41b-4861-831a-f2f558ba9789",
"CreateDate": "2025-10-27T20:56:56.4813284-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-27T20:56:56.4813284-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-10-27T20:56:56.4813284-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "149586fb-8a84-4fe1-8b19-b49709e9c92c",
"CreateDate": "2025-10-27T20:56:56.4813284-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-27T20:56:56.4813284-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "323848e7-0d7b-4d43-ae0c-ac00a533aff8",
"Asset": {
"AssetId": "a1e926a5-ea77-47fd-9b31-70859ff5acc3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "decbbb9d-a303-4d4a-9879-f7081c0f3b10",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1de07762-f8c6-4bc6-ad44-05e9b5c63393",
"CreateDate": "2025-10-27T20:56:56.4813284-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-27T20:56:56.4813284-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "acefb935-44f1-49a6-a7e7-16d7386f6944",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-27T20:56:56.4813284-07:00",
"MeasurementValueNeededDate": "2025-10-27T20:56:56.4813284-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "51cac020-67e0-4ba8-b4ad-7d882522353d",
"CreateDate": "2025-10-27T20:56:56.4813284-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-27T20:56:56.4813284-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-10-27T20:56:56.4813284-07:00",
"MeasurementValueNeededDate": "2025-10-27T20:56:56.4813284-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e8f5ab8f-41c3-4a63-8909-7b35701e06a9",
"CreateDate": "2025-10-27T20:56:56.4813284-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-27T20:56:56.4813284-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "36a693be-b720-4a18-a987-89b5e62b3187",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "58cff2eb-b41b-4861-831a-f2f558ba9789",
"CreateDate": "2025-10-27T20:56:56.4813284-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-27T20:56:56.4813284-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-10-27T20:56:56.4813284-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "149586fb-8a84-4fe1-8b19-b49709e9c92c",
"CreateDate": "2025-10-27T20:56:56.4813284-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-27T20:56:56.4813284-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}