Sign in

v1

latestOpenAPI 3.0.12026-07-24110189356.6 KB
publish

Gets a publication

Returns the details of the specified publication. Publication can be in one of these states: Initialized, Submitted, Cancelled, Failed, Succeeded, Expired. See Data API Developer’s Guide in the Documentation section for the publication state diagram.

get/publications/{publicationId}

Path parameters

publicationIdstring required

The ID of the publication to retrieve.

Query parameters

billingTagstring

Billing Tag is an optional free-form tag which is used for grouping billing records together. If supplied, it must be between 4 - 16 characters and contain only alphanumeric ASCII characters [A-Za-z0-9]. Grouping billing records by billing tag will be available in future releases.

Response

The publication details.

idstring

The ID of the publication.

layerIdsstring[]
catalogVersioninteger

The current version of the catalog. If this is the catalog's first publication, the version is -1. After the first publication, the catalog version becomes 0. Each subsequent publication increments the catalog version by 1.

Example response

{
  "id": "34bc2a16-0373-4157-8ccc-19ba08a6672b",
  "details": {
    "message": "Publication initialized",
    "started": 1523459129829,
    "modified": 1523459129829,
    "expires": 1523459129829
  },
  "layerIds": [
    "my-layer"
  ],
  "catalogVersion": 1,
  "versionDependencies": [
    {
      "hrn": "hrn:here:data:::my-catalog",
      "version": 23
    }
  ]
}