Home > @tridion-sites/extensions > UnpublishItemsRequest
Signature:
export interface UnpublishItemsRequest
| Property | Modifiers | Type | Description |
|---|---|---|---|
| includeChildPublications? | boolean | (Optional) Value indicating whether to resolve items also from all child Publications where user has PublishManagement rights. | |
| includeCurrentPublication? | boolean | (Optional) Value indicating whether items will be (un)published inside the current Publication. | |
| itemIds | ReadonlyArray<ItemUri> | The identifiers of the items that will be send for un-publishing. | |
| priority? | PublishPriority | (Optional) The priority of the un-publish action. | |
| publishInChildPublications? | ReadonlyArray<ItemUri> | (Optional) Collection of TCM URIs of child Publications where items will be unpublished. | |
| startAt? | string | (Optional) Date and time when the un-publishing should be started. 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. | |
| 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. |