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": "2a8be4e9-9b3e-4d36-94f8-20b97e7899c3",
"Asset": {
"AssetId": "747ea7ae-5ab5-4847-9791-cc5716eb425f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "f569e980-7cf7-4d28-ab19-9d5959c39275",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b50b98c6-1c88-49ad-9752-6e0ad8231ace",
"CreateDate": "2022-11-27T04:57:42.5436427-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2022-11-27T04:57:42.5436427-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "1578cdb1-4828-4987-9a58-7d74c92e756e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2022-11-27T04:57:42.5436427-08:00",
"MeasurementValueNeededDate": "2022-11-27T04:57:42.5436427-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "6e9e6ab8-c3ea-4b1f-81d3-8443daa009f5",
"CreateDate": "2022-11-27T04:57:42.5436427-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2022-11-27T04:57:42.5436427-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2022-11-27T04:57:42.5436427-08:00",
"MeasurementValueNeededDate": "2022-11-27T04:57:42.5436427-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "227afbdf-c200-4af6-ad07-f59685822578",
"CreateDate": "2022-11-27T04:57:42.5436427-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2022-11-27T04:57:42.5436427-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "f2e2dc9a-b9c7-44fa-b3be-82f54f75949d",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1661b009-63b6-4644-8008-c1e0eddbccc1",
"CreateDate": "2022-11-27T04:57:42.5436427-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2022-11-27T04:57:42.5436427-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2022-11-27T04:57:42.5436427-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "4ff5404d-5f15-4e8f-90a8-8b3a481e5010",
"CreateDate": "2022-11-27T04:57:42.5436427-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2022-11-27T04:57:42.5436427-08:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "2a8be4e9-9b3e-4d36-94f8-20b97e7899c3",
"Asset": {
"AssetId": "747ea7ae-5ab5-4847-9791-cc5716eb425f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "f569e980-7cf7-4d28-ab19-9d5959c39275",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b50b98c6-1c88-49ad-9752-6e0ad8231ace",
"CreateDate": "2022-11-27T04:57:42.5436427-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2022-11-27T04:57:42.5436427-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "1578cdb1-4828-4987-9a58-7d74c92e756e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2022-11-27T04:57:42.5436427-08:00",
"MeasurementValueNeededDate": "2022-11-27T04:57:42.5436427-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "6e9e6ab8-c3ea-4b1f-81d3-8443daa009f5",
"CreateDate": "2022-11-27T04:57:42.5436427-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2022-11-27T04:57:42.5436427-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2022-11-27T04:57:42.5436427-08:00",
"MeasurementValueNeededDate": "2022-11-27T04:57:42.5436427-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "227afbdf-c200-4af6-ad07-f59685822578",
"CreateDate": "2022-11-27T04:57:42.5436427-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2022-11-27T04:57:42.5436427-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "f2e2dc9a-b9c7-44fa-b3be-82f54f75949d",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1661b009-63b6-4644-8008-c1e0eddbccc1",
"CreateDate": "2022-11-27T04:57:42.5436427-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2022-11-27T04:57:42.5436427-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2022-11-27T04:57:42.5436427-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "4ff5404d-5f15-4e8f-90a8-8b3a481e5010",
"CreateDate": "2022-11-27T04:57:42.5436427-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2022-11-27T04:57:42.5436427-08:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}