tridion-sites-extensions-api-docs

Home > @tridion-sites/extensions > PublishItemsRequest

PublishItemsRequest interface

Signature:

export interface PublishItemsRequest

Properties

Property Modifiers Type Description
deployAt?   string (Optional) Date and time when the content should be deployed at the content delivery side. Should be specified in UTC format. The value will be converted to UTC time if specified with time zone shift, e.g. “2020-01-24T17:24:50+02:00” will be converted to “2020-01-24T15:24:50Z” Conversion is not happening if time zone shift is not specified.
includeChildPublications?   boolean (Optional) Value indicating whether to resolve items also from all child Publications where user has PublishManagement rights.
includeComponentLinks?   boolean (Optional) Value indicating whether component links should also be resolved.
includeCurrentPublication?   boolean (Optional) Value indicating whether items will be (un)published inside the current Publication.
includeDynamicVersion?   boolean (Optional) Value indicating whether dynamic version of the item will be resolved.
includeWorkflow?   boolean (Optional) Value indicating whether the item is published from the user’s work list.
itemIds   ReadonlyArray<ItemUri> The identifiers of the items that will be send for publishing.
priority?   PublishPriority (Optional) The priority of the publish action.
publishInChildPublications?   ReadonlyArray<ItemUri> (Optional) Collection of TCM URIs of child Publications where items will be unpublished.
publishNewContent?   boolean (Optional) Value indicating whether already published items should be published.
structureResolveOption?   StructureResolveOption (Optional) Value indicating the option to include the resolved items and/or structure.
targetIdsOrPurposes?   ReadonlyArray<string> (Optional) A collection of Publishing Target instances (Target Types or Purposes) where the items are published to.