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": "86df0183-f1f2-406b-ba57-84083103649e",
"Asset": {
"AssetId": "3e62c061-745e-4613-9ea4-e93cba5eeb33",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "0ac83b6d-2e9b-4458-9a36-30aef105c85b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "748b94ce-62de-4bf1-8c8f-319174003156",
"CreateDate": "2025-10-13T18:10:21.5660717-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-13T18:10:21.5660717-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "f6aec17c-aa9e-4a4a-98cd-b98357f75b63",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-13T18:10:21.5660717-07:00",
"MeasurementValueNeededDate": "2025-10-13T18:10:21.5660717-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "0a0ab9f4-3def-4b46-8b44-36eb2e026278",
"CreateDate": "2025-10-13T18:10:21.5660717-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T18:10:21.5660717-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-10-13T18:10:21.5660717-07:00",
"MeasurementValueNeededDate": "2025-10-13T18:10:21.5660717-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d5a4f35f-2267-4457-b61f-47fc5226344f",
"CreateDate": "2025-10-13T18:10:21.5660717-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T18:10:21.5660717-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "4ff96e44-cc0e-4986-a670-1ba6657e1d6c",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "97653275-0a40-4686-a300-323fe4cc04e1",
"CreateDate": "2025-10-13T18:10:21.5660717-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-13T18:10:21.5660717-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-10-13T18:10:21.5660717-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d82911e6-0b86-4825-9670-b3b805135446",
"CreateDate": "2025-10-13T18:10:21.5660717-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-13T18:10:21.5660717-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "86df0183-f1f2-406b-ba57-84083103649e",
"Asset": {
"AssetId": "3e62c061-745e-4613-9ea4-e93cba5eeb33",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "0ac83b6d-2e9b-4458-9a36-30aef105c85b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "748b94ce-62de-4bf1-8c8f-319174003156",
"CreateDate": "2025-10-13T18:10:21.5660717-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-13T18:10:21.5660717-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "f6aec17c-aa9e-4a4a-98cd-b98357f75b63",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-13T18:10:21.5660717-07:00",
"MeasurementValueNeededDate": "2025-10-13T18:10:21.5660717-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "0a0ab9f4-3def-4b46-8b44-36eb2e026278",
"CreateDate": "2025-10-13T18:10:21.5660717-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T18:10:21.5660717-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-10-13T18:10:21.5660717-07:00",
"MeasurementValueNeededDate": "2025-10-13T18:10:21.5660717-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d5a4f35f-2267-4457-b61f-47fc5226344f",
"CreateDate": "2025-10-13T18:10:21.5660717-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T18:10:21.5660717-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "4ff96e44-cc0e-4986-a670-1ba6657e1d6c",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "97653275-0a40-4686-a300-323fe4cc04e1",
"CreateDate": "2025-10-13T18:10:21.5660717-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-13T18:10:21.5660717-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-10-13T18:10:21.5660717-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d82911e6-0b86-4825-9670-b3b805135446",
"CreateDate": "2025-10-13T18:10:21.5660717-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-13T18:10:21.5660717-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}