setAssetPublishState

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)

Name Type Required Description
companyHandle xsd:string Yes The handle to the company.
assetHandle xsd:string Yes Asset handle.
publishState xsd:string Yes Available states:
  • MarkedForPublish
  • NotMarkedForPublish
contextHandleArray Code 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.

On this page

Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now