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": "dbfc55d3-062a-4c6d-8ef8-67d45ec17c5d",
"Asset": {
"AssetId": "82fff1fa-381c-4c1b-9a78-a1fdd24ec918",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "126bb349-8bf5-4e85-a3e8-44336fd2a265",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7fa3aeb9-7f6f-465c-83f6-206665483c62",
"CreateDate": "2025-08-30T13:00:01.2762581-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-08-30T13:00:01.2762581-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "63d2bff2-c2ca-44f2-afa3-06827a7e94ca",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-08-30T13:00:01.2762581-07:00",
"MeasurementValueNeededDate": "2025-08-30T13:00:01.2762581-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "aa68e149-60c6-4998-b21c-ec7df609ece4",
"CreateDate": "2025-08-30T13:00:01.2762581-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-30T13:00:01.2762581-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-08-30T13:00:01.2762581-07:00",
"MeasurementValueNeededDate": "2025-08-30T13:00:01.2762581-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "292a6dff-a2b8-4c8b-9211-e76aa0adbf14",
"CreateDate": "2025-08-30T13:00:01.2762581-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-30T13:00:01.2762581-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "b6007736-b4de-4769-bd72-540e45501231",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "37b9b21f-b39f-42bc-92ea-e64901f04e24",
"CreateDate": "2025-08-30T13:00:01.2762581-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-30T13:00:01.2762581-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-08-30T13:00:01.2762581-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "9c1b5a87-b9f3-4f95-8f86-1d6deeeae907",
"CreateDate": "2025-08-30T13:00:01.2762581-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-30T13:00:01.2762581-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "dbfc55d3-062a-4c6d-8ef8-67d45ec17c5d",
"Asset": {
"AssetId": "82fff1fa-381c-4c1b-9a78-a1fdd24ec918",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "126bb349-8bf5-4e85-a3e8-44336fd2a265",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7fa3aeb9-7f6f-465c-83f6-206665483c62",
"CreateDate": "2025-08-30T13:00:01.2762581-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-08-30T13:00:01.2762581-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "63d2bff2-c2ca-44f2-afa3-06827a7e94ca",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-08-30T13:00:01.2762581-07:00",
"MeasurementValueNeededDate": "2025-08-30T13:00:01.2762581-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "aa68e149-60c6-4998-b21c-ec7df609ece4",
"CreateDate": "2025-08-30T13:00:01.2762581-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-30T13:00:01.2762581-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-08-30T13:00:01.2762581-07:00",
"MeasurementValueNeededDate": "2025-08-30T13:00:01.2762581-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "292a6dff-a2b8-4c8b-9211-e76aa0adbf14",
"CreateDate": "2025-08-30T13:00:01.2762581-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-30T13:00:01.2762581-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "b6007736-b4de-4769-bd72-540e45501231",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "37b9b21f-b39f-42bc-92ea-e64901f04e24",
"CreateDate": "2025-08-30T13:00:01.2762581-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-30T13:00:01.2762581-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-08-30T13:00:01.2762581-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "9c1b5a87-b9f3-4f95-8f86-1d6deeeae907",
"CreateDate": "2025-08-30T13:00:01.2762581-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-30T13:00:01.2762581-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}