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": "c665a43e-c6f2-436d-ab1d-4bd293c0f8d3",
"Asset": {
"AssetId": "dbde2916-74da-4c71-b748-991965d661e7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "b822aa41-08cc-4d2b-a536-8071768a1c16",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "5bfe59fe-3148-40ef-879c-cbae9c293c48",
"CreateDate": "2025-12-13T01:21:46.2421699-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-13T01:21:46.2421699-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "3df658be-e0d8-4977-b963-122b8e1a4b4a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-13T01:21:46.2421699-08:00",
"MeasurementValueNeededDate": "2025-12-13T01:21:46.2421699-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "de0844e5-8872-4820-ab90-252e8dcbff3d",
"CreateDate": "2025-12-13T01:21:46.2421699-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-13T01:21:46.2421699-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-13T01:21:46.2421699-08:00",
"MeasurementValueNeededDate": "2025-12-13T01:21:46.2421699-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b8968745-ee1c-43ef-b7ce-287c479a7c73",
"CreateDate": "2025-12-13T01:21:46.2421699-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-13T01:21:46.2421699-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "ef8acdca-c375-403b-983c-d1427e926054",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0cd00863-ecf9-4b07-8f8b-5dc4cc641c9d",
"CreateDate": "2025-12-13T01:21:46.2421699-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-13T01:21:46.2421699-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-13T01:21:46.2421699-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0a0e059c-6ab8-4fe5-9840-038c012717c0",
"CreateDate": "2025-12-13T01:21:46.2421699-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-13T01:21:46.2421699-08:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "c665a43e-c6f2-436d-ab1d-4bd293c0f8d3",
"Asset": {
"AssetId": "dbde2916-74da-4c71-b748-991965d661e7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "b822aa41-08cc-4d2b-a536-8071768a1c16",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "5bfe59fe-3148-40ef-879c-cbae9c293c48",
"CreateDate": "2025-12-13T01:21:46.2421699-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-13T01:21:46.2421699-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "3df658be-e0d8-4977-b963-122b8e1a4b4a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-13T01:21:46.2421699-08:00",
"MeasurementValueNeededDate": "2025-12-13T01:21:46.2421699-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "de0844e5-8872-4820-ab90-252e8dcbff3d",
"CreateDate": "2025-12-13T01:21:46.2421699-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-13T01:21:46.2421699-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-13T01:21:46.2421699-08:00",
"MeasurementValueNeededDate": "2025-12-13T01:21:46.2421699-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b8968745-ee1c-43ef-b7ce-287c479a7c73",
"CreateDate": "2025-12-13T01:21:46.2421699-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-13T01:21:46.2421699-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "ef8acdca-c375-403b-983c-d1427e926054",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0cd00863-ecf9-4b07-8f8b-5dc4cc641c9d",
"CreateDate": "2025-12-13T01:21:46.2421699-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-13T01:21:46.2421699-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-13T01:21:46.2421699-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0a0e059c-6ab8-4fe5-9840-038c012717c0",
"CreateDate": "2025-12-13T01:21:46.2421699-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-13T01:21:46.2421699-08:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}