Operation: automation::sisGetJobStatus


General Description

Used to obtain the job status for the SIS service.

Operation Notes

System Privileges Mail Privileges Calendar Privileges Database Privileges
sys.c.manageAutomationJobs -- -- db.[default_db].h_sis_jobs.browse

Request Message

Input Parameters

The sisGetJobStatus method takes the following input parameters. It is important to note that the parameters must be passed to the operation in the same order as they appear here in order to satisfy the requirement of the input validation checks.

Name Type Attributes Description
jobId xs:unsignedInt required once The Job id of the job you want to get the job status for.
waitForSeq xs:integer optional
default=0
The sequence number to wait on the job for. If not specified, then this operation will return immediately.
waitTime xs:unsignedInt optional
default=0
The amount of time to wait (in seconds) for the job status to meet the waitFor sequence. If not specified (or set to zero) then this function will return immediately.

Input Data


Response Message

Output Parameters

Name Type Attributes Description
jobStatus sisJobStatus required once The current status of the job.
runTarget xs:string optional The target the job is running on. If not specified then the job has not started yet.
log xs:string optional The processing log.
resultCode xs:unsignedInt optional The result code that the running process returned when complete, if the job is still running this will not be present.
result xs:string optional The output of the process that was run.
outputParam sisJobOutputParamType optional
minOccurs=0
maxOccurs=unbounded
The output params (if any) from the process that was run.
lastUpdateSeq xs:unsignedInt required once The last update sequence number, use this in the waitForSeq input param to long poll status changes.

Output Data


Code Generation & Samples

The links below will generate sample code in the respective languages. You can use these links as a convenient way of generating the correct code needed to invoke this method

JavaScript   PHP   C#   Java   C++   [ hide code ]  

Powered by Hornbill, for more information click here. (page served by , .)