Sign in

v1

latestOpenAPI 3.0.22026-07-174950145.6 KB
Manage Subscriptions

Create or replace a subscription

Creates or replaces a subscription to a space.

put/spaces/{spaceId}/subscriptions/{subscriptionId}

Path parameters

spaceIdstring required

The unique identifier of the space.

subscriptionIdstring required

The unique identifier of the subscription.

Request body

idstring

The uniques identifier for the subscription.

sourcestring

The source for the subscribed notification (usually the space).

destinationstring

The destination for the subscribed notification.

Example request

{
  "id": "my-subscription-id",
  "status": {
    "state": "ACTIVE"
  },
  "filter": {
    "jsonPath": "$[?(@.properties.type == 'building')]"
  }
}

Response

The subscription

idstring

The uniques identifier for the subscription.

sourcestring

The source for the subscribed notification (usually the space).

destinationstring

The destination for the subscribed notification.

Example response

{
  "id": "my-subscription-id",
  "status": {
    "state": "ACTIVE"
  },
  "filter": {
    "jsonPath": "$[?(@.properties.type == 'building')]"
  }
}