StopJob

Enables you to stop or kill a job on Orchestrator. Note that in order to execute this method in Studio, the Robot has to be connected to Orchestrator and the Robot role needs to also have the Create and Edit rights on jobs, as well as View permissions on processes and environments. The method runs under the Robot it executes it.

Definition

Namespace: UiPath.Activities.System.API

Assembly: UiPath.System.Activities.Api (in UiPath.System.Activities.Api.dll)

Overloads

StopJob(OrchestratorJob, StopStrategy)	Stops a job in Orchestrator based on a certain strategy: Kill or Stop.
StopJob(OrchestratorJob, StopStrategy, String)	Stops a job in Orchestrator, from a specified folder path, based on a certain strategy: Kill or Stop.
StopJob(OrchestratorJob, StopStrategy, String, Int32)	Stops a job in Orchestrator, from a specified folder path, based on a certain strategy: Kill or Stop.

StopJob(OrchestratorJob, StopStrategy)

Stops a job in Orchestrator based on a certain strategy: Kill or Stop.

void StopJob(
	OrchestratorJob job,
	StopStrategy strategy
)

job OrchestratorJob

Specify the job to be stopped or killed.

strategy StopStrategy

Select how to stop the job:

• Stop - Stop the job in a safe manner.
• Kill - Forcefully stop the job, regardless of where the execution is.

StopJob(OrchestratorJob, StopStrategy, String)

Stops a job in Orchestrator, from a specified folder path, based on a certain strategy: Kill or Stop.

void StopJob(
	OrchestratorJob job,
	StopStrategy strategy,
	string folderPath
)

job OrchestratorJob

Specify the job to be stopped or killed.

strategy StopStrategy

Select how to stop the job:

• Stop - Stop the job in a safe manner.
• Kill - Forcefully stop the job, regardless of where the execution is.

folderPath String

The path of the folder where the specified job is located, if different from the folder where the process is running. This field only supports string values, with / as the separator to indicate subfolders. For example "Finance/Accounts Payable".

StopJob(OrchestratorJob, StopStrategy, String, Int32)

Stops a job in Orchestrator, from a specified folder path, based on a certain strategy: Kill or Stop.

void StopJob(
	OrchestratorJob job,
	StopStrategy strategy,
	string folderPath,
	int timeoutMS
)

job OrchestratorJob

Specify the job to be stopped or killed.

strategy StopStrategy

Select how to stop the job:

• Stop - Stop the job in a safe manner.
• Kill - Forcefully stop the job, regardless of where the execution is.

folderPath String

The path of the folder where the specified job is located, if different from the folder where the process is running. This field only supports string values, with / as the separator to indicate subfolders. For example "Finance/Accounts Payable".

timeoutMS Int32

Specifies the amount of time (in milliseconds) to wait for the activity to run before an error is thrown. The default value is 30000 milliseconds (30 seconds).