DocumentationDynamic Media Image Production System API

getPropertySetType getpropertysettype

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

CREATED FOR:

  • Developer
  • Admin

Gets a property set type using a handle to a company and the name of the property set type. It gets a type structure with the handle to the type as well as the property type.

Syntax

Authorized User Types section-2b291d32f95b4a3d854429124cbae24c

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

Parameters section-c9a53400c44744668bd7915f72d2bf3d

Input (getPropertySetTypeParam)

Name
Type
Required
Description
companyHandle
xsd:string
No
The handle to the company. Optional because a property set type can belong to multiple companies.
name
xsd:string
Yes
Property set type name.

Output (getPropertySetTypeReturn)

Name
Type
Required
Description
type
types:PropertySetType
Yes

The type structure that contains a:

  • Handle.
  • Type name.
  • Property type.
  • Value that indicates if the type allows multiple property types.

Examples section-1b57199415e34a8fa449f864f8895b14

This code sample returns a property set type by name.

Request

<getPropertySetTypeParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
   <name>Adobe.UserProperty</name>
</getPropertySetTypeParam>

Response

<getPropertySetTypeReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
   <type>
      <typeHandle>pt|10801</typeHandle>
      <name>Adobe.UserProperty</name>
      <propertyType>UserProperty</propertyType>
      <allowMultiple>false</allowMultiple></type>
</getPropertySetTypeReturn>
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681