Creates a generic asset set with a raw set definition string to be published to an Image Server.
Syntax
IpsUser
IpsAdmin
IpsCompanyAdmin
ImagePortalAdmin
ImagePortalContrib
ImagePortalContribUser
Input (createAssetSet)
Name | Type | Required | Description |
---|---|---|---|
companyHandle | xsd:string | Yes | The handle to the company that will contain the asset set. |
folderHandle | xsd:string | Yes | The handle to the folder in which the new asset set will be created. |
name | xsd:string | Yes | Asset name. |
subType | xsd:string | Yes | A unique identifier created by the client for the asset set type. |
setDefinition | xsd:string | No | The parameters in the set definition string. These must resolve to the format specified by the target viewer. |
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. |
Substitution Functions for setDefinition
You can specify substitution functions in line which are resolved during catalog lookup or publication. Substitution strings have the format ${<substitution_func>}
. Available functions are enumerated below.
The handle literals in parameter lists must be surrounded by brackets ([])
. All text that is outside of a substitution string is copied verbatim to the output string during resolution.
Substitution Function | Returns |
---|---|
getFilePath([asset_handle>]) |
The asset’s primary source file path. |
getCatalogId([<asset_handle>]) |
The asset’s catalog ID. |
getMetaData([<asset_handle>], [<metadata_field_handle>]) |
Metadata values for the asset. |
getThumbCatalogId([<asset_handle>]) |
The asset’s catalog ID (for image-based assets only).The associated thumb asset’s catalog ID (for other assets). If an associated thumb asset is not available, the function returns an empty string. |
Sample Media setDefinition String
${getCatalogId([a|1664|22|1664])};${getCatalogId([a|1664|22|1664])};1,${getFilePath([a|103
6|19|144])};${getCatalogId([a|452|1|433])};2;${getMetadata([a|1036|19|144], [m|1|ASSET|SharedDateField])}
At catalog lookup or publish time, this is resolved to a string similar to the following:
jcompany/myRenderSet;jcompany/myRenderSet;1,jcompany/Videos/Somebodys_N08275_flv.flv;jcomp any/myimg-1;2;20090703 10:05:53
Output (createAssetSet)
Name | Type | Required | Description |
---|---|---|---|
* assetHandle* |
xsd:string |
Yes | The handle to the asset set. |
Request
<createAssetSetParam xmlns="http://www.scene7.com/IpsApi/xsd/2009-07-31">
<companyHandle>c|1</companyHandle>
<folderHandle>f|jcompany/AssetSets/</folderHandle>
<name>testAssetSet</name>
<subType>MediaSet</subType>
</createAssetSetParam>
Response
<createAssetSetReturn xmlns="http://www.scene7.com/IpsApi/xsd/2009-07-31">
<assetHandle>a|1801|44|1801</assetHandle>
</createAssetSetReturn>