Sign in

v1

latestOpenAPI 3.0.12026-07-24110189356.6 KB
subscription

Creates a subscription

Creates a subscription between the source catalog/layer and target catalog/layer.

post/subscriptions

Headers

x-idempotency-keystring required

x-idempotency-key is the unique value generated by the client to create a subscription request. Any additional retry requests must have the same x-idempotency-key header value and the same body content as the first subscription request. If the retry request body content is different, then the server will return a 409 status code. It is recommended to use UUID v4 for x-idempotency-key value. Minimum length: 10, maximum length: 255.

Request body

subscriptionNamestring required

The ID to use when referring to this subscription programmatically.

subscriptionHrnstring

The HERE Resource Name (HRN) of subscription

descriptionstring

A detailed description of the subscription.

sourceCatalogstring required

The HERE Resource Name (HRN) of the subscription source catalog.

sourceLayerstring required

The ID of the subscription source layer.

destinationCatalogstring required

The HERE Resource Name (HRN) of the subscription destination catalog.

destinationLayerstring required

The ID of the subscription destination layer.

versioninteger required

Version of the subscription configuration.

createdstring required

The subscription creation timestamp in ISO 8601 format.

updatedstring required

The subscription's last update timestamp in ISO 8601 format.

Example request

{
  "subscriptionName": "my-subscription",
  "subscriptionHrn": "hrn:here:data-subscription::olp-here:my-subscription-7d93563980d94f1b",
  "description": "Subscription to a layer",
  "sourceCatalog": "hrn:here:data::olp-here:my-source-catalog",
  "sourceLayer": "source-layer",
  "destinationCatalog": "hrn:here:data::olp-here:my-destination-catalog",
  "destinationLayer": "destination-layer",
  "owner": {
    "creator": {
      "id": "Mejk6DMxAq7kKI5lt2T2"
    },
    "organisation": {
      "id": "HERE"
    }
  },
  "created": "2017-08-04T17:19:03.853Z",
  "updated": "2017-08-04T17:19:03.853Z",
  "status": {
    "message": "Some error message"
  }
}

Response

Accepted - your request was received and is being processed.

statusTokenstring required

Token to check subscription create or delete status.

Example response

{
  "statusToken": "de1e3c8d-17ac-42b9-8f5d-7bbeba664fe6"
}