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": "de3b08fa-d511-40d5-be07-e5fc2fb5c787",
"Asset": {
"AssetId": "83526ab8-3076-4edb-a305-9fe6020e440d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "4aea7364-e5b1-4a74-a65c-b7dec5ad8242",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "cdd5b34e-c3ef-45ac-bf53-60a55be6588c",
"CreateDate": "2026-01-16T16:23:00.0580255-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-16T16:23:00.0580255-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "5fa85d78-de5b-4c2c-a24e-6b7eda840d89",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-16T16:23:00.0580255-08:00",
"MeasurementValueNeededDate": "2026-01-16T16:23:00.0580255-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "058dedb9-c30d-4509-b857-8ddd4c769439",
"CreateDate": "2026-01-16T16:23:00.0580255-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-16T16:23:00.0580255-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-01-16T16:23:00.0580255-08:00",
"MeasurementValueNeededDate": "2026-01-16T16:23:00.0580255-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9bf25f54-6021-40fb-a610-8207b5af9072",
"CreateDate": "2026-01-16T16:23:00.0580255-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-16T16:23:00.0580255-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "aa7e3559-fb6f-45c5-a232-7e82759fb535",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "2560835d-e9a8-4817-952f-2ee146529cda",
"CreateDate": "2026-01-16T16:23:00.0580255-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-01-16T16:23:00.0580255-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-01-16T16:23:00.0580255-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "5b6dbe42-4717-4e6d-bae7-0326dfbfe34d",
"CreateDate": "2026-01-16T16:23:00.0580255-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-01-16T16:23:00.0580255-08:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "de3b08fa-d511-40d5-be07-e5fc2fb5c787",
"Asset": {
"AssetId": "83526ab8-3076-4edb-a305-9fe6020e440d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "4aea7364-e5b1-4a74-a65c-b7dec5ad8242",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "cdd5b34e-c3ef-45ac-bf53-60a55be6588c",
"CreateDate": "2026-01-16T16:23:00.0580255-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-16T16:23:00.0580255-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "5fa85d78-de5b-4c2c-a24e-6b7eda840d89",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-16T16:23:00.0580255-08:00",
"MeasurementValueNeededDate": "2026-01-16T16:23:00.0580255-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "058dedb9-c30d-4509-b857-8ddd4c769439",
"CreateDate": "2026-01-16T16:23:00.0580255-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-16T16:23:00.0580255-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-01-16T16:23:00.0580255-08:00",
"MeasurementValueNeededDate": "2026-01-16T16:23:00.0580255-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9bf25f54-6021-40fb-a610-8207b5af9072",
"CreateDate": "2026-01-16T16:23:00.0580255-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-16T16:23:00.0580255-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "aa7e3559-fb6f-45c5-a232-7e82759fb535",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "2560835d-e9a8-4817-952f-2ee146529cda",
"CreateDate": "2026-01-16T16:23:00.0580255-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-01-16T16:23:00.0580255-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-01-16T16:23:00.0580255-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "5b6dbe42-4717-4e6d-bae7-0326dfbfe34d",
"CreateDate": "2026-01-16T16:23:00.0580255-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-01-16T16:23:00.0580255-08:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}