Sign in
latestOpenAPI 3.1.0Apache License Version 2.02026-08-17498525913.3 KB

40169ccdec5c

entity-view-controller

Get Customer Entity Views (getCustomerEntityViews)

Returns a page of Entity View objects assigned to customer. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details.

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

get/api/customer/{customerId}/entityViews

Path parameters

customerIdstring required

A string value representing the customer id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'

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)

Response

OK

totalPagesinteger

Total number of available pages. Calculated based on the 'pageSize' request parameter and total number of entities that match search criteria

totalElementsinteger

Total number of elements in all available pages

hasNextboolean

'false' value indicates the end of the result set

Example response

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