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": "fe984d94-106a-4848-8b1b-4d1422946f5c",
"Asset": {
"AssetId": "bedef7da-b5c4-42da-b357-fd4a8032ab2e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "5f979467-d9c9-4840-a80b-53d5fd28bb79",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3cb046ee-b816-4f37-b905-777b8e577000",
"CreateDate": "2025-09-16T15:25:37.4008206-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-09-16T15:25:37.4008206-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "bd19918a-0156-476a-93b7-cb28a6472884",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-09-16T15:25:37.4008206-07:00",
"MeasurementValueNeededDate": "2025-09-16T15:25:37.4008206-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9ed2be8d-5cde-4c24-9a48-ffcf0ad80c8f",
"CreateDate": "2025-09-16T15:25:37.4008206-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-16T15:25:37.4008206-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-09-16T15:25:37.4008206-07:00",
"MeasurementValueNeededDate": "2025-09-16T15:25:37.4008206-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "73f4b5d9-9499-4fff-a3eb-0fb5f5b64e47",
"CreateDate": "2025-09-16T15:25:37.4008206-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-16T15:25:37.4008206-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "cc237339-6661-4eaa-960c-b0f1f036a07e",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c9cc7e6e-915e-4b9b-959d-d57bf0e4dec5",
"CreateDate": "2025-09-16T15:25:37.4008206-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-09-16T15:25:37.4008206-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-09-16T15:25:37.4008206-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "aa3dd9e4-a351-47bf-a30e-683691904cc4",
"CreateDate": "2025-09-16T15:25:37.4008206-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-09-16T15:25:37.4008206-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "fe984d94-106a-4848-8b1b-4d1422946f5c",
"Asset": {
"AssetId": "bedef7da-b5c4-42da-b357-fd4a8032ab2e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "5f979467-d9c9-4840-a80b-53d5fd28bb79",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3cb046ee-b816-4f37-b905-777b8e577000",
"CreateDate": "2025-09-16T15:25:37.4008206-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-09-16T15:25:37.4008206-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "bd19918a-0156-476a-93b7-cb28a6472884",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-09-16T15:25:37.4008206-07:00",
"MeasurementValueNeededDate": "2025-09-16T15:25:37.4008206-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9ed2be8d-5cde-4c24-9a48-ffcf0ad80c8f",
"CreateDate": "2025-09-16T15:25:37.4008206-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-16T15:25:37.4008206-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-09-16T15:25:37.4008206-07:00",
"MeasurementValueNeededDate": "2025-09-16T15:25:37.4008206-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "73f4b5d9-9499-4fff-a3eb-0fb5f5b64e47",
"CreateDate": "2025-09-16T15:25:37.4008206-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-16T15:25:37.4008206-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "cc237339-6661-4eaa-960c-b0f1f036a07e",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c9cc7e6e-915e-4b9b-959d-d57bf0e4dec5",
"CreateDate": "2025-09-16T15:25:37.4008206-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-09-16T15:25:37.4008206-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-09-16T15:25:37.4008206-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "aa3dd9e4-a351-47bf-a30e-683691904cc4",
"CreateDate": "2025-09-16T15:25:37.4008206-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-09-16T15:25:37.4008206-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}