createDerivedAsset
Creates a new asset derived from an existing primary source image asset.
Syntax
Derived assets specify Image Server protocol commands that modify the representation of the owner image. The AdjustedView
derived type helps apply simple modifications to a single image (for example, by specifying a crop rectangle), while the LayerView
helps create a multilayer view which may include text or additional images.
Unlike an image copy (see copyImage), a derived image is linked to its owner image. Changes to the owner image modifies associated derived assets. Deleting the owner image deletes any associated derived images.
Authorized User Types
IpsUser
IpsAdmin
IpsCompanyAdmin
ImagePortalAdmin
ImagePortalContrib
ImagePortalContribUser
Parameters
Input (createDerivedAssetParam)
xsd:string
xsd:string
xsd:string
xsd:string
xsd:string
AdjustedView
or LayerView
.xsd:string
urlPostApplyModifier
commands.xsd:string
urlPostApplyModifier
commands.Output (createDerivedAssetParam)
xsd:string
Examples
The sample code creates a derived asset with an adjusted view and urlModifier
and urlPostApplyModifier
with arbitrary values. The response returns the handle to the newly derived asset.
Request
<createDerivedAssetParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|6</companyHandle>
<ownerHandle>a|943|1|580</ownerHandle>
<folderHandle>ApiTestCo/</folderHandle>
<name>ApiDerivedAsset</name>
<type>AdjustedView</type>
<urlModifier>modify=this</urlModifier>
<urlPostApplyModifier>action=awesome</urlPostApplyModifier>
</createDerivedAssetParam>
Response
<createDerivedAssetReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<assetHandle>a|944|10|2</assetHandle>
</createDerivedAssetReturn>