Pauses an active job.
Syntax
IpsUser
IpsAdmin
IpsCompanyAdmin
TrialSiteAdmin
TrialSiteUser
ImagePortalAdmin
ImagePortalContrib
ImagePortalContribUser
Input (pauseJobParam)
Name | Type | Required | Description |
---|---|---|---|
companyHandle | xsd:string |
Yes | Handle to the company. |
jobHandle | xsd:string |
Yes | Handle to the job you want to pause. |
Output (PauseJobReturn)
The IPS API does not return a response for this operation.
This code sample pauses an active job.
Request
<pauseJobParam xmlns="http://www.scene7.com/IpsApi/xsd">
<companyHandle>47</companyHandle>
<jobHandle>47|My Test Job|</jobHandle>
</pauseJobParam>
Response
None.