replaceImage

Replaces image data for an image asset.

Syntax

Authorized User Types

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin
  • ImagePortalContrib
  • ImagePortalContribUser

Parameters

Input (replaceImageParam)

Name Type Required Description
*companyName* xsd:string Yes The handle to the company with the image you want to replace.
*assetHandle* xsd:string Yes The handle to the asset you want to replace.
*urlModifier* xsd:string Yes Image Server commands that generate new image data.

Output (replaceImageReturn)

Name Type Required Description
*assetHandle* xsd:string Yes Handle to the new asset.

Examples

This code sample replaces an image and and applies a urlModifier with a command that specifies that the Image Server will take no action upon replacement.

Request

<replaceImageParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
   <companyHandle>c|21</companyHandle>
   <assetHandle>a|140626|1|102524</assetHandle>
   <urlModifier>action=none</urlModifier>
</replaceImageParam>

Response

<replaceImageReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
   <assetHandle>a|140626|1|102524</assetHandle>
</replaceImageReturn>

On this page