setAssetsPublishState

Determines if a batch of assets are ready to be published.

This is the batch version of setAssetState.

Authorized User Types

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin
  • ImagePortalContrib
  • ImagePortalContribUser
NOTE

The user must have read and write access to the asset.

Parameters

Input (setAssetsPublishStateParam)

Name Type Required Description
*companyHandle* xsd:string Yes Company handle.
*publishStateUpdateArray* types:PublishStateUpdateArray Yes Array of publish state values for the assets.

Output (setAssetsPublishStateParam)

Name Type Required Description
*successCount* xsd:int Yes The number of successfully updated assets.
*warningCount* xsd:int Yes The number of assets that generated a warning when the operation tried to update them.
*errorCount* xsd:int Yes The number of assets that generated an error when the operation tried to delete them.
*warningDetailArray* types:AssetOperationFaultArray No Details associated with the asset updates that generated a warning.
*errorDetailArray* types:AssetOperationFaultArray No Details associated with the asset updates that generated an error.

Examples

This code sample sets the publication state of an asset.

Request

<element name="setAssetsPublishStateParam">
   <complexType>
      <sequence>
         <element name="companyHandle" type="xsd:string"/>
         <element name="publishStateUpdateArray" type="types:PublishStateUpdateArray"/>
      </sequence>
   </complexType>
</element>

Response

<element name="setAssetsPublishStateReturn">
   <complexType>
      <sequence>
         <element name="successCount" type="xsd:int"/>
         <element name="warningCount" type="xsd:int"/>
         <element name="errorCount" type="xsd:int"/>
         <element name="warningDetailArray"type="types:AssetOperationFaultArray" minOccurs="0"/>
         <element name="errorDetailArray"type="types:AssetOperationFaultArray" minOccurs="0"/>
      </sequence>
   </complexType>
</element>

On this page