edge-controller
Get Tenant Edge (getTenantEdge)
Requested edge must be owned by tenant or customer that the user belongs to. Edge name is an unique property of edge. So it can be used to identify the edge.
Available for users with 'TENANT_ADMIN' authority.
get/api/tenant/edges
Query parameters
pageSizeinteger required
Maximum amount of entities in a one page
pageinteger required
Sequence number of page starting from 0
typestring
A string value representing the edge type. For example, 'default'
textSearchstring
The case insensitive 'substring' filter based on the edge name.
sortProperty'createdTime' | 'name' | 'type' | 'label' | 'customerTitle'
Property of entity to sort by
sortOrder'ASC' | 'DESC'
Sort order. ASC (ASCENDING) or DESC (DESCENDING)
edgeNamestring required
Unique name of the edge
Response
OK
Example response
{
"id": {
"id": "784f394c-42b6-435a-983c-b7beff2784f9",
"entityType": "EDGE"
},
"createdTime": 1609459200000,
"tenantId": {
"id": "784f394c-42b6-435a-983c-b7beff2784f9",
"entityType": "TENANT"
},
"customerId": {
"id": "784f394c-42b6-435a-983c-b7beff2784f9",
"entityType": "CUSTOMER"
},
"rootRuleChainId": {
"id": "784f394c-42b6-435a-983c-b7beff2784f9",
"entityType": "RULE_CHAIN"
},
"name": "Silo_A_Edge",
"type": "Silos",
"label": "Silo Edge on far field",
"additionalInfo": {}
}