DocumentationDynamic Media Image Production System API

deleteImageFormat

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

CREATED FOR:

  • Developer
  • Admin

Deletes an image format. Get the image format handle from saveImageFormat.

Syntax

Authorized User Types

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin

Parameters

Input (deleteImageFormatParam)

Name
Type
Required
Description
companyHandle
xsd:string
Yes
The handle to the company that contains the image format that you want to delete.
imageFormatHandle
xsd:string
Yes
The handle to the image format you want to delete.

Output (deleteImageFormatParam)

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

Examples

This code sample deletes an image format from a company. Obtain the image format handle from another operation.

Request

<deleteImageFormatParam xmlns="http://www.scene7.com/IpsApi/xsd">
   <companyHandle>47</companyHandle>
   <imageFormatHandle>47|301</imageFormatHandle>
</deleteImageFormatParam>

Response

None.

Related Topic:

saveImageFormat

4e9b9d8c-5839-4215-aa35-01b652869681