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": "5f8f7206-50d3-4165-8493-5926c9e09ab2",
"Asset": {
"AssetId": "72778f8c-0c8a-41fd-812a-74c8ad005b0c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2b2bb5a0-f983-4d9f-8bec-a4862efde2bf",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4308e250-2b8b-4576-bd89-fd4d2236e08b",
"CreateDate": "2026-08-23T08:30:00.1349932-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-23T08:30:00.1349932-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "5165f4f1-5814-4518-98ce-9e98ddaaa313",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-23T08:30:00.1349932-07:00",
"MeasurementValueNeededDate": "2026-08-23T08:30:00.1349932-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c855ee3e-3429-4ec0-b865-04849e9d695a",
"CreateDate": "2026-08-23T08:30:00.1349932-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-23T08:30:00.1349932-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-08-23T08:30:00.1349932-07:00",
"MeasurementValueNeededDate": "2026-08-23T08:30:00.1349932-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "73919034-f344-4e0c-8838-6d79730429dd",
"CreateDate": "2026-08-23T08:30:00.1349932-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-23T08:30:00.1349932-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "d0e2fd68-c2e8-4fa6-b37b-76dbc71cb5ad",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d5be2f81-8c39-433d-bd49-c5972ef815f2",
"CreateDate": "2026-08-23T08:30:00.1349932-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-23T08:30:00.1349932-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-23T08:30:00.1349932-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "95842854-5ac6-4aa1-8e59-6eee094adf66",
"CreateDate": "2026-08-23T08:30:00.1349932-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-23T08:30:00.1349932-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "5f8f7206-50d3-4165-8493-5926c9e09ab2",
"Asset": {
"AssetId": "72778f8c-0c8a-41fd-812a-74c8ad005b0c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2b2bb5a0-f983-4d9f-8bec-a4862efde2bf",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4308e250-2b8b-4576-bd89-fd4d2236e08b",
"CreateDate": "2026-08-23T08:30:00.1349932-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-23T08:30:00.1349932-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "5165f4f1-5814-4518-98ce-9e98ddaaa313",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-23T08:30:00.1349932-07:00",
"MeasurementValueNeededDate": "2026-08-23T08:30:00.1349932-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c855ee3e-3429-4ec0-b865-04849e9d695a",
"CreateDate": "2026-08-23T08:30:00.1349932-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-23T08:30:00.1349932-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-08-23T08:30:00.1349932-07:00",
"MeasurementValueNeededDate": "2026-08-23T08:30:00.1349932-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "73919034-f344-4e0c-8838-6d79730429dd",
"CreateDate": "2026-08-23T08:30:00.1349932-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-23T08:30:00.1349932-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "d0e2fd68-c2e8-4fa6-b37b-76dbc71cb5ad",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d5be2f81-8c39-433d-bd49-c5972ef815f2",
"CreateDate": "2026-08-23T08:30:00.1349932-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-23T08:30:00.1349932-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-23T08:30:00.1349932-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "95842854-5ac6-4aa1-8e59-6eee094adf66",
"CreateDate": "2026-08-23T08:30:00.1349932-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-23T08:30:00.1349932-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}