Operation: automation::sisRunJob


General Description

Used to run a job

Operation Notes

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

Request Message

Input Parameters

The sisRunJob 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
name xs:string required once
description xs:string optional
target xs:anyURI required once 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 once Specify the package we are running this job from.
operation xs:string required once 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
minOccurs=0
maxOccurs=unbounded
The input parameters required by the package in order to run the job.
extraCredentials sisExtraCredentialType optional
minOccurs=0
maxOccurs=unbounded
The extra credential required by job

Input Data


Response Message

Output Parameters

Name Type Attributes Description
job sisJobResultInfoType required once Information about the job.

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 , .)