DocumentationDynamic Media Image Production System API

getPropertySetTypes getpropertysettypes

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

CREATED FOR:

  • Developer
  • Admin

Gets the property set types associated with the specified company, or global property set types if no company is specified.

Syntax

Authorized User Types section-9c7c0d2cd2c94dfca3f96774b3a9a2c6

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • ImagePortalUser
  • ImagePortalContrib
  • ImagePortalContribUser

Parameters section-ac3ed9e036b54ea993f544046ff0e15d

Input (getPropertySetTypesParam)

Name
Type
Required
Description
companyHandle
xsd:string
No

The handle to the company that the property set types are associated with.

Omit if you want to return global property set types.

Output (getPropertySetTypesReturn)

Name
Type
Required
Description
typeArray
types:PropertySetTypeArray
Yes
An array of property set types associated with the specified company, or the global property set types if no company was specified.

Examples section-280c406a90864409856aee44d4069a52

Request

<getPropertySetTypesParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
  <companyHandle>c|1</companyHandle>
</getPropertySetTypesParam>

Response

<getPropertySetTypesReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
  <typeArray>
    <items>
      <typeHandle>pt|1</typeHandle>
      <companyHandle>c|1</companyHandle>
      <name>SavedSearch</name>
      <propertyType>UserCompanyProperty</propertyType>
      <alllowMultiple>true</alllowMultiple>
    </items>
    <items>
      <typeHandle>pt|2</typeHandle>
      <companyHandle>c|1</companyHandle>
      <name>CompanyMetadata</name>
      <propertyType>CompanyProperty</propertyType>
      <alllowMultiple>true</alllowMultiple>
    </items>
  </typeArray>
</getPropertySetTypesReturn>
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681