Zdieľať cez

UiPath (Preview)

  • Reference

UiPath allows you to trigger jobs in UiPath Orchestrator. It provides the ability to initiate job runs and listen for job completion through trigger, ensuring seamless automation workflows and real-time monitoring.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Plugin Ecosystem Team
URL https://www.uipath.com/support
Email pludevsupport@uipath.com
Connector Metadata
Publisher UiPath Incorporated
Website https://www.uipath.com
Privacy policy https://www.uipath.com/legal/privacy-policy
Categories AI;Business Intelligence

Author:

UiPath UiPath Website

Contact:

UiPath Support Team UiPath Support Website

Version:

2.0

Description

UiPath allows you to trigger jobs in UiPath Orchestrator. It provides the ability to initiate job runs and listen for job completion through trigger, ensuring seamless automation workflows and real-time monitoring.

Supported Operations

The connector supports the following operations:

  • Run Job Run an instance of a UiPath process (job)
  • [Wait for job completion] Wait on the execution of the Power Automate flow until the UiPath job run is complete

Getting Help or Providing Feedback

If you have any issues, requests for functionality, or have general feedback, please pludevsupport@uipath.com.

Pre-requisites

Please make sure you have a UiPath Automation Cloud account. Within a specific tenant (or DefaultTenant), build a UiPath process using Studio Web or Studio Desktop, publish and deploy the process to an Orchestrator folder.

Using the Connector

  1. Select UiPath Connector as a step in your Power Automate Flow
  2. Enter your UiPath Cloud Organization Name and Tenant Name in the Parameter dialog box
  3. Sign into UiPath platform with your UiPath credentials
  4. Once successfully authenticated you can select folders, and processes in the action
  5. Begin using the connector in your environment to build apps and flows!

Creating a connection

The connector supports the following authentication types:
Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
Organization Name string Specify your organization name. True
Tenant Name string Specify your tenant name. True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Start Job

Creates a new job and sets it in Pending state for each robot based on the input parameters and notifies the respective robots about the pending job.

Start Job

Operation ID:
StartJobs

Creates a new job and sets it in Pending state for each robot based on the input parameters and notifies the respective robots about the pending job.

Parameters

Name Key Required Type Description
Process Input Schema
 dynamicListSchema dynamic

Get the schema of the selected process.
Folder
 X-UIPATH-OrganizationUnitId True integer

Folder/OrganizationUnit Id
Process Name
 processName True string

Select the process you want to run
RunAsMe
 runAsMe boolean

Execute the job under your own identity

Returns

Represents a scheduled or manual execution of a process on a robot.

Body
JobDto

Triggers

Wait for Job Completion

Wait for Job Completion

Wait for Job Completion

Operation ID:
GetJobUpdate

Wait for Job Completion

Parameters

Name Key Required Type Description
Folder
 X-UIPATH-OrganizationUnitId True integer

Folder/OrganizationUnit Id
Job Id
 jobKey string

Job Id
Process Name
 processName True string

Select the process name

Returns

The outputs of this operation are dynamic.

Definitions

ArgumentMetadata

Name Path Type Description
Input
 Input string
Output
 Output string

EntryPointDataVariationDto

Name Path Type Description
Content
 Content string
ContentType
 ContentType string
Id
 Id integer

EntryPointDto

Name Path Type Description
UniqueId
 UniqueId uuid
Path
 Path string
InputArguments
 InputArguments string
OutputArguments
 OutputArguments string
DataVariation
 DataVariation EntryPointDataVariationDto
Id
 Id integer

EnvironmentDto

A grouping of Robots.

Name Path Type Description
Name
 Name string

A custom name for the environment.
Description
 Description string

Used to add additional information about an environment in order to better identify it.
Robots
 Robots array of SimpleRobotDto

The collection of robots associated with the current environment.
Type
 Type string

DEPRECATED. The environment type specifies how it should be used. This property is deprecated and should no longer be used.
Id
 Id integer

JobDto

Represents a scheduled or manual execution of a process on a robot.

Name Path Type Description
Job Id
 Id integer

The Unique Job Id
Job Key
 Key string

The unique job identifier.
Start Time
 StartTime string

The date and time when the job execution started or null if the job hasn't started yet.
End Time
 EndTime string

The date and time when the job execution ended or null if the job hasn't ended yet.
Job State
 State string

The state in which the job is.
Job Priority
 JobPriority string

Execution priority.
Robot
 Robot SimpleRobotDto

Entity derived from RobotDto. Is shares all the properties of the base entity except the navigation properties.
Release
 Release SimpleReleaseDto

Entity derived from BaseReleaseDto. It shares all the properties of the base entity except the navigation properties.
Source
 Source string

The Source name of the job.
Source Type
 SourceType string

The Source type of the job.
Batch Execution Key
 BatchExecutionKey string

The unique identifier grouping multiple jobs. It is usually generated when the job is created by a schedule.
Info
 Info string

Additional information about the current job.
Creation Time
 CreationTime string

The date and time when the job was created.
Starting Schedule Id
 StartingScheduleId string

The Id of the schedule that started the job, or null if the job was started by the user.
Release Name
 ReleaseName string

The name of the release associated with the current name.
Type
 Type string

The type of the job, Attended if started via the robot, Unattended otherwise
Input Arguments
 InputArguments string

Input parameters in JSON format to be passed to job execution
Output Arguments
 OutputArguments string

Output parameters in JSON format resulted from job execution
Host Machine Name
 HostMachineName string

The name of the machine where the Robot run the job.
HasMediaRecorded
 HasMediaRecorded boolean

True if any execution media has been recorded for this job, false otherwise.
PersistenceId
 PersistenceId string

The persistence instance id for a suspended job
ResumeVersion
 ResumeVersion string

Distinguishes between multiple job suspend/resume cycles
StopStrategy
 StopStrategy string
RuntimeType
 RuntimeType string

The runtime type of the robot which can pick up the job
RequiresUserInteraction
 RequiresUserInteraction boolean
ReleaseVersionId
 ReleaseVersionId integer
EntryPointPath
 EntryPointPath string

Path to the entry point workflow (XAML) that will be executed by the robot
OrganizationUnitId
 OrganizationUnitId integer

Id of the folder this job is part of.
OrganizationUnitFullyQualifiedName
 OrganizationUnitFullyQualifiedName string

Fully qualified name of the folder this job is part of.
Reference
 Reference string

Reference identifier for the job
ProcessType
 ProcessType string
Machine
 Machine MachineDto

The Machine that hosts the Robot
ProfilingOptions
 ProfilingOptions string

Options to instruct the robot what profiling info to collect (code coverage, CPU / memory utilization, etc)

MachineDto

The Machine that hosts the Robot

Name Path Type Description
LicenseKey
 LicenseKey string

The key is automatically generated from the server for the Robot machine. For the robot to work, the same key must exist on both the robot and Orchestrator.
Name
 Name string

The name of the Machine a Robot is hosted on.
Description
 Description string
Type
 Type string

The type of the Machine (Standard / Template).
Scope
 Scope string

The scope of the Machine (Default / Shared / PW / Cloud).
NonProductionSlots
 NonProductionSlots integer

Number of NonProduction slots to be reserved at runtime
UnattendedSlots
 UnattendedSlots integer

Number of Unattended slots to be reserved at runtime
HeadlessSlots
 HeadlessSlots integer

Number of Headless slots to be reserved at runtime
TestAutomationSlots
 TestAutomationSlots integer

Number of TestAutomation slots to be reserved at runtime
Key
 Key uuid

An immutable unique identifier that is preserved during tenant migration
RobotVersions
 RobotVersions array of MachinesRobotVersionDto

The versions of the Robots hosted on the Machine.
RobotUsers
 RobotUsers array of RobotUserDto

Robots assigned to template machine.
AutoScalingProfile
 AutoScalingProfile string

The profile that drives auto scaling.
Id
 Id integer

MachinesRobotVersionDto

Name Path Type Description
Count
 Count integer

The number of Robots on the Machine with the specified version.
Version
 Version string

The Version of the Robot hosted on the Machine.
MachineId
 MachineId integer

The Id of the Machine.

ProcessSettingsDto

ReleaseVersionDto

Stores data about a version of the various versions of the process associated with a certain release. If a certain version is associated on and off with a release a new ReleaseVersion object is created for each association.

Name Path Type Description
ReleaseId
 ReleaseId integer

The Id of the parent release.
VersionNumber
 VersionNumber string

The version of process associated with the release.
CreationTime
 CreationTime date-time

The date and time when the version was associated with the release.
ReleaseName
 ReleaseName string

The name of the process associated with the release.
Id
 Id integer

RobotUserDto

Name Path Type Description
UserName
 UserName string

The name of the user.
RobotId
 RobotId integer

The Id of the Robot.
HasTriggers
 HasTriggers boolean

Whether the machine robot has triggers defined or not.

SimpleReleaseDto

Entity derived from BaseReleaseDto. It shares all the properties of the base entity except the navigation properties.

Name Path Type Description
Key
 Key string

A unique identifier associated to each release.
ProcessKey
 ProcessKey string

The unique identifier of the process associated with the release.
ProcessVersion
 ProcessVersion string

The version of the process associated with the release.
IsLatestVersion
 IsLatestVersion boolean

States whether the version of process associated with the release is latest or not.
IsProcessDeleted
 IsProcessDeleted boolean

States whether the process associated with the release is deleted or not.
Description
 Description string

Used to add additional information about a release in order to better identify it.
Name
 Name string

A custom name of the release. The default name format is ProcessName_EnvironmentName.
EnvironmentId
 EnvironmentId integer

The Id of the environment associated with the release.
EnvironmentName
 EnvironmentName string

The name of the environment associated with the release.
Environment
 Environment EnvironmentDto

A grouping of Robots.
EntryPointId
 EntryPointId integer
EntryPoint
 EntryPoint EntryPointDto
InputArguments
 InputArguments string

Input parameters in JSON format to be passed as default values to job execution.
ProcessType
 ProcessType string
SupportsMultipleEntryPoints
 SupportsMultipleEntryPoints boolean
RequiresUserInteraction
 RequiresUserInteraction boolean
CurrentVersion
 CurrentVersion ReleaseVersionDto

Stores data about a version of the various versions of the process associated with a certain release. If a certain version is associated on and off with a release a new ReleaseVersion object is created for each association.
ReleaseVersions
 ReleaseVersions array of ReleaseVersionDto

The collection of release versions that current release had over time.
Arguments
 Arguments ArgumentMetadata
ProcessSettings
 ProcessSettings ProcessSettingsDto
AutoUpdate
 AutoUpdate boolean
FeedId
 FeedId string
JobPriority
 JobPriority string

The execution priority. If null, it defaults to Normal.
CreationTime
 CreationTime date-time

Creation time of this release.
OrganizationUnitId
 OrganizationUnitId integer

Id of the folder this release is part of.
OrganizationUnitFullyQualifiedName
 OrganizationUnitFullyQualifiedName string

Fully qualified name of the folder this release is part of.
Id
 Id integer

SimpleRobotDto

Entity derived from RobotDto. Is shares all the properties of the base entity except the navigation properties.

Name Path Type Description
LicenseKey
 LicenseKey string

The key is automatically generated from the server for the Robot machine. For the robot to work, the same key must exist on both the robot and Orchestrator.
MachineName
 MachineName string

The name of the machine a Robot is hosted on.
MachineId
 MachineId integer

The Id of the machine a Robot is hosted on
Name
 Name string

A custom name for the robot.
Username
 Username string

The machine username. If the user is under a domain, you are required to also specify it in a DOMAIN\username format. Note: You must use short domain names, such as desktop\administrator and NOT desktop.local/administrator.
ExternalName
 ExternalName string

Contains the value of the key in the external store used to store the password.
Description
 Description string

Used to add additional information about a robot in order to better identify it.
Type
 Type string

The Robot type.
HostingType
 HostingType string

The Robot hosting type (Standard / Floating).
ProvisionType
 ProvisionType string

The Robot provision type.
Password
 Password string

The Windows password associated with the machine username.
CredentialStoreId
 CredentialStoreId integer

The Credential Store used to store the password.
UserId
 UserId integer

The associated user's Id.
Enabled
 Enabled boolean

Specificies the state of the Robot (enabled/disabled) - a disabled robot cannot connect to Orchestrator
CredentialType
 CredentialType string

The robot credentials type (Default/ SmartCard)
Environments
 Environments array of EnvironmentDto

The collection of environments the robot is part of.
RobotEnvironments
 RobotEnvironments string

The comma separated textual representation of environment names the robot is part of.
ExecutionSettings
 ExecutionSettings object

A collection of key value pairs containing execution settings for this robot.
IsExternalLicensed
 IsExternalLicensed boolean

Flag to indicate if the robot uses an external license
LimitConcurrentExecution
 LimitConcurrentExecution boolean

Specifies if the robot can be used concurrently on multiple machines
Id
 Id integer