PublishApi | @here/olp-sdk-ts
Namespace PublishApi
Index
Functions
cancel Publication
Parameters
builder: RequestBuilder
params: { billingTag?: string; publicationId: string }
Optional billing
Tag?: string publication
Id: string
Returns Promise<Response>
get 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.
Parameters
builder: RequestBuilder
params: { billingTag?: string; publicationId: string }
Optional billing
Tag?: string publication
Id: string
Returns Promise<Publication>
init 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 bothversionedandstreamlayers. In addition, you may only have oneversionedorvolatilepublication in process at a time. You cannot have multiple active publications to the same catalog forversionedandvolatilelayer types. The body fieldversionDependenciesis optional and is used forversionedlayers to declare version dependencies.Parameters
builder: RequestBuilder
params: { billingTag?: string; body: Publication }
Optional billing
Tag?: string body: Publication
Returns Promise<Publication>
submit Publication
Submits the publication and initiates post processing if necessary. Publication state becomes
Submitteddirectly after submission andSucceededafter successful processing. See Data API Developer’s Guide in the Documentation section for complete publication states diagram.Parameters
builder: RequestBuilder
params: { billingTag?: string; publicationId: string }
Optional billing
Tag?: string publication
Id: string
Returns Promise<Response>
upload Partitions
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.
Parameters
builder: RequestBuilder
params: { billingTag?: string; body: PublishPartitions; layerId: string; publicationId: string }
Optional billing
Tag?: string body: PublishPartitions
layer
Id: string publication
Id: string
Returns Promise<Response>
Generated using TypeDoc
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.
Cancels a publication