Creates a layered image that can have multiple text and image layers.
The urlModifier
parameter specifies the Image Server protocol commands stored in the Image Server catalog applied prior to any user-supplied commands on the URL. The urlPostApplyModifier
parameter specifies protocol commands applied after any URL commands, which overrides any conflicting user-supplied settings.
IpsUser
IpsAdmin
ImagePortalAdmin
ImagePortalContrib
ImagePortalContribUser
Input (createTemplateParam)
Name | Type | Required | Description |
---|---|---|---|
companyHandle | xsd:string |
Yes | The company that the template belongs to. |
folderHandle | xsd:string |
Yes | The folder handle that represents the folder where the template resides. |
name | xsd:string |
Yes | Template name. |
type | xsd:string |
Yes | Template type. |
urlModifier | xsd:string |
Yes | Specifies the Image Server commands stored in the IS catalog that are applied prior to any user-supplied commands on the URL. |
urlPostApplyModifier | xsd:string |
No | Specifies protocol commands applied after any URL commands, which overrides any conflicting user-supplied settings. |
Output (createTemplateParam)
Name | Type | Required | Description |
---|---|---|---|
assetHandle | xsd:string |
Yes | The handle to the template. |
This code sample creates a template in a folder specified by a handle, with a name of APIcreateTemplate
, a urlModifier
, and a urlPostApplyModifier
. The response returns the handle to the newly created template.
Request
<createTemplateParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|21</companyHandle>
<folderHandle>ApiTestCo/</folderHandle>
<name>APIcreateTemplate</name>
<type>Template</type>
<urlModifier>url=Modifier</urlModifier>
<urlPostApplyModifier>urlPostApply=Modifier</urlPostApplyModifier>
</createTemplateParam>
Response
<createTemplateReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<assetHandle>a|153393|2|2061</assetHandle>
</createTemplateReturn>