UiPath OrchestratorInstall

Summary

Starts one or more UiPath Orchestrator jobs for a specified process release.

Inputs

• Release Key (required) — The unique identifier (key/GUID) of the process release to start.
• Strategy — How to allocate jobs to robots: All Robots, Specific, or Job Count.
• Jobs Count — Number of jobs to start. Only used when Strategy is Job Count.
• Robot IDs — Comma-separated list of robot IDs to run the jobs. Only used when Strategy is Specific.
• Input Arguments — Input arguments as a JSON object string, e.g. {"arg1":"value1","arg2":123}.
• No Of Robots — Number of robots to use. 0 means use all available robots.

Output shape

Typically an array/object containing the started job details.

The created job records returned by the UiPath Orchestrator API.

Examples

Example 1: Trigger a single unattended robot job on a schedule or after an event.

Start 1 job for a release using the Job Count strategy with no input arguments.

Example 2: Run a process only on particular robot machines.

Start jobs on specific robots using the Specific strategy and Robot IDs.

Example 3: Scale out the same process to all enabled robots at once.

Start multiple jobs across all available robots using the All Robots strategy.