getPropertySetType

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

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

Parameters

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

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>

On this page

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now