Show Menu
TOPICS×

restoreAssetsFromTrash

Restores assets from trash.
Syntax

Authorized User Types

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

Parameters

Input (restoreAssetsFromTrashParam)
Name
Type
Required
Description
* companyHandle *
xsd:string
Yes
The handle to a company with the assets you want to restore.
* assetHandleArray *
types:HandleArray
Yes
Array of handles for the assets you want to restore.
Output (restoreAssetsFromTrashReturn)
Name
Type
Required
Description
* successCount *
xsd:int
Yes
Number of assets successfully removed from the trash.
* warningCount *
xsd:int
Yes
Number of warnings generated when the operation attempted to restore assets from the trash.
* errorCount *
xsd:int
Yes
Number of errors generated when attempting to restore assets from the trash.
* warningDetailArray *
types:AssetOperationFaultArray
No
The array of details associated with the assets that generated warnings when the operation attempted to restore assets from the trash.
* errorDetailArray *
types:AssetOperationFaultArray
No
The array of details associated with the assets that generated errors when the operation attempted to restore assets from the trash.

Examples

This code sample restores assets from the trash. The response indicates the operation completed successfully.
Request
<restoreAssetsFromTrashParam 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>
</restoreAssetsFromTrashParam>

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