getJobsList
Describes the getJobsList Web service for HCL Workload Automation job streams.
- Description
- Use this service to get a list of the jobs - and their properties - of a job stream in the plan.
You must have list access to the job stream in the security file to run this service.
- Input parameters
-
- engineName
- Not used; set to null.
- jobStreamId
- The job stream identifier in the plan: either workstationName#jobStreamName(hhmm[ date]) or workstation#jobstream_id. See the HCL Workload Automation: User's Guide and Reference for details.
- Output
- The response getJobsListResponse returns an array getJobsListReturn containing the list of the jobs included in the job stream. For each job instance the following details are also listed:
- jobId
- The job identifier.
- jobName
- The name of the job.
- jobStreamName
- The name of the job stream including the job.
- workstationName
- The name of the workstation that ran the job.
- jobStreamWorkstationName
- The name of the workstation associated with the job stream.
- jobNumber
- The number assigned to the job at runtime.
- priority
- The execution priority with which the job ran. Can be one (or a range of values) of the following:
- A number ranging from 0 to 99
- hi
- go
- status
- Can be one of the following:
- ERROR
- HELD
- READY
- RUNNING
- SUCCESSFULL
- UNDECIDED
- WAITING
- internalStatus
- Can be one of the following:
- ABEND
- ABENDP
- BOUND
- CANCP
- DONE
- ERROR
- EXEC
- EXTRN
- FAIL
- FENCE
- HOLD
- INTRO
- PEND
- READY
- RJOB
- SCHED
- SUCC
- SUCCP
- SUSP
- USER
- WAIT
- WAITD
- requiredConfirmation
- Can be true or false.
- aliased
- Can be true or false.
- canceled
- Can be true or false.
- every
- The job instance was run with the every option. Can be true or false.
- everyRerun
- The job instance is a rerun of a job defined with the every option. Can be true or false.
- external
- The job is a predecessor to another job stream or one of its jobs. Can be true or false.
- jobLate
- The job passed its completion deadline. Can be true or false.
- pendingCancellation
- The job stream is pending cancellation. Cancellation is deferred until all of the dependencies, including an at time, are resolved. Can be true or false.
- recoveryRerunJob
- The job is defined with the recovery action RERUN. This enables the recovery job to take some corrective action, before the parent job attempts to run again. Can be true or false.
- released
- The job was released from its dependencies. Can be true or false.
- rerunJob
- The job was rerun. Can be true or false.
- running
- The job is still running. Can be true or false.
- startTime
- The start time defined for the job in YYYYMMDD HHMM format or milliseconds.
- lateststartTime
- The value of the until restriction of the job instance in YYYYMMDD HHMM format or milliseconds.
- lateststartAction
- The action taken after the until restriction time elapsed. Can be CANCEL, CONTINUE, or SUPPRESS.
- deadlineTime
- The value of the deadline restriction of the job instance in YYYYMMDD HHMM format or milliseconds.
- repeatRange
- The time interval between every reruns of the job in milliseconds.
If the service did not complete successfully, getJobsListResponse returns one of the errors described in Managing errors.