Show Menu
TOPICS×

getProjects

Gets projects for a group of related assets.
Syntax

Authorized User Types

  • IpsUser
  • IpsAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalContrib
  • ImagePortalContribUser

Parameters

Input (getProjectsParam)
Name
Type
Required
Description
* companyHandle *
xsd:string
Yes
The handle to the company.
Output (getProjectsReturn)
Name
Type
Required
Description
* projectArray *
types:ProjectArray
Yes
The array of projects associated with the company.

Examples

This code sample returns all project handles in a project array.
Request
<ns1:getProjectsParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:companyHandle>47</ns1:companyHandle>
</ns1:getProjectsParam>

Response
<getProjectsReturn xmlns="http://www.scene7.com/IpsApi/xsd">
   <projectArray>
      <items>
         <projectHandle>47|My Project 1</projectHandle>
         <name>My Project 1</name>
      </items>
      <items>
         <projectHandle>47|My Project 2</projectHandle>
         <name>My Project 2</name>
      </items>
   </projectArray>
</getProjectsReturn>