DocumentationDynamic Media Image Production System API

deleteJob deletejob

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

CREATED FOR:

  • Developer
  • Admin

Deletes a current or scheduled job.

Syntax

Authorized User Types section-1b959679dc8147c291126ddf7e061742

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • ImagePortalContrib
  • ImagePortalContribUser

Parameters section-000c42bc93744b1a8e777f3ec3c272b0

Input (deleteJobParam)

Name
Type
Required
Description
companyHandle
xsd:string
Yes
The handle to the company to which the job belongs.
jobHandle
xsd:string
Yes
The handle to the job to delete.

Output

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

Examples section-732d21d4dad04337b7a5ae1a0cc00eba

This code sample deletes a job that is running or is scheduled to run in IPS. It requires a job handle, which you must obtain from another operation.

Request

<deleteJobParam xmlns="http://www.scene7.com/IpsApi/xsd">
   <companyHandle>47</companyHandle>
   <jobHandle>47|My Test Job|</jobHandle>
</deleteJobParam>

Response

None.

recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681