batchSetAssetMetadata

Sets asset metadata using batch mode.

Syntax

Authorized User Types

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

Parameters

Input (batchSetAssetMetadataParam)

Name Type Required Description
*companyHandle* xsd:string Yes The handle to the company whose metadata you want to set in a batch operation.
*updateArray* types:BatchMetadataUpdateArray Yes The array of metadata updates applied to the assets.

Output (batchSetAssetMetadataParam)

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

Examples

Request

<batchSetAssetMetadataParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|6</companyHandle>
<updateArray>
   <items>
      <assetHandleArray>
         <items>a|743|1|538</items>
         <items>a|744|1|539</items>
      </assetHandleArray>
      <updateArray>
         <items>
            <fieldHandle>m|6|IMAGE|saveMetadataField</fieldHandle>
            <value>400</value>
         </items>
      </updateArray>
   </items>
   <items>
      <assetHandleArray>
         <items>a|732|1|535</items>
         <items>a|739|1|537</items>
      </assetHandleArray>
      <updateArray>
         <items>
            <fieldHandle>m|6|IMAGE|saveMetadataField</fieldHandle>
            <value>300</value>
         </items>
      </updateArray>
   </items>
</updateArray>
</batchSetAssetMetadataParam>

Response

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

On this page