Show Menu
TOPICS×

stopJob

Stops a job in progress.
Syntax

Authorized User Types

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

Parameters

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

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

Response
None.