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": "dcf4ee81-6267-43c3-a89a-0f41180cd7d2",
"Asset": {
"AssetId": "67654349-9540-4e7e-b05a-f4c2e3ccb8f0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "db5f1333-9e08-4f9a-bb68-cba98bca9804",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "baa2292a-3a26-4f53-b3d5-fb3c96378950",
"CreateDate": "2026-10-31T23:09:14.4654239-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-31T23:09:14.4654239-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "fe30cc23-fe3b-4f65-8125-9a2e8a2ef5c5",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-31T23:09:14.4654239-07:00",
"MeasurementValueNeededDate": "2026-10-31T23:09:14.4654239-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2e163800-88eb-4551-8643-faff1bf2d1ca",
"CreateDate": "2026-10-31T23:09:14.4654239-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-31T23:09:14.4654239-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-10-31T23:09:14.4654239-07:00",
"MeasurementValueNeededDate": "2026-10-31T23:09:14.4654239-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "a3bf5d44-6260-446d-9b1b-88086386bd90",
"CreateDate": "2026-10-31T23:09:14.4654239-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-31T23:09:14.4654239-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "cd498fd2-b907-4c0d-9e6a-2282d74c6282",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "3dd6d0d1-5fab-401b-a958-fe797cadf538",
"CreateDate": "2026-10-31T23:09:14.4654239-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-31T23:09:14.4654239-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-10-31T23:09:14.4654239-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0f66aad9-9f89-4743-b844-c954b815b6e2",
"CreateDate": "2026-10-31T23:09:14.4654239-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-31T23:09:14.4654239-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "dcf4ee81-6267-43c3-a89a-0f41180cd7d2",
"Asset": {
"AssetId": "67654349-9540-4e7e-b05a-f4c2e3ccb8f0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "db5f1333-9e08-4f9a-bb68-cba98bca9804",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "baa2292a-3a26-4f53-b3d5-fb3c96378950",
"CreateDate": "2026-10-31T23:09:14.4654239-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-31T23:09:14.4654239-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "fe30cc23-fe3b-4f65-8125-9a2e8a2ef5c5",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-31T23:09:14.4654239-07:00",
"MeasurementValueNeededDate": "2026-10-31T23:09:14.4654239-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2e163800-88eb-4551-8643-faff1bf2d1ca",
"CreateDate": "2026-10-31T23:09:14.4654239-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-31T23:09:14.4654239-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-10-31T23:09:14.4654239-07:00",
"MeasurementValueNeededDate": "2026-10-31T23:09:14.4654239-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "a3bf5d44-6260-446d-9b1b-88086386bd90",
"CreateDate": "2026-10-31T23:09:14.4654239-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-31T23:09:14.4654239-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "cd498fd2-b907-4c0d-9e6a-2282d74c6282",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "3dd6d0d1-5fab-401b-a958-fe797cadf538",
"CreateDate": "2026-10-31T23:09:14.4654239-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-31T23:09:14.4654239-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-10-31T23:09:14.4654239-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0f66aad9-9f89-4743-b844-c954b815b6e2",
"CreateDate": "2026-10-31T23:09:14.4654239-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-31T23:09:14.4654239-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}