DocumentationDynamic Media Image Production System API

batchSetThumbAsset

Last update: Tue Mar 08 2022 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • Admin

Sets the thumbnail image for one or more assets.

Syntax

Thumbnail Asset Types

Allowed thumbnail asset types consist of the following:

  • Image
  • AdjustedView
  • Mask
  • Template
  • PsdTemplate

Authorized User Types

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

Parameters

Input (batchSetThumbAssetParam)

Name
Type
Required
Description
companyHandle
xsd:string
Yes
The handle to the company that contains the assets.
updateArray
types:ThumbAssetUpdateArray
Yes
The array of updates.

Output (batchSetThumbAssetParam)

Name
Type
Required
Description
successCount
xsd:int
Yes
The number of successfully set thumbnails.
warningCount
xsd:int
Yes
The number of warnings generated when the operation attempted to set the thumbnails.
errorCount
xsd:int
Yes
The number of errors generated when the operation attempted to set the thumbnails.
warningDetailArray
types:AssetOperationFaultArray
No
The array of details associated with the assets that generated warnings when the operation attempted to apply the updates.
errorDetailArray
types:AssetOperationFaultArray
No
The array of details associated with the assets that generated errors when the operation attempted to apply the updates.

Examples

Request

<batchSetThumbAssetParam xmlns="http://www.scene7.com/IpsApi/xsd/2010-01-31">
   <companyHandle>c|3</companyHandle>
   <updateArray>
      <items>
         <assetHandle>a|234</assetHandle>
         <thumbAssetHandle>a|189</thumbAssetHandle>
      </items>
   </updateArray>

Response

<batchSetThumbAssetReturn xmlns="http://www.scene7.com/IpsApi/xsd/2010-01-31">
   <successCount>1</successCount>
   <warningCount>0</warningCount>
   <errorCount>0</errorCount>
</batchSetThumbAssetReturn>
4e9b9d8c-5839-4215-aa35-01b652869681