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 will delete any associated derived images.
IpsUser
IpsAdmin
IpsCompanyAdmin
ImagePortalAdmin
ImagePortalContrib
ImagePortalContribUser
Input (createDerivedAssetParam)
Name | Type | Required | Description |
---|---|---|---|
companyHandle | xsd:string |
Yes | The handle to the company that contains the asset from which you will derive the new asset. |
ownerHandle | xsd:string |
Yes | The handle to the primary Image asset from which the new image is derived. |
folderHandle | xsd:string |
Yes | The handle to the folder in which the new derived asset is created. |
name | xsd:string |
Yes | The name of the derived asset. |
type | xsd:string |
Yes | The asset type of the new derived asset: AdjustedView or LayerView . |
urlModifier | xsd:string |
No | Image serving or image rendering protocol commands applied before the request or urlPostApplyModifier commands. |
urlPostApplyModifier | xsd:string |
No | Image serving or image rendering protocol commands applied after to the request or urlPostApplyModifier commands. |
Output (createDerivedAssetParam)
Name | Type | Required | Description |
---|---|---|---|
assetHandle | xsd:string |
Yes | The handle to the derived asset. |
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>