DocumentationDynamic Media Image Production System API

addProjectAssets

Last update: Wed Mar 09 2022 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • Admin

Adds one or more assets to a project.

Syntax

Authorized User Types

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

Parameters

Input (addProjectAssetsParam)

Name
Type
Required
Description
companyHandle
xsd:string
Yes
Handle to the company associated with the current project.
projectHandle
xsd:string
Yes
Handle to the project you’re adding assets to.
projectHandleArray
xsd:HandleArray
Yes
Array of assets you’re adding to the current project.

Output (addProjectAssetsParam)

Name
Type
Required
Description
successCount
xsd:int
Yes
The number of assets added successfully.
warningCount
xsd:int
Yes
The number of warnings generated when the operation attempted to add assets to a project.
errorCount
xsd:int
Yes
The number of errors generated when the operation attempted to add assets to a project.
warningDetailHandle
xsd:AssetOperationFaultArray
No
Array of warnings generated by assets when the operation attempted to add them to a project.
companyHandle
xsd:AssetOperationFaultArray
No
Array of errors generated by assets when the operation attempted to add them to a project.

Examples

This example adds a single asset (referenced by its handle) in an asset handle array to a project specified in the request. The operation completed successfully when the response successCount returns 1.

Request

<addProjectAssetsParam 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>
   </assetHandleArray>
</addProjectAssetsParam>

Response

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