Events

Events endpoints enable creating, updating, and deleting discrete occurrences such as Weather Forecast, Calendar events etc.

Operations

List events.

Request

Returns a paginated list of events.

Security

oauth2

Body

required

Cancellation token to cancel the operation.

sortSpecificationsArray of objects(SortSpecification)

filterSpecificationsArray of objects(FilterSpecification)

pagenull or integer, (int32)

pageSizenull or integer, (int32)

{
  "sortSpecifications": [
    { … }
  ],
  "filterSpecifications": [
    { … }
  ],
  "page": null,
  "pageSize": null
}

Responses

A paginated collection of events that match the specified filter criteria.

Body

beforeinteger, (int32)

afterinteger, (int32)

totalinteger, (int32)

itemsArray of objects(Event)

Response

{
  "before": 0,
  "after": 0,
  "total": 0,
  "items": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": null,
      "description": null,
      "startTime": "2019-08-24T14:15:22Z",
      "endTime": null,
      "eventTypeId": 0,
      "type": 0,
      "subTypeId": null,
      "category": null,
      "eventSourceId": null,
      "externalId": null,
      "payload": null,
      "payloadVersion": null,
      "scalarValue": null,
      "twinId": null,
      "locations": null,
      "createdDate": "2019-08-24T14:15:22Z",
      "lastModifiedDate": "2019-08-24T14:15:22Z"
    }
  ]
}

Events

List events.

Request

Responses

Was this helpful?