Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{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}}

{{book.title}}
More...

/ automation / sisRunJob

  • Article
  • 2 minutes to read

Description

Used to run a job

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 sisRunJob 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
jobPriority sisJobPriority Optional
Default=medium		 Specify the priority of job to run.
name xs:string Required No description provided
description xs:string Optional No description provided
target xs:anyURI Required Spefify a URN that describes the computer(s) that this job should be run on. For example, to target a specific computer, you should specify ‘computer:DAVEPC01’. To target a list of computers, you can specify ‘list:list_id’.
reference xs:anyURI Optional Specify any reference URN meaningful to the caller.
sisTarget xs:anyURI Optional Specify the Site Integration target. Can either be a group “grp:TheGroupName” or a SIS server directly “sis:SisName”
adminCredentials xs:unsignedInt Optional
Default=0		 Specify the credentials to use for administration tasks when running this job. If not specified, then the credentials that the Site Integration Service is using will be used.
runAsCredentials xs:unsignedInt Optional
Default=0		 Specify the credentials to use for running the process when running this job. If not specified, then the provided adminCredentials will be used.
packageId xs:string Required Specify the package we are running this job from.
operation xs:string Required Specify the operation within the package to run.
earliestStartTime xs:dateTime Optional The earliest date and time at which the job can be run. If not specified, the job will run as soon as possible, subject to any other constraints.
latestStartTime xs:dateTime Optional The latest date and time at which the job can be run. If specified, if the job cannot be run by this time, it is automatically failed. If not specified, the job will remain queued until it can be started successfully.
param sisJobInputParameterType Optional
Array (0/∞)		 The input parameters required by the package in order to run the job.
extraCredentials sisExtraCredentialType Optional
Array (0/∞)		 The extra credential required by job

Response Parameters

Name Type Attributes Description
job sisJobResultInfoType Required Information about the job.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document