Show Menu
TOPICS×

createPropertySetType

A property set type specifies various settings used to help manage property sets.
Syntax

Authorized User Types

  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • ImagePortalAdmin

Parameters

Input (createPropertySetTypeParam)
Name
Type
Required
Description
* companyHandle *
xsd:string
No
The handle to the company that owns the property set type. If companyHandle is not passed and the caller is an IpsAdmin , a global property set type will be created.
* name *
xsd:string
Yes
The name of the property set type.
* propertyType *
xsd:string
Yes
Choice of property set types.
* allowMultiple *
xsd:boolean
Yes
Determines if your program can have multiple property sets.
Output (createPropertySetTypeReturn)
Name
Type
Required
Description
* typeHandle *
xsd:string
Yes
A handle to the type.

Examples

This code sample creates a property set with a name and type specified by the PropertySet Types constant. The handle to the company that owns the property set type. If companyHandle is not passed and the caller is an IpsAdmin, a global property set type will be created.
Request
<createPropertySetTypeReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
   <typeHandle>pt|10803</typeHandle>
</createPropertySetTypeReturn>

Response
<createPropertySetTypeReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
   <typeHandle>pt|10801</typeHandle>
</createPropertySetTypeReturn>