Delen via


UiPath Orchestrator

Run automations in UiPath Cloud Orchestrator.

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 Integrations Team
URL https://www.uipath.com/support
Email integrations-apps@uipath.com
Connector Metadata
Publisher UiPath
Website https://www.uipath.com
Privacy policy https://www.uipath.com/legal/privacy-policy
Categories AI;Business Intelligence

The Power Automate Connector for UiPath Cloud Orchestrator allows you to leverage UiPaths Robotic Process Automation capabilities in Power Automate. It allows seamless automated flows between UiPath and Power Automate.

Prerequisites

To use this connector, you need a UiPath Automation Cloud account. If you are not already a UiPath customer, you can sign up for a trial.

Make sure you have Automations deployed or Queues set up for your tenant.

How to get credentials

If you do not have a username and password for UiPath Automation Cloud, create your own trial account or reach out to your UiPath platform admin.

Using the connector

To use the connector, follow the steps below:

  1. Select UiPath Connector as a step in your Power Automate Flow.
  2. Enter your UiPath Cloud Organization ID and Tenant ID in the text fields.
  3. Sign in to the UiPath platform with your credentials.
  4. Once successfully authenticated, you can select folders, processes, and queues in the form.
  5. You can now begin to use the connector in your environment to build apps and flows.

Limitations

As of now, we support Automation Cloud Orchestrators only.

Orchestrator Classic folders are not supported. Make sure to use only modern folders.

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

Adds Queue Item

Add a new queue item for processing.

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.

Adds Queue Item

Add a new queue item for processing.

Parameters

Name Key Required Type Description
Name
Name string

Required. The name of the queue into which the item will be added.

Priority
Priority string

Sets the processing importance for a given item.

Specific Content
SpecificContent object

A collection of key value pairs. Example: "Name":"John", "Status": true

Defer Date
DeferDate date-time

The earliest date and time at which the item is available for processing. If empty the item can be processed as soon as possible.

Due Date
DueDate date-time

The latest date and time at which the item should be processed. If empty the item can be processed at any given time.

Risk SLA Date
RiskSlaDate date-time

The RiskSla date at time which is considered as risk zone for the item to be processed.

Reference
Reference string

An optional, user-specified value for queue item identification.

Progress
Progress string

String field which is used to keep track of the business flow progress.

Folder
X-UIPATH-OrganizationUnitId True integer

Folder/OrganizationUnit Id

Returns

Defines a piece of data that can be processed by a robot and the information associated with its processing status. Queue items are grouped in queues.

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.

Parameters

Name Key Required Type Description
Process Name
ReleaseKey True string

Required. Select process you want to run.

JobsCount
JobsCount True integer

Required. Number of pending jobs to be created in the environment, for the current process. This number must be greater than 0 only if the start strategy is JobsCount.

Source
Source string

The Source of the job starting the current process.

JobPriority
JobPriority string

Execution priority. If null, defaults to the JobPriority of its release.

RuntimeType
RuntimeType string
InputArguments
InputArguments string

Input parameters in JSON format to be passed to job execution.

Reference
Reference string

Optional user-specified reference for jobs

Folder
X-UIPATH-OrganizationUnitId True integer

Folder/OrganizationUnit Id

Returns

Definitions

ArgumentMetadata

Name Path Type Description
Input
Input string
Output
Output string

AttendedRobotDto

Name Path Type Description
UserName
UserName string

The username used to authenticate on the Host Machine.

ExecutionSettings
ExecutionSettings object

An object containing execution settings for the Robot.

RobotId
RobotId integer

The actual Id of the provisioned Robot.

RobotType
RobotType string

The actual Type of the provisioned Robot.

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
Key
Key uuid

The unique job identifier.

StartTime
StartTime date-time

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

EndTime
EndTime date-time

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

State
State string

The state in which the job is.

JobPriority
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.

SourceType
SourceType string

The Source type of the job.

BatchExecutionKey
BatchExecutionKey uuid

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.

CreationTime
CreationTime date-time

The date and time when the job was created.

StartingScheduleId
StartingScheduleId integer

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

ReleaseName
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

InputArguments
InputArguments string

Input parameters in JSON format to be passed to job execution

OutputArguments
OutputArguments string

Output parameters in JSON format resulted from job execution

HostMachineName
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 uuid

The persistence instance id for a suspended job

ResumeVersion
ResumeVersion integer

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)

Id
Id integer

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.

ODataValueOfIEnumerableOfJobDto

Name Path Type Description
value
value array of JobDto

OrganizationUnitDto

Stores information about an organization unit in Orchestrator. An orchestrator unit can be understood as a company department and it is used to group different entities.

Name Path Type Description
DisplayName
DisplayName string

The name of the organization unit.

Id
Id integer

ProcessingExceptionDto

Stores information about exceptions thrown while processing failed queue items.

Name Path Type Description
Reason
Reason string

The reason the processing failed.

Details
Details string

Stores additional details about the exception.

Type
Type string

The processing exception type, if any.

AssociatedImageFilePath
AssociatedImageFilePath string

A path on the robot running computer to an image file that stores relevant information about the exception - e.g. a system print screen.

CreationTime
CreationTime date-time

Time when the exception occurred

ProcessSettingsDto

Name Path Type Description
ErrorRecordingEnabled
ErrorRecordingEnabled boolean
Duration
Duration integer
Frequency
Frequency integer
Quality
Quality integer
AutoStartProcess
AutoStartProcess boolean
AlwaysRunning
AlwaysRunning boolean

QueueDefinitionDto

The definition of a work queue. A work queue contains work items that are processed by robots.

Name Path Type Description
Name
Name string

A custom name for the queue.

Description
Description string

Used to add additional information about a queue in order to better identify it.

MaxNumberOfRetries
MaxNumberOfRetries integer

An integer value representing the number of times an item of this queue can be retried if its processing fails with application exception and auto retry is on.

AcceptAutomaticallyRetry
AcceptAutomaticallyRetry boolean

States whether a robot should retry to process an item if, after processing, it failed with application exception.

EnforceUniqueReference
EnforceUniqueReference boolean

States whether Item Reference field should be unique per Queue. Deleted and retried items are not checked against this rule.

SpecificDataJsonSchema
SpecificDataJsonSchema string

JSON schema enforced onto the specific data field.

OutputDataJsonSchema
OutputDataJsonSchema string

JSON schema enforced onto the output data field.

AnalyticsDataJsonSchema
AnalyticsDataJsonSchema string

JSON schema enforced onto the analytics data field.

CreationTime
CreationTime date-time

The date and time when the queue was created.

ProcessScheduleId
ProcessScheduleId integer

The Id of the process schedule associated with the queue.

SlaInMinutes
SlaInMinutes integer

Queue item processing SLA on the QueueDefinition level.

RiskSlaInMinutes
RiskSlaInMinutes integer

Queue Item processing Risk SLA on the QueueDefinition level.

ReleaseId
ReleaseId integer

The ProcessId Queue is associated with.

IsProcessInCurrentFolder
IsProcessInCurrentFolder boolean

Flag to determine if the release is in the current folder

FoldersCount
FoldersCount integer

Number of folders where the queue is shared.

OrganizationUnitId
OrganizationUnitId integer

DEPRECATED.

OrganizationUnitFullyQualifiedName
OrganizationUnitFullyQualifiedName string

DEPRECATED.

Id
Id integer

QueueItemDto

Defines a piece of data that can be processed by a robot and the information associated with its processing status. Queue items are grouped in queues.

Name Path Type Description
QueueDefinitionId
QueueDefinitionId integer

The Id of the parent queue.

QueueDefinition
QueueDefinition QueueDefinitionDto

The definition of a work queue. A work queue contains work items that are processed by robots.

ProcessingException
ProcessingException ProcessingExceptionDto

Stores information about exceptions thrown while processing failed queue items.

SpecificContent
SpecificContent object

A collection of key value pairs containing custom data configured in the Add Queue Item activity, in UiPath Studio.

Output
Output object

A collection of key value pairs containing custom data resulted after successful processing.

OutputData
OutputData string

A JSON representation of the output data generated by the item's processing.

Analytics
Analytics object

A collection of key value pairs containing custom data for further analytics processing.

AnalyticsData
AnalyticsData string

A JSON representation of the analytics data generated by the item's processing.

Status
Status string

The processing state of the item.

ReviewStatus
ReviewStatus string

The review state of the item - applicable only for failed items.

ReviewerUserId
ReviewerUserId integer

The UserId of the Reviewer, if any.

ReviewerUser
ReviewerUser SimpleUserDto

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

Key
Key uuid

The unique identifier of a queue item.

Reference
Reference string

An optional, user-specified value for queue item identification.

ProcessingExceptionType
ProcessingExceptionType string

The processing exception. If the item has not been processed or has been processed successfully it will be null.

DueDate
DueDate date-time

The latest date and time at which the item should be processed. If empty the item can be processed at any given time.

RiskSlaDate
RiskSlaDate date-time

The RiskSla date at time which is considered as risk zone for the item to be processed.

Priority
Priority string

Sets the processing importance for a given item.

Robot
Robot SimpleRobotDto

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

DeferDate
DeferDate date-time

The earliest date and time at which the item is available for processing. If empty the item can be processed as soon as possible.

StartProcessing
StartProcessing date-time

The date and time at which the item processing started. This is null if the item was not processed.

EndProcessing
EndProcessing date-time

The date and time at which the item processing ended. This is null if the item was not processed.

SecondsInPreviousAttempts
SecondsInPreviousAttempts integer

The number of seconds that the last failed processing lasted.

AncestorId
AncestorId integer

The Id of an ancestor item connected to the current item.

RetryNumber
RetryNumber integer

The number of times this work item has been processed. This can be higher than 0 only if MaxRetried number is set and the item processing failed at least once with ApplicationException.

SpecificData
SpecificData string

A JSON representation of the specific content.

CreationTime
CreationTime date-time

The date and time when the item was created.

Progress
Progress string

String field which is used to keep track of the business flow progress.

RowVersion
RowVersion byte

Identifier used for optimistic concurrency, so Orchestrator can figure whether data is out of date or not.

OrganizationUnitId
OrganizationUnitId integer

DEPRECATED.

OrganizationUnitFullyQualifiedName
OrganizationUnitFullyQualifiedName string

DEPRECATED.

Id
Id integer

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 uuid
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

SimpleUserDto

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

Name Path Type Description
Name
Name string

The name of the person for which the user is created.

Surname
Surname string

The surname of the person for which the user is created.

UserName
UserName string

The name used to login to Orchestrator.

Domain
Domain string

The domain from which the user is imported

DirectoryIdentifier
DirectoryIdentifier string

The directory identifier from which the user is imported

FullName
FullName string

The full name of the person constructed with the format Name Surname.

EmailAddress
EmailAddress email

The e-mail address associated with the user.

IsEmailConfirmed
IsEmailConfirmed boolean

States if the email address is valid or not.

LastLoginTime
LastLoginTime date-time

The date and time when the user last logged in, or null if the user never logged in.

IsActive
IsActive boolean

States if the user is active or not. An inactive user cannot login to Orchestrator.

CreationTime
CreationTime date-time

The date and time when the user was created.

AuthenticationSource
AuthenticationSource string

The source which authenticated this user.

Password
Password string

The password used during application login.

IsExternalLicensed
IsExternalLicensed boolean
UserRoles
UserRoles array of UserRoleDto

The collection of roles associated with the user.

RolesList
RolesList array of string

The collection of role names associated with the user.

LoginProviders
LoginProviders array of string

The collection of entities that can authenticate the user.

OrganizationUnits
OrganizationUnits array of OrganizationUnitDto

The collection of organization units associated with the user.

TenantId
TenantId integer

The id of the tenant owning the user.

TenancyName
TenancyName string

The name of the tenant owning the user.

TenantDisplayName
TenantDisplayName string

The display name of the tenant owning the user.

TenantKey
TenantKey string

The key of the tenant owning the user.

Type
Type string

The user type.

ProvisionType
ProvisionType string

The user type.

LicenseType
LicenseType string

The user's license type.

RobotProvision
RobotProvision AttendedRobotDto
UnattendedRobot
UnattendedRobot UnattendedRobotDto
NotificationSubscription
NotificationSubscription UserNotificationSubscription
Key
Key uuid

Unique key for a user

MayHaveUserSession
MayHaveUserSession boolean

Specifies whether this user is allowed to have a User session (default: true)

MayHaveRobotSession
MayHaveRobotSession boolean

Specifies whether this user is allowed to have an Attended Robot attached (default: true)

MayHaveUnattendedSession
MayHaveUnattendedSession boolean

Specifies whether this user is allowed to have an Unattended Robot attached (default: false)

BypassBasicAuthRestriction
BypassBasicAuthRestriction boolean

Specifies whether this user bypasses the "Auth.RestrictBasicAuthentication" application setting (default: false)

MayHavePersonalWorkspace
MayHavePersonalWorkspace boolean

Specifies whether this user is allowed to have a Personal Workspace

Id
Id integer

UnattendedRobotDto

Name Path Type Description
UserName
UserName string

The username used to authenticate on the Host Machine.

Password
Password string

The password used to authenticate on the Host Machine.

CredentialStoreId
CredentialStoreId integer

The credential store used to store the password.

CredentialType
CredentialType string

The robot credentials type (Default/ SmartCard)

CredentialExternalName
CredentialExternalName string

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

ExecutionSettings
ExecutionSettings object

An object containing execution settings for the Robot.

LimitConcurrentExecution
LimitConcurrentExecution boolean

Specifies if the robot can be used concurrently on multiple machines

RobotId
RobotId integer

The actual Id of the provisioned Robot.

MachineMappingsCount
MachineMappingsCount integer

Number of assigned machine mappings.

UserNotificationSubscription

Name Path Type Description
Queues
Queues boolean
Robots
Robots boolean
Jobs
Jobs boolean
Schedules
Schedules boolean
Tasks
Tasks boolean
QueueItems
QueueItems boolean
Insights
Insights boolean
CloudRobots
CloudRobots boolean

UserRoleDto

Stores information about the association between a user and a role.

Name Path Type Description
UserId
UserId integer

The Id of the associated user.

RoleId
RoleId integer

The Id of the associated role.

UserName
UserName string

The name of the associated user

RoleName
RoleName string

The name of the associated role

RoleType
RoleType string
Id
Id integer