DocumentationDynamic Media Image Production System API

deleteAssets

Last update: Tue Jul 20 2021 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • Admin

Deletes multiple assets.

Syntax

Authorized user types

  • IpsUser
  • IspAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin
  • ImagePortalContrib
  • ImagePortalContribUser

Parameters

Input (deleteAssetsParam)

Name
Type
Required
Description
companyHandle
xsd:string
Yes
The handle to the company the assets belong to.
assetHandleArray
types:HandleArray
Yes
The array of assets to be deleted.

Output (deleteAssetsParam)

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

Examples

This code sample sends a handle to a company and an array of asset handles in a deleteAssetsParam request to the Web services server. deleteAssetsReturn returns a success count of 2, indicating both assets were deleted.

Request

<deleteAssetsParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
   <companyHandle>c|6</companyHandle>
   <assetHandleArray>
      <items>a|942|1|579</items>
      <items>a|943|1|580</items>
   </assetHandleArray>
</deleteAssetsParam>

Response

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