Documentation

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!
  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

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

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Type: rpcVerb: post / automation / sisGetJobStatus

Description

Used to obtain the job status for the SIS service.

API Details

  • Status: Status: production
  • 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.

Note

When sending a JSON request payload to the API, the order of parameters is not significant. However, for XML request payloads, parameters must be provided in the exact order specified in this documentation to comply with input validation requirements.

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 Array<sisJobOutputParamType> Optional 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