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": "1d610cc5-23c6-4b85-b207-e880d1a453ff",
"Asset": {
"AssetId": "2efadf51-c0c1-47ab-a042-074361a2c010",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "6f551c6b-c474-47f6-b1c3-63d0be1d5b42",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3c2b1724-033b-47e9-9745-767d077ae98f",
"CreateDate": "2026-02-05T17:02:26.96889-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-05T17:02:26.96889-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "cacd44ee-3d2c-4617-a962-e7cb73dcbf85",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-05T17:02:26.96889-08:00",
"MeasurementValueNeededDate": "2026-02-05T17:02:26.96889-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e5f7b2af-0178-4e1a-9555-37239d8f2aaa",
"CreateDate": "2026-02-05T17:02:26.96889-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-05T17:02:26.96889-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-02-05T17:02:26.96889-08:00",
"MeasurementValueNeededDate": "2026-02-05T17:02:26.96889-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "02941200-5ff8-43ef-9116-120d26ce72b5",
"CreateDate": "2026-02-05T17:02:26.96889-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-05T17:02:26.96889-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "92a6818b-787e-4c88-ba9b-829d00e86be9",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "25d5cfdf-5ede-4bc6-9971-d6de43eb10dd",
"CreateDate": "2026-02-05T17:02:26.96889-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-05T17:02:26.96889-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-02-05T17:02:26.96889-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "2082700f-74d4-41e8-a33b-45d178eed9db",
"CreateDate": "2026-02-05T17:02:26.96889-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-05T17:02:26.96889-08:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "1d610cc5-23c6-4b85-b207-e880d1a453ff",
"Asset": {
"AssetId": "2efadf51-c0c1-47ab-a042-074361a2c010",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "6f551c6b-c474-47f6-b1c3-63d0be1d5b42",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3c2b1724-033b-47e9-9745-767d077ae98f",
"CreateDate": "2026-02-05T17:02:26.96889-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-05T17:02:26.96889-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "cacd44ee-3d2c-4617-a962-e7cb73dcbf85",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-05T17:02:26.96889-08:00",
"MeasurementValueNeededDate": "2026-02-05T17:02:26.96889-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e5f7b2af-0178-4e1a-9555-37239d8f2aaa",
"CreateDate": "2026-02-05T17:02:26.96889-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-05T17:02:26.96889-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-02-05T17:02:26.96889-08:00",
"MeasurementValueNeededDate": "2026-02-05T17:02:26.96889-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "02941200-5ff8-43ef-9116-120d26ce72b5",
"CreateDate": "2026-02-05T17:02:26.96889-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-05T17:02:26.96889-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "92a6818b-787e-4c88-ba9b-829d00e86be9",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "25d5cfdf-5ede-4bc6-9971-d6de43eb10dd",
"CreateDate": "2026-02-05T17:02:26.96889-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-05T17:02:26.96889-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-02-05T17:02:26.96889-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "2082700f-74d4-41e8-a33b-45d178eed9db",
"CreateDate": "2026-02-05T17:02:26.96889-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-05T17:02:26.96889-08:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}