DocumentationDynamic Media Image Production System API

restoreAssetsFromTrash restoreassetsfromtrash

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

CREATED FOR:

  • Developer
  • Admin

Restores assets from trash.

Syntax

Authorized User Types section-15e887782c7d4ace897ff02c6ad5baa0

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

Parameters section-200a61d040c94e489a85241b29cd499a

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 section-98fe0394b0634ca397c395f14f8a9358

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
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681