v1

latestOpenAPI 3.0.12026-07-17265663.1 KB
Resource Links

Get resource links

Each device publishes links to its resources to the plgd hub. Authorized user can get all published links in form of a stream, chunk by chunk. Attach your reader and consume link by link. Various filters allows you to be more concrete in links you would like to get. Error response might be returned immediately, but also anytime during the stream reading.

get/api/v1/resource-links

Query parameters

deviceIdstring uuid

Filter by the device id.

typestring[]

Filter by the type.

Response

Stream of resource links or errors.

Example response

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