Creates a copy of an existing image asset. The specified Image Server protocol commands are applied to generate the new copy
Syntax
IpsUser
IpsAdmin
IpsCompanyAdmin
ImagePortalAdmin
ImagePortalContrib
ImagePortalContribUser
Input (copyImageParam)
Name |
Type |
Required |
Description |
---|---|---|---|
companyName |
xsd:string |
Yes |
The handle to the company that contains the image. |
assetHandle |
xsd:string |
Yes |
The handle to the image asset. |
folderHandle |
xsd:string |
Yes |
The handle to the folder where the image is to be copied. |
name |
xsd:string |
Yes |
Name of new image. |
urlModifier |
xsd:string |
Yes |
|
Output (copyImageParam)
Name |
Type |
Required |
Description |
---|---|---|---|
assetHandle |
xsd:string |
Yes |
The handle to the copied image. |
The sample code copies an image specified by company, asset, folder handle, and name.
Request
<copyImageParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|6</companyHandle>
<assetHandle>a|739|1|537</assetHandle>
<folderHandle>ApiTestCo/</folderHandle>
<name>Copy_macbookwin1</name>
<urlModifier/>
</copyImageParam>
Response
<copyImageReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<assetHandle>a|943|1|580</assetHandle>
</copyImageReturn>