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": "206a0baa-7fcd-49af-9a6e-9cfba1fe9e25",
"Asset": {
"AssetId": "8053a892-2904-432e-9fd8-314e8236b1d8",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "97bf9f6c-9d12-46e2-80f9-44ba546bb27e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "fc5d23f2-36ab-428e-adef-69a770fc07f3",
"CreateDate": "2026-05-09T23:12:02.1079311-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-09T23:12:02.1079311-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "ce9f07ae-f3c3-4758-a43d-bc97c135f02f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-09T23:12:02.1079311-07:00",
"MeasurementValueNeededDate": "2026-05-09T23:12:02.1079311-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "78f2e43f-292f-420f-acb2-22c4e8eead60",
"CreateDate": "2026-05-09T23:12:02.1079311-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-09T23:12:02.1079311-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-05-09T23:12:02.1079311-07:00",
"MeasurementValueNeededDate": "2026-05-09T23:12:02.1079311-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d30e7bce-7fb1-4f5f-a2f3-a0bb81019b45",
"CreateDate": "2026-05-09T23:12:02.1079311-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-09T23:12:02.1079311-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "45aae761-2cb5-48b8-bea5-a22c071767cc",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "a9961c27-3338-4999-867c-baff76816303",
"CreateDate": "2026-05-09T23:12:02.1079311-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-09T23:12:02.1079311-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-05-09T23:12:02.1079311-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "8e38a8d2-e8e3-485e-b0c2-53e7bf6565e3",
"CreateDate": "2026-05-09T23:12:02.1079311-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-09T23:12:02.1079311-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "206a0baa-7fcd-49af-9a6e-9cfba1fe9e25",
"Asset": {
"AssetId": "8053a892-2904-432e-9fd8-314e8236b1d8",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "97bf9f6c-9d12-46e2-80f9-44ba546bb27e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "fc5d23f2-36ab-428e-adef-69a770fc07f3",
"CreateDate": "2026-05-09T23:12:02.1079311-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-09T23:12:02.1079311-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "ce9f07ae-f3c3-4758-a43d-bc97c135f02f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-09T23:12:02.1079311-07:00",
"MeasurementValueNeededDate": "2026-05-09T23:12:02.1079311-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "78f2e43f-292f-420f-acb2-22c4e8eead60",
"CreateDate": "2026-05-09T23:12:02.1079311-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-09T23:12:02.1079311-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-05-09T23:12:02.1079311-07:00",
"MeasurementValueNeededDate": "2026-05-09T23:12:02.1079311-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d30e7bce-7fb1-4f5f-a2f3-a0bb81019b45",
"CreateDate": "2026-05-09T23:12:02.1079311-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-09T23:12:02.1079311-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "45aae761-2cb5-48b8-bea5-a22c071767cc",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "a9961c27-3338-4999-867c-baff76816303",
"CreateDate": "2026-05-09T23:12:02.1079311-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-09T23:12:02.1079311-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-05-09T23:12:02.1079311-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "8e38a8d2-e8e3-485e-b0c2-53e7bf6565e3",
"CreateDate": "2026-05-09T23:12:02.1079311-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-09T23:12:02.1079311-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}