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

40169ccdec5c

edge-event-controller

Get Edge Events (getEdgeEvents)

Returns a page of edge events for the requested edge. 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.

get/api/edge/{edgeId}/events

Path parameters

edgeIdstring required

A string value representing the edge 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

textSearchstring

The case insensitive 'substring' filter based on the edge event type name.

sortProperty'createdTime' | 'name' | 'type' | 'label' | 'customerTitle'

Property of entity to sort by

sortOrder'ASC' | 'DESC'

Sort order. ASC (ASCENDING) or DESC (DESCENDING)

startTimeinteger

Timestamp. Edge events with creation time before it won't be queried

endTimeinteger

Timestamp. Edge events with creation time after it won't be queried

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": [
    {
      "id": {
        "id": "784f394c-42b6-435a-983c-b7beff2784f9"
      },
      "createdTime": 1746028547220,
      "tenantId": {
        "id": "784f394c-42b6-435a-983c-b7beff2784f9",
        "entityType": "TENANT"
      },
      "edgeId": {
        "id": "784f394c-42b6-435a-983c-b7beff2784f9",
        "entityType": "EDGE"
      },
      "body": {}
    }
  ]
}