GuidesAPI Reference
API Reference

Initialize a new publication

Initializes a new publication for publishing metadata. Determines the publication type based on the provided layer IDs. A publication can only consist of layer IDs that have the same layer type. For example, you can have a publication for multiple layers of type versioned, but you cannot have a single publication that publishes to both versioned and volatile layers. In addition, you may only have one versioned publication in process at a time. The body field versionDependencies is optional and is used for versioned layers to declare version dependencies.

Query Params
string

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, contain only alpha/numeric ASCII characters [A-Za-z0-9]. Grouping billing records by billing tag will be available in future releases.

Body Params

Fields to initialize a publication.

string
layerIds
array of strings
layerIds
versionDependencies
array of objects

The upstream version dependencies for the publication.

versionDependencies
Responses

400

Bad request, it is impossible to publish to all the requested layers in one single publication.

401

Unauthorized.

403

Forbidden.

409

Conflict with an another active publication.

Language
Credentials
Bearer
JWT
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json