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": "cb489270-b79d-454b-b482-e127c8cee36e",
"Asset": {
"AssetId": "fad3569d-49f7-4e8a-a566-8816cf520439",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2ea9a4a3-54ca-4dea-9d78-d9fdd3f82eb5",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1333374a-ab85-4da6-a841-e9a52a51447b",
"CreateDate": "2025-11-15T02:21:31.9807502-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-15T02:21:31.9807502-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "45aa8c9a-b6d7-4ce2-907b-bff62b4394ce",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-15T02:21:31.9807502-08:00",
"MeasurementValueNeededDate": "2025-11-15T02:21:31.9807502-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c5372547-c54d-43f6-a175-42b064e9f084",
"CreateDate": "2025-11-15T02:21:31.9807502-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-15T02:21:31.9807502-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-11-15T02:21:31.9807502-08:00",
"MeasurementValueNeededDate": "2025-11-15T02:21:31.9807502-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f43963bf-2f73-4552-9a67-2f51a7824d2c",
"CreateDate": "2025-11-15T02:21:31.9807502-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-15T02:21:31.9807502-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "5ad82d67-48b6-4ca9-abd2-b014d482a87f",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "7c7d8843-ddfa-4309-ae93-3dba49be16ff",
"CreateDate": "2025-11-15T02:21:31.9807502-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-15T02:21:31.9807502-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-11-15T02:21:31.9807502-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "4354f908-f3bb-451e-b08e-e1d3ffb637ed",
"CreateDate": "2025-11-15T02:21:31.9807502-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-15T02:21:31.9807502-08:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "cb489270-b79d-454b-b482-e127c8cee36e",
"Asset": {
"AssetId": "fad3569d-49f7-4e8a-a566-8816cf520439",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2ea9a4a3-54ca-4dea-9d78-d9fdd3f82eb5",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1333374a-ab85-4da6-a841-e9a52a51447b",
"CreateDate": "2025-11-15T02:21:31.9807502-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-15T02:21:31.9807502-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "45aa8c9a-b6d7-4ce2-907b-bff62b4394ce",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-15T02:21:31.9807502-08:00",
"MeasurementValueNeededDate": "2025-11-15T02:21:31.9807502-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c5372547-c54d-43f6-a175-42b064e9f084",
"CreateDate": "2025-11-15T02:21:31.9807502-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-15T02:21:31.9807502-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-11-15T02:21:31.9807502-08:00",
"MeasurementValueNeededDate": "2025-11-15T02:21:31.9807502-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f43963bf-2f73-4552-9a67-2f51a7824d2c",
"CreateDate": "2025-11-15T02:21:31.9807502-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-15T02:21:31.9807502-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "5ad82d67-48b6-4ca9-abd2-b014d482a87f",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "7c7d8843-ddfa-4309-ae93-3dba49be16ff",
"CreateDate": "2025-11-15T02:21:31.9807502-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-15T02:21:31.9807502-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-11-15T02:21:31.9807502-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "4354f908-f3bb-451e-b08e-e1d3ffb637ed",
"CreateDate": "2025-11-15T02:21:31.9807502-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-15T02:21:31.9807502-08:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}