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": "ecf14ece-d11f-4f73-a621-abac9d5004bf",
"Asset": {
"AssetId": "5e88b210-b693-49df-b2ef-f07c9af9015c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "f5d6f988-9e20-45fb-8c4e-9e3edb0e8a97",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "40a5a675-341b-487f-8592-1b7089eaf97e",
"CreateDate": "2024-11-22T10:27:54.7644527-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-11-22T10:27:54.7644527-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "0252a5a1-b869-46e5-b98d-2fd193df1452",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-11-22T10:27:54.7644527-08:00",
"MeasurementValueNeededDate": "2024-11-22T10:27:54.7644527-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2922e21d-a336-429d-85f9-a99f1d632535",
"CreateDate": "2024-11-22T10:27:54.7644527-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-11-22T10:27:54.7644527-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2024-11-22T10:27:54.7644527-08:00",
"MeasurementValueNeededDate": "2024-11-22T10:27:54.7644527-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "71ffc1e2-f060-4c3f-9b4e-0d5d38d4d123",
"CreateDate": "2024-11-22T10:27:54.7644527-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-11-22T10:27:54.7644527-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "19226cfa-91e8-49cc-bc8a-c354c6119919",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c783cdc4-31c9-4bbb-a6e7-ae4478e61486",
"CreateDate": "2024-11-22T10:27:54.7644527-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-11-22T10:27:54.7644527-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2024-11-22T10:27:54.7644527-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "91b024ed-192d-4355-a4b4-5ea51af8be16",
"CreateDate": "2024-11-22T10:27:54.7644527-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-11-22T10:27:54.7644527-08:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "ecf14ece-d11f-4f73-a621-abac9d5004bf",
"Asset": {
"AssetId": "5e88b210-b693-49df-b2ef-f07c9af9015c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "f5d6f988-9e20-45fb-8c4e-9e3edb0e8a97",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "40a5a675-341b-487f-8592-1b7089eaf97e",
"CreateDate": "2024-11-22T10:27:54.7644527-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-11-22T10:27:54.7644527-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "0252a5a1-b869-46e5-b98d-2fd193df1452",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-11-22T10:27:54.7644527-08:00",
"MeasurementValueNeededDate": "2024-11-22T10:27:54.7644527-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2922e21d-a336-429d-85f9-a99f1d632535",
"CreateDate": "2024-11-22T10:27:54.7644527-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-11-22T10:27:54.7644527-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2024-11-22T10:27:54.7644527-08:00",
"MeasurementValueNeededDate": "2024-11-22T10:27:54.7644527-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "71ffc1e2-f060-4c3f-9b4e-0d5d38d4d123",
"CreateDate": "2024-11-22T10:27:54.7644527-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-11-22T10:27:54.7644527-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "19226cfa-91e8-49cc-bc8a-c354c6119919",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c783cdc4-31c9-4bbb-a6e7-ae4478e61486",
"CreateDate": "2024-11-22T10:27:54.7644527-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-11-22T10:27:54.7644527-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2024-11-22T10:27:54.7644527-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "91b024ed-192d-4355-a4b4-5ea51af8be16",
"CreateDate": "2024-11-22T10:27:54.7644527-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-11-22T10:27:54.7644527-08:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}