SubscriptionsResource

The following resources are part of this group:

/subscriptions

GET

Gets the subscriptions.

Parameters

name description type default
limit the limit. query
offset the offset. query
account the account namer to filter by. query
application the application name to filter by. query
applicationType the application type to filter by. query
route the route id to filter by. query
usedByRoutes if true then filter for subscriptions used by routes; if false then filter for subscriptions not used by routes. query
folder the subscription folder to filter by. query
version (no documentation provided) path

Response Body

element: subscriptions

the subscriptions.

POST

Creates the subscriptions.

Parameters

name description type default
version (no documentation provided) path

Request Body

element: subscriptions

the subscriptions to create.

/subscriptions/{id}

The following operations are supported on this resource:

DELETE

Delete (unsubscribed) and/or purge the subscription.

Parameters

name description type default
id the id of the subscription that will be deleted. path
purge whether or not to purge the subscription folder. query
version (no documentation provided) path

GET

Gets a single subscription with a given id.

Parameters

name description type default
id the subscription id. path
version (no documentation provided) path

Response Body

element: subscription

the subscription with the given id.

POST

Updates subscription properties.

Parameters

name description type default
id the subscription id. path
version (no documentation provided) path

Request Body

element: subscription

the subscription to update.

/subscriptions/{subscriptionId}/schedules

GET

Gets the schedules for a subscription with a with given id.

Parameters

name description type default
subscriptionId the subscription id. path
version (no documentation provided) path

Response Body

element: schedules

the schedules.

POST

Creates schedules for a subscription with a with given id.

Parameters

name description type default
subscriptionId the subscription id. path
version (no documentation provided) path

Request Body

element: schedules

the schedules to create.

/subscriptions/{subscriptionId}/transferConfigurations

GET

Gets the transfer configurations for a given subscription.

Parameters

name description type default
subscriptionId the subscription id. path
version (no documentation provided) path

Response Body

element: transferConfigurations

the transfer configurations.

POST

Delete all transfer configurations and replaced them with the given transfer configurations.

Parameters

name description type default
subscriptionId the related subscription id. path
version (no documentation provided) path

Request Body

element: transferConfigurations

the transfer configurations to create.

/subscriptions/{subscriptionId}/schedules/{scheduleTag}

The following operations are supported on this resource:

GET

Gets the schedule for a subscription with a with given id.

Parameters

name description type default
subscriptionId the subscription id. path
scheduleTag the schedule tag. path
version (no documentation provided) path

Response Body

element: schedule

the schedule.

POST

Updates subscription schedule properties.

Parameters

name description type default
subscriptionId the subscription name. path
scheduleTag the schedule tag. path
version (no documentation provided) path

Request Body

element: schedule

the schedule to update.

PUT

Creates the schedule or replaces existing subscription schedule with the same tag.

Parameters

name description type default
subscriptionId the subscription name. path
scheduleTag the schedule tag. path
version (no documentation provided) path

Request Body

element: schedule

the schedule to create/update.

DELETE

Deletes a schedule.

Parameters

name description type default
subscriptionId the subscription id. path
scheduleTag the schedule tag. path
version (no documentation provided) path

/subscriptions/{subscriptionId}/transferConfigurations/{transferConfigurationId}

GET

Gets the transfer configurations for a given subscription.

Parameters

name description type default
subscriptionId the subscription id. path
transferConfigurationId the transfer configuration id. path
version (no documentation provided) path

Response Body

element: transferConfiguration

the transfer configurations.

/subscriptions/{subscriptionId}/transferConfigurations/{transferConfigurationId}/dataTransformations

GET

Gets the data transformations for a given transfer configuration.

Parameters

name description type default
subscriptionId the subscription id. path
transferConfigurationId the transfer configuration id. path
version (no documentation provided) path

Response Body

element: dataTransformations

the data transformations.

/subscriptions/{subscriptionId}/transferConfigurations/{transferConfigurationId}/dataTransformations/{dataTransformationId}

GET

Gets a data transformation for a given transfer configuration with given id.

Parameters

name description type default
subscriptionId the subscription id. path
transferConfigurationId the transfer configuration id. path
dataTransformationId the data transformation id. path
version (no documentation provided) path

Response Body

element: dataTransformation

the data transformation.