DocumentationDynamic Media Image Production System API

setAssetPublishState setassetpublishstate

Last update: Tue Jul 20 2021 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • Admin

Determines if an asset is ready to be published.

Syntax

Authorized User Types section-11bec77e50b24461bb8c8aacf016eec8

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

Parameters section-09d2ba001a2a455a9102550272f3eecb

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 section-c31ead6d0e594317a12c120509527792

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.

recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681