DocumentationDynamic Media Image Production System API

setUrlModifier

Last update: Tue Mar 08 2022 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • Admin

Sets the Image Serving or Image Rendering protocol commands for the specified asset. These commands modify the representation of the asset without destroying it.

For Image Serving, commands in the urlModifier parameter are published in the Modifier catalog field and applied prior to any commands specified on the request URL. Commands in urlPostApplyModifier are published to the PostModifier catalog field and override any commands on the request URL or in urlModifier. For Image Rendering, the commands in urlModifier and urlPostApplyModifier are concatenated and published to the Modifier catalog field.

Authorized User Types

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

Parameters

Input (setUrlModifierParam)

Name
Type
Required
Description
companyHandle
xsd:string
Yes
Company handle.
assetHandle
xsd:string
Yes
Asset handle.
urlModifier
xsd:string
No
Image Serving or Image Rendering protocol commands to apply prior to request or urlPostApplyModifier commands.
urlPostApplyModifier
xsd:string
No
Image Serving or Image Rendering protocol commands to apply after urlModifier and request commands.

Output (setUrlModifierReturn)

The IPS API does not return a response for this operation.

Examples

Request

<setUrlModifierParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
   <companyHandle>c|6</companyHandle>
   <assetHandle>a|942|1|579</assetHandle>
   <urlModifier>modify=that</urlModifier>
   <urlPostApplyModifier>action=awesomeToo</urlPostApplyModifier>
</setUrlModifierParam>

Response

None.

4e9b9d8c-5839-4215-aa35-01b652869681