DocumentationDynamic Media Image Production System API

stopJob stopjob

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

CREATED FOR:

  • Developer
  • Admin

Stops a job in progress.

Syntax

Authorized User Types section-b222f561143747f6ad089aadc0b274d8

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

Parameters section-2b64f074e37c4c38849994f3bc65342a

Input (stopJobParam)

Name
Type
Required
Description
companyHandle
xsd:string
Yes
Company handle.
jobHandle
xsd:string
Yes
Handle to the job you want to stop.

Output (stopJobReturn0

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

Examples section-f7e07fa09ae24dc89685533f20ab3b81

Request

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

Response

None.

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