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": "d1951774-b75d-4e92-a0db-5e3ed1d6d53a",
"Asset": {
"AssetId": "b4843a6c-5ad0-4de5-aa87-d490711d32a6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1d86926d-49c2-4666-a7c5-03e72762dc82",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "5ff6b84d-680c-42c9-9128-7d747d77508f",
"CreateDate": "2023-09-22T12:21:58.1058129-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2023-09-22T12:21:58.1058129-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "78be3c4b-fd88-4158-bf90-b043381ec443",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2023-09-22T12:21:58.1058129-07:00",
"MeasurementValueNeededDate": "2023-09-22T12:21:58.1058129-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5513fac3-8319-4128-8270-8c6fcd291681",
"CreateDate": "2023-09-22T12:21:58.1058129-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2023-09-22T12:21:58.1058129-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2023-09-22T12:21:58.1058129-07:00",
"MeasurementValueNeededDate": "2023-09-22T12:21:58.1058129-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "7e25b363-51ba-4b5d-af25-9c38c4f33d1d",
"CreateDate": "2023-09-22T12:21:58.1058129-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2023-09-22T12:21:58.1058129-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "9e267a29-c618-4af1-8f1a-2e38743e7e4c",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "7c71ca24-37ab-4df8-8008-3c9e87f86513",
"CreateDate": "2023-09-22T12:21:58.1058129-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2023-09-22T12:21:58.1058129-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2023-09-22T12:21:58.1058129-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "5ebe7e93-648b-4754-bb32-4161b3a5b112",
"CreateDate": "2023-09-22T12:21:58.1058129-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2023-09-22T12:21:58.1058129-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "d1951774-b75d-4e92-a0db-5e3ed1d6d53a",
"Asset": {
"AssetId": "b4843a6c-5ad0-4de5-aa87-d490711d32a6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1d86926d-49c2-4666-a7c5-03e72762dc82",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "5ff6b84d-680c-42c9-9128-7d747d77508f",
"CreateDate": "2023-09-22T12:21:58.1058129-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2023-09-22T12:21:58.1058129-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "78be3c4b-fd88-4158-bf90-b043381ec443",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2023-09-22T12:21:58.1058129-07:00",
"MeasurementValueNeededDate": "2023-09-22T12:21:58.1058129-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5513fac3-8319-4128-8270-8c6fcd291681",
"CreateDate": "2023-09-22T12:21:58.1058129-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2023-09-22T12:21:58.1058129-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2023-09-22T12:21:58.1058129-07:00",
"MeasurementValueNeededDate": "2023-09-22T12:21:58.1058129-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "7e25b363-51ba-4b5d-af25-9c38c4f33d1d",
"CreateDate": "2023-09-22T12:21:58.1058129-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2023-09-22T12:21:58.1058129-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "9e267a29-c618-4af1-8f1a-2e38743e7e4c",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "7c71ca24-37ab-4df8-8008-3c9e87f86513",
"CreateDate": "2023-09-22T12:21:58.1058129-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2023-09-22T12:21:58.1058129-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2023-09-22T12:21:58.1058129-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "5ebe7e93-648b-4754-bb32-4161b3a5b112",
"CreateDate": "2023-09-22T12:21:58.1058129-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2023-09-22T12:21:58.1058129-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}