Documentation Dynamic Media Image Production System API

batchSetImageFields

Last update: March 8, 2022

Topics:
Dynamic Media Classic,SDK/API

CREATED FOR:

Developer
Admin

Sets image-specific fields for one or more image assets.

Syntax

Authorized User Types

IpsUser
IpsAdmin
IpsCompanyAdmin
ImagePortalAdmin
ImagePortalContrib
ImagePortalContribUser

Parameters

Input (batchSetImageFields)

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

Output (batchSetImageFields)

Name	Type	Required	Description
successCount	`xsd:int`	Yes	The number of successfully set image fields.
warningCount	`xsd:int`	Yes	The number of warnings generated when the operation attempted to set the image fields.
errorCount	`xsd:int`	Yes	The number of errors generated when the operation attempted to set the image fields.
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

This example sets data in the fields of two images in an update array. In the array, the images are specified by their asset handles and contain resolution in pixels, x- and y-position anchor coordinates, and user data. The response indicates that fields for both images were set successfully.

Request

<batchSetImageFieldsParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
   <companyHandle>c|21</companyHandle>
   <updateArray>
      <items>
         <assetHandle>a|140626|1|102524</assetHandle>
         <resolution>72</resolution>
         <anchorX>50</anchorX>
         <anchorY>100</anchorY>
         <userData>nada1</userData>
      </items>
      <items>
         <assetHandle>a|96680|1|64865</assetHandle>
         <resolution>150</resolution>
         <anchorX>100</anchorX>
         <anchorY>50</anchorY>
         <userData>nada2</userData>
      </items>
   </updateArray>
</batchSetImageFieldsParam>

Response

<batchSetImageFieldsReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
   <successCount>2</successCount>
   <warningCount>0</warningCount>
   <errorCount>0</errorCount>
</batchSetImageFieldsReturn>

recommendation-more-help