Creates a subscription

post

https://use.apilookup.for.a.base.url/subscriptions

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

Body Params

A subscription configuration object.

subscriptionName

string

required

length between 3 and 46

The ID to use when referring to this subscription programmatically.

description

string

length between 0 and 10000

A detailed description of the subscription.

sourceCatalog

string

required

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

sourceLayer

string

required

The ID of the subscription source layer.

destinationCatalog

string

required

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

destinationLayer

string

required

The ID of the subscription destination layer.

interactiveMapSubscription

object

required

Interactive map subscription.

Headers

x-idempotency-key

string

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.

Responses

400

Bad Request - indicates that your request failed fast validation due to an issue, such as syntax or logical errors.

401

Unauthorized

403

Forbidden

409

Conflict - indicates that:

a subscription token with the same x-idempotency-key but different subscription already exists or is in the process of being created,
or a subscription with the same source, destination, and type already exists.

202Accepted - your request was received and is being processed.