DocumentationDynamic Media Image Production System API

removeProjectAssets

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

CREATED FOR:

  • Developer
  • Admin

Removes assets from a project. Does not destroy the assets.

Syntax

Authorized User Types

  • IpsUser
  • IpsCompanyAdmin
  • ImagePortalAdmin
  • ImagePortalContrib
  • ImagePortalContribUser

Parameters

Input (removeProjectAssetsParam)

Name
Type
Required
Description
companyHandle
xsd:string
Yes
The handle to the company with the assets you want to move.
projectHandle
xsd:string
Yes
The handle to the project assets you want to move.
assetHandleArray
types:HandleArray
Yes
Array of handles to the assets you want to move.

Output (removeProjectAssetsReturn)

Name
Type
Required
Description
successCount
xsd:int
Yes
Successfully removed asset count.
warningCount
xsd:int
Yes
The number of warnings generated when the operation attempted to remove assets from the project.
errorCount
xsd:int
Yes
The number of errors generated when the operation attempted to remove assets from the project.
warningDetailArray
types:AssetOperationFaultArray
No
The array of details associated with the assets that generated warnings when the operation attempted to remove them from the project.
errorDetailArray
types:AssetOperationFaultArray
No
The array of details associated with the assets that generated errors when the operation attempted to remove them from the project.

Examples

This code sample removes 2 assets from a project (specified by the project handle).

Request

<removeProjectAssetsParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
   <companyHandle>c|6</companyHandle>
   <projectHandle>p|6|ProjectTestAPI</projectHandle>
   <assetHandleArray>
      <items>a|732|1|535</items>
      <items>a|739|1|537</items>
   </assetHandleArray>
</removeProjectAssetsParam>
4e9b9d8c-5839-4215-aa35-01b652869681