DocumentationDynamic Media Image Production System API

deleteImageMap

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

CREATED FOR:

  • Developer
  • Admin

Deletes an image map.

Syntax

Authorized User Types

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin
  • ImagePortalContrib
  • ImagePortalContribUser
NOTE
The user must have read and write access to the asset.

Parameters

Input (deleteImageMapParam)

Name
Type
Required
Description
companyHandle
xsd:string
Yes
The handle to the company that contains the image map to delete.
imageMapHandle
xsd:string
Yes
The handle to the image map to delete.

Output (deleteImageMapParam)

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

Examples

This code sample deletes an image map from a company. You must obtain the image map handle from another operation.

Request

<deleteImageMapParam xmlns="http://www.scene7.com/IpsApi/xsd">
   <companyHandle>47</companyHandle>
   <imageMapHandle>34191|8|554</imageMapHandle>
</deleteImageMapParam>

Response

None

4e9b9d8c-5839-4215-aa35-01b652869681