Documentation

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

/ automation / sisGetJobStatus

Description

Used to obtain the job status for the SIS service.

API Details

  • Status:
  • The required privilege level to invoke this method is user
  • The supported database role for this method is none
System Rights Database Rights Mail Rights Calendar Rights
sys.c.manageAutomationJobs
--- --- ---

Request Parameters

The sisGetJobStatus method takes the following input parameters. It is important to note that the parameters must be passed to the method 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 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.

Response Parameters

Name Type Attributes Description
jobStatus sisJobStatus Required 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
Array (0/∞)
The output params (if any) from the process that was run.
lastUpdateSeq xs:unsignedInt Required The last update sequence number, use this in the waitForSeq input param to long poll status changes.
In This Document