latestOpenAPI 3.1.0Apache License Version 2.02026-08-17498525913.3 KB

40169ccdec5c

edge-controller

Get Edges By Ids (getEdgesByIds)

Requested edges must be owned by tenant or assigned to customer which user is performing the request.

Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.

get/api/edges

Query parameters

pageSizeinteger required

Maximum amount of entities in a one page

pageinteger required

Sequence number of page starting from 0

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)

edgeIdsstring[] required

A list of edges ids, separated by comma ','

Response

OK

OR

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": {}
  }
]