DocumentationDynamic Media Image Production System API

createPropertySetType createpropertysettype

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

CREATED FOR:

  • Developer
  • Admin

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

Syntax

Authorized User Types section-48e5f908276c4a549fd33a8828bad326

  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • ImagePortalAdmin

Parameters section-43dece72eb9f44df80f4a119dd2c008b

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 is 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 section-13396c9639a6475190e622eae3cdb534

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 is 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>
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681