Sign in

v1

latestOpenAPI 3.0.12026-07-17265663.1 KB
Resource Events

Subscribe to events

Open a websocket stream and receive events from devices. The contents of filters in the SubscribeToEvents message determine which events will be sent to the stream. Subscription doesn't guarantee that all events will be sent to the client. The client is responsible for synchronizing events.

post/api/v1/ws/events

Request body

correlationIdstring

Response

Stream of events

Example response

{
  "data": {
    "resourcePublished": {
      "resources": [
        {
          "href": "/switches/1",
          "deviceId": "4629b3cb-3a6e-477c-5d50-ccb28ad7c349",
          "resourceTypes": [
            "oic.r.switch.binary"
          ],
          "interfaces": [
            "oic.if.a",
            "oic.if.baseline"
          ],
          "anchor": "",
          "title": "",
          "supportedContentTypes": [],
          "validUntil": "0",
          "policy": {
            "bitFlags": 3
          },
          "endpointInformations": []
        }
      ],
      "deviceId": "4629b3cb-3a6e-477c-5d50-ccb28ad7c349",
      "auditContext": {
        "userId": "9772fcff-dcfb-4db8-a6c9-1b75f2165eb1",
        "correlationId": "ef007f88-6073-4af1-8951-971578bf6803"
      },
      "eventMetadata": {
        "connectionId": "194.1.25.111:61692",
        "sequence": "4",
        "version": "0",
        "timestamp": "1625432924483895839"
      }
    },
    "resourceUnpublished": {
      "hrefs": [
        "/light/1",
        "/light/2"
      ],
      "deviceId": "4629b3cb-3a6e-477c-5d50-ccb28ad7c349",
      "auditContext": {
        "userId": "9772fcff-dcfb-4db8-a6c9-1b75f2165eb1",
        "correlationId": "ef007f88-6073-4af1-8951-971578bf6803"
      },
      "eventMetadata": {
        "connectionId": "194.1.25.111:61692",
        "sequence": "4",
        "version": "0",
        "timestamp": "1625432924483895839"
      }
    }
  }
}