setAssetPublishState

Last update: July 20, 2021

CREATED FOR:

  • Developer
  • Admin

Determines if an asset is ready to be published.

Syntax

Authorized User Types

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalContrib
  • ImagePortalContribUser
NOTE
The user must have read and write access to the asset.

Parameters

Input (setAssetPublishStateParam)

NameTypeRequiredDescription
companyHandlexsd:stringYesThe handle to the company.
assetHandlexsd:stringYesAsset handle.
publishStatexsd:stringYes

Available states:

  • MarkedForPublish
  • NotMarkedForPublish
contextHandleArrayCode Phrase

Output

The IPS API does not return a response for this operation.

Examples

This code sample sets the publication state of an asset using NotMarkedForPublish.

Request

<setAssetPublishStateParam xmlns="http://www.scene7.com/IpsApi/xsd">
   <companyHandle>47</companyHandle>
   <assetHandle>24267|1|17063</assetHandle>
   <publishState>NotMarkedForPublish</publishState>
</setAssetPublishStateParam>

Response

None.

Experience Manager