DocumentationDynamic Media Image Production System API

moveAssets

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

CREATED FOR:

  • Developer
  • Admin

Moves multiple assets independently of each other. It accomplishes this using the AssetMove type contained in the assetMoveArray. Each AssetMove field contains a destination folder.

Syntax

Authorized User Types

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

Parameters

Input (moveAssetsReturn)

Name
Type
Required
Description
companyHandle
xsd:string
Yes
The handle to the company with assets to be moved.
assetMoveArray
types:AssetMoveArray
Yes
An asset move array. It contains an asset and an asset destination folder.

Output (moveAssetsReturn)

Name
Type
Required
Description
successCount
xsd:int
Yes
Successfully moved asset count.
warningCount
xsd:int
Yes
Count of assets that generated warnings when the operation attempted to move them.
errorCount
xsd:int
Yes
Count of assets that generated errors when the operation attempted to move them.
warningDetailArray
types:AssetOperationFaultArray
No

AssetOperationFaultsthat contain the:

  • Assets that threw the warnings.
  • Warning codes.
  • Reason for the warning.
errorDetailArray
types:AssetOperationFaultArray
No

AssetOperationFaultsthat contain the:

  • Assets that threw the errors.
  • Error codes.
  • Reason for the errors.

Examples

This code sample moves assets to a specific location specified by the assetMoveArray. The array includes the asset handle and its folder handle. The response indicates the assets were moved successfully.

Request

<moveAssetsParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
   <companyHandle>c|6</companyHandle>
   <assetMoveArray>
      <items>
          <assetHandle>a|942|1|579</assetHandle>
          <folderHandle>ApiTestCo/uploads/</folderHandle>
      </items>
      <items>
         <assetHandle>a|943|1|580</assetHandle>
         <folderHandle>ApiTestCo/uploads/</folderHandle>
      </items>
   </assetMoveArray>
</moveAssetsParam>

Response

<moveAssetsReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
   <successCount>2</successCount>
   <warningCount>0</warningCount>
   <errorCount>0</errorCount>
</moveAssetsReturn>
4e9b9d8c-5839-4215-aa35-01b652869681