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": "bed906c3-41b5-48be-b8b4-4fd22e716eb5",
"Asset": {
"AssetId": "fec06ae2-2c70-4b2a-9bcd-b989a1353d34",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "73262ae2-3fc8-4c79-801a-387e7e34236e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "76c3102f-b6b7-4c40-86ed-d614ebd52217",
"CreateDate": "2026-02-03T04:23:00.5190164-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-03T04:23:00.5190164-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "2f459939-b7db-4372-aea9-a9cc15bdb468",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-03T04:23:00.5190164-08:00",
"MeasurementValueNeededDate": "2026-02-03T04:23:00.5190164-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "6ed20df8-7d40-41fb-a725-becb174817b1",
"CreateDate": "2026-02-03T04:23:00.5190164-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-03T04:23:00.5190164-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-02-03T04:23:00.5190164-08:00",
"MeasurementValueNeededDate": "2026-02-03T04:23:00.5190164-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "3746deba-934b-4301-b69d-23778de48f03",
"CreateDate": "2026-02-03T04:23:00.5190164-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-03T04:23:00.5190164-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "783510af-50ab-4679-a57f-490822fa75b2",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "93268a38-f1bc-4cf8-89a7-02286fad2da6",
"CreateDate": "2026-02-03T04:23:00.5190164-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-03T04:23:00.5190164-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-02-03T04:23:00.5190164-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "82462e43-368d-4d45-85a4-c8ec73b7aa7c",
"CreateDate": "2026-02-03T04:23:00.5190164-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-03T04:23:00.5190164-08:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "bed906c3-41b5-48be-b8b4-4fd22e716eb5",
"Asset": {
"AssetId": "fec06ae2-2c70-4b2a-9bcd-b989a1353d34",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "73262ae2-3fc8-4c79-801a-387e7e34236e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "76c3102f-b6b7-4c40-86ed-d614ebd52217",
"CreateDate": "2026-02-03T04:23:00.5190164-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-03T04:23:00.5190164-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "2f459939-b7db-4372-aea9-a9cc15bdb468",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-03T04:23:00.5190164-08:00",
"MeasurementValueNeededDate": "2026-02-03T04:23:00.5190164-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "6ed20df8-7d40-41fb-a725-becb174817b1",
"CreateDate": "2026-02-03T04:23:00.5190164-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-03T04:23:00.5190164-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-02-03T04:23:00.5190164-08:00",
"MeasurementValueNeededDate": "2026-02-03T04:23:00.5190164-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "3746deba-934b-4301-b69d-23778de48f03",
"CreateDate": "2026-02-03T04:23:00.5190164-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-03T04:23:00.5190164-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "783510af-50ab-4679-a57f-490822fa75b2",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "93268a38-f1bc-4cf8-89a7-02286fad2da6",
"CreateDate": "2026-02-03T04:23:00.5190164-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-03T04:23:00.5190164-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-02-03T04:23:00.5190164-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "82462e43-368d-4d45-85a4-c8ec73b7aa7c",
"CreateDate": "2026-02-03T04:23:00.5190164-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-03T04:23:00.5190164-08:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}