entity-view-controller
Get Entity View by name (getTenantEntityView)
Fetch the Entity View object based on the tenant id and entity view name.
Available for users with 'TENANT_ADMIN' authority.
get/api/tenant/entityViews
Query parameters
pageSizeinteger required
Maximum amount of entities in a one page
pageinteger required
Sequence number of page starting from 0
typestring
Entity View Filter
Allows to filter entity views based on their type and the 'starts with' expression over their name. For example, this entity filter selects all 'Concrete Mixer' entity views which name starts with 'CAT':
{
"type": "entityViewType",
"entityViewType": "Concrete Mixer",
"entityViewNameFilter": "CAT"
}
textSearchstring
The case insensitive 'substring' filter based on the entity view name.
sortProperty'createdTime' | 'name' | 'type'
Property of entity to sort by
sortOrder'ASC' | 'DESC'
Sort order. ASC (ASCENDING) or DESC (DESCENDING)
entityViewNamestring required
Entity View name
Response
OK
Example response
{
"entityId": {
"id": "784f394c-42b6-435a-983c-b7beff2784f9",
"entityType": "DEVICE"
},
"tenantId": {
"id": "784f394c-42b6-435a-983c-b7beff2784f9",
"entityType": "TENANT"
},
"customerId": {
"id": "784f394c-42b6-435a-983c-b7beff2784f9",
"entityType": "CUSTOMER"
},
"name": "A4B72CCDFF33",
"type": "Temperature Sensor",
"keys": {
"timeseries": [
"temperature",
"humidity"
],
"attributes": {
"cs": [
"currentConfiguration"
],
"ss": [
"model"
],
"sh": [
"targetConfiguration"
]
}
},
"id": {
"id": "784f394c-42b6-435a-983c-b7beff2784f9",
"entityType": "ENTITY_VIEW"
},
"createdTime": 1609459200000,
"additionalInfo": {}
}