Sign in

v1

latestOpenAPI 3.0.12026-07-24110189356.6 KB
subscription

Gets a list of all subscriptions.

Lists all subscriptions that your account has access to.

get/subscriptions

Query parameters

billingTagstring

The billingTag parameter is an optional free-form tag that you can use to group billing records together. If supplied, it must be between 4 - 16 characters, contain only alpha/numeric ASCII characters [A-Za-z0-9]. Grouping billing records by billing tag will be available in future releases.

limitinteger

Maximum number of items to return.

pageTokenstring

Token to access other pages. To access next page use the nextPageToken fields in the response or previousPageToken to access previous page.

Response

Paginated list of subscription configurations.

limitinteger required

Current page size limit.

nextPageTokenstring
previousPageTokenstring

Example response

{
  "limit": 100,
  "items": [
    {
      "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"
      }
    }
  ]
}