DocumentationDynamic Media Image Production System API

createPropertySetType

Last update: March 8, 2022
  • Topics:
  • Dynamic Media Classic,SDK/API

CREATED FOR:

  • Developer
  • Admin

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

Syntax

Authorized User Types

  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • ImagePortalAdmin

Parameters

Input (createPropertySetTypeParam)

NameTypeRequiredDescription
companyHandlexsd:stringNoThe 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.
namexsd:stringYesThe name of the property set type.
propertyTypexsd:stringYesChoice of property set types.
allowMultiplexsd:booleanYesDetermines if your program can have multiple property sets.

Output (createPropertySetTypeReturn)

NameTypeRequiredDescription
typeHandlexsd:stringYesA 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 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