Namespace PublishApi

Cancels a publication if it has not yet been submitted. Will fail if attempting to cancel a submitted publication. This allows the specified publication to be abandoned. See Data API Developer’s Guide in the Documentation section for publication states diagram and all possible publication states transitions.

Returns the details of the specified 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 stream layers. In addition, you may only have one versioned or volatile publication in process at a time. You cannot have multiple active publications to the same catalog for versioned and volatile layer types. The body field versionDependencies is optional and is used for versioned layers to declare version dependencies.

Submits the publication and initiates post processing if necessary. Publication state becomes Submitted directly after submission and Succeeded after successful processing. See Data API Developer’s Guide in the Documentation section for complete publication states diagram.

Upload partitions to the given layer. Dependending on the publication type, post processing may be required before the partitions are published. For better performance batch your partitions (e.g. 1000 per request), rather than uploading them individually.