Creates an image set.
Syntax
IpsUser
IpsAdmin
IpsCompanyAdmin
ImagePortalAdmin
ImagePortalContrib
ImagePortalContribUser
The user must have read/write access to the destination folder.
Input (createImageSetParam)
Name | Type | Required | Description |
---|---|---|---|
companyHandle | xsd:string |
Yes | The handle to the company that the image set belongs to. |
folderHandle | xsd:string |
Yes | The handle to the folder. |
name | xsd:string |
Yes | Image set name. |
type | xsd:string |
Yes | Image set type. |
thumbAssetHandle | xsd:string |
No | Handle of the asset that acts as the thumbnail for the new image set. If not specified, IPS tries to use the first image asset referenced by the set. |
Output
Name | Type | Required | Description |
---|---|---|---|
assetHandle | xsd:string |
Yes | The handle to the new image set. |
This code sample creates an image set specified by company, folder, name, and type. The response is an asset handle of the newly created image set.
Request
<ns1:createImageSetParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
<ns1:folderHandle>MyCompany/eCatalogs/</ns1:folderHandle>
<ns1:name>My Image Set</ns1:name>
<ns1:type>ImageSet</ns1:type>
</ns1:createImageSetParam>
Response
<createImageSetReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<assetHandle>25741|22|841</assetHandle>
</createImageSetReturn>