DocumentationDynamic Media Image Production System API

pauseJob

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

CREATED FOR:

  • Developer
  • Admin

Pauses an active job.

Syntax

Authorized User Types

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

Parameters

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.

Examples

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.

4e9b9d8c-5839-4215-aa35-01b652869681