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": "94fbfdd5-02ad-43ae-8991-1707709d6d24",
"Asset": {
"AssetId": "89a100d4-1e9b-4ad2-8c81-10f9b16cce73",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ed9d4e25-2aa2-4dcb-908e-dc2cb49af86e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9e2d4ef7-1d63-476c-872f-d75573b20ff2",
"CreateDate": "2026-09-22T03:31:13.0873791-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-22T03:31:13.0873791-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "b42c7e3d-ad5d-46e4-ac04-77746ca9c469",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-22T03:31:13.0873791-07:00",
"MeasurementValueNeededDate": "2026-09-22T03:31:13.0873791-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f5228d52-a0e9-4ba9-9622-58c8f984bf18",
"CreateDate": "2026-09-22T03:31:13.0873791-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-22T03:31:13.0873791-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-09-22T03:31:13.0873791-07:00",
"MeasurementValueNeededDate": "2026-09-22T03:31:13.0873791-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "c47775f3-38b2-404e-80af-a47b69a9b1af",
"CreateDate": "2026-09-22T03:31:13.0873791-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-22T03:31:13.0873791-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "440c5f39-779e-4750-ad1e-a7bd74f2927a",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "b3ad2485-0731-46cc-9eab-aa93ec9be2d9",
"CreateDate": "2026-09-22T03:31:13.0873791-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-22T03:31:13.0873791-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-22T03:31:13.0873791-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "9030dbff-f357-44b8-9369-b5087954a3ad",
"CreateDate": "2026-09-22T03:31:13.0873791-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-22T03:31:13.0873791-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "94fbfdd5-02ad-43ae-8991-1707709d6d24",
"Asset": {
"AssetId": "89a100d4-1e9b-4ad2-8c81-10f9b16cce73",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ed9d4e25-2aa2-4dcb-908e-dc2cb49af86e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9e2d4ef7-1d63-476c-872f-d75573b20ff2",
"CreateDate": "2026-09-22T03:31:13.0873791-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-22T03:31:13.0873791-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "b42c7e3d-ad5d-46e4-ac04-77746ca9c469",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-22T03:31:13.0873791-07:00",
"MeasurementValueNeededDate": "2026-09-22T03:31:13.0873791-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f5228d52-a0e9-4ba9-9622-58c8f984bf18",
"CreateDate": "2026-09-22T03:31:13.0873791-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-22T03:31:13.0873791-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-09-22T03:31:13.0873791-07:00",
"MeasurementValueNeededDate": "2026-09-22T03:31:13.0873791-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "c47775f3-38b2-404e-80af-a47b69a9b1af",
"CreateDate": "2026-09-22T03:31:13.0873791-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-22T03:31:13.0873791-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "440c5f39-779e-4750-ad1e-a7bd74f2927a",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "b3ad2485-0731-46cc-9eab-aa93ec9be2d9",
"CreateDate": "2026-09-22T03:31:13.0873791-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-22T03:31:13.0873791-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-22T03:31:13.0873791-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "9030dbff-f357-44b8-9369-b5087954a3ad",
"CreateDate": "2026-09-22T03:31:13.0873791-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-22T03:31:13.0873791-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}