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": "4cd9c2d6-1519-4a35-bb5a-2656bae43c33",
"Asset": {
"AssetId": "e4dbbf56-d8ce-431e-90e9-64166f41076e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "bc71d234-5a5b-4bbe-a513-296b0c34d524",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f5d0c5b2-17c1-446d-97eb-306f7efed946",
"CreateDate": "2026-05-23T21:56:29.4724621-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-23T21:56:29.4724621-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "b5ba062a-9aac-4100-99c6-b5d2085fe0e2",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-23T21:56:29.4724621-07:00",
"MeasurementValueNeededDate": "2026-05-23T21:56:29.4724621-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a72d48b0-2443-453a-a3bd-a88c48387f47",
"CreateDate": "2026-05-23T21:56:29.4724621-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-23T21:56:29.4724621-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-05-23T21:56:29.4724621-07:00",
"MeasurementValueNeededDate": "2026-05-23T21:56:29.4724621-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "95752a20-691b-4e7e-94d5-4af707c4e6d1",
"CreateDate": "2026-05-23T21:56:29.4724621-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-23T21:56:29.4724621-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "0fe383f7-fdd7-48e6-87c5-32060bceecb6",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "259a7ce5-18ff-4861-b2c6-37131a03a650",
"CreateDate": "2026-05-23T21:56:29.4724621-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-23T21:56:29.4724621-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-05-23T21:56:29.4724621-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "2bd44548-dabe-4b24-9551-b4f888e04e4f",
"CreateDate": "2026-05-23T21:56:29.4724621-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-23T21:56:29.4724621-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "4cd9c2d6-1519-4a35-bb5a-2656bae43c33",
"Asset": {
"AssetId": "e4dbbf56-d8ce-431e-90e9-64166f41076e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "bc71d234-5a5b-4bbe-a513-296b0c34d524",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f5d0c5b2-17c1-446d-97eb-306f7efed946",
"CreateDate": "2026-05-23T21:56:29.4724621-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-23T21:56:29.4724621-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "b5ba062a-9aac-4100-99c6-b5d2085fe0e2",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-23T21:56:29.4724621-07:00",
"MeasurementValueNeededDate": "2026-05-23T21:56:29.4724621-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a72d48b0-2443-453a-a3bd-a88c48387f47",
"CreateDate": "2026-05-23T21:56:29.4724621-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-23T21:56:29.4724621-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-05-23T21:56:29.4724621-07:00",
"MeasurementValueNeededDate": "2026-05-23T21:56:29.4724621-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "95752a20-691b-4e7e-94d5-4af707c4e6d1",
"CreateDate": "2026-05-23T21:56:29.4724621-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-23T21:56:29.4724621-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "0fe383f7-fdd7-48e6-87c5-32060bceecb6",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "259a7ce5-18ff-4861-b2c6-37131a03a650",
"CreateDate": "2026-05-23T21:56:29.4724621-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-23T21:56:29.4724621-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-05-23T21:56:29.4724621-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "2bd44548-dabe-4b24-9551-b4f888e04e4f",
"CreateDate": "2026-05-23T21:56:29.4724621-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-23T21:56:29.4724621-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}