Resource Links

Delete a resource

Request to delete a resource is an async operation. The device after successful resource deletion unpublishes the resource from the plgd hub. This information is published to the WebSocket in form of an RESOURCE_UNPUBLISHED event.

delete/api/v1/devices/{deviceId}/resource-links/{resourceHref}

Query parameters

timeToLiveinteger

Command expiration in nanoseconds. 0 means forever and 100ms is minimal value.

Response

Confirmation event about successful resource deletion.

Example response

{
  "data": {
    "resourceId": {
      "href": "/switches/1",
      "deviceId": "4629b3cb-3a6e-477c-5d50-ccb28ad7c349"
    },
    "content": {
      "rt": [
        "oic.r.switch.binary"
      ],
      "if": [
        "oic.if.a",
        "oic.if.baseline"
      ],
      "value": false
    },
    "auditContext": {
      "userId": "9772fcff-dcfb-4db8-a6c9-1b75f2165eb1",
      "correlationId": "e20f1eef-2eeb-4755-b33e-139106d28e2c"
    },
    "eventMetadata": {
      "connectionId": "194.1.25.111:61692",
      "sequence": "7",
      "version": "0",
      "timestamp": "1625427236429144178"
    },
    "status": "OK"
  }
}

Changes

Changed in 5 of the 42 revisions of this API.118

Oct 3, 202343d5d4e000ad1See the full diff
- ●
  added the new NOT_MODIFIED enum value to the data/status response property for the response status 200
  response-property-enum-value-added
Jan 5, 2022afc9b9af73b56See the full diff
- ○
  added the optional property error/details/items/typeUrl to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property error/details/items/typeUrl to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property error/details/items/typeUrl to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property error/details/items/value to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property error/details/items/value to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property error/details/items/value to the response with the 403 status
  response-optional-property-added
Aug 5, 2021750a4952762c1See the full diff
- ○
  added the new optional query request parameter timeToLive
  new-optional-request-parameter
Jul 27, 20214d121732b5931See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 11, 2020562192db97671See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 55 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 42 revisions, 3 have no diff computed.

Full history