Show Menu
TOPICS×

getActiveJobs

Gets all currently active jobs.
Syntax

Authorized User Types

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

Parameters

Input (getActiveJobsParam)
Name
Type
Required
Description
* companyHandle *
xsd:string
No
The handle to the company.
* jobHandle *
xsd:string
No
The handle to the job.
* originalName *
xsd:string
No
Original job name.
Output (getActiveJobsReturn)
Name
Type
Required
Description
* jobArray *
xsd:string
Yes
Array of active jobs.

Examples

This code sample returns all active jobs of a company running in IPS. In this case, the response is unusual because the IPS scheduling coordinator is disabled with no active jobs running. Under normal circumstances, the response would return a number of active jobs.
Request
<ns1:getActiveJobsParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:companyHandle>47</ns1:companyHandle>
</ns1:getActiveJobsParam>

Response
<getActiveJobsReturn xmlns="http://www.scene7.com/IpsApi/xsd">
   <jobArray></jobArray>
</getActiveJobsReturn>