UiPath Orchestrator
Subscribe
Product Lifecycle
Submit Product Feedback
{{user.name}}
Log In
The UiPath Orchestrator Guide
UiPath Orchestrator
UiPath Activities
UiPath Studio
UiPath Robot
UiPath Orchestrator
UiPath Automation Cloud
UiPath Release Notes
UiPath Marketplace
UiPath StudioX
UiPath Task Capture
UiPath Automation Hub
UiPath Task Mining - Preview
UiPath Installation and Upgrade
UiPath AI Fabric
UiPath Test Suite
UiPath Insights
UiPath Chatbots - Preview
UiPath Process Mining
UiPath Developer
v2020.4
v0
beta
(Automation Cloud Orchestrator)
v2016.2
deprecated
v2017.1
deprecated
v2018.1
deprecated
v2018.2
deprecated
v2018.3
deprecated
v2018.4
v2019-fastTrack
deprecated
v2019
v2020.4
stable
Home
UiPath Orchestrator Guide
UiPath Orchestrator API Guide
Reference
Changelog
Discussions
Page Not Found
Search
{{ state.current().meta.title }}
API Logs
Tutorials
Home
UiPath Orchestrator Guide
UiPath Orchestrator API Guide
discard
Save Edits
Submit
Suggested Edits
Getting Started
Introduction
User Interface
Dashboard
Activities Feeds
About Installation
Backward and Forward Compatibility
Best Practices
Automation Best Practices
Managing Large Deployments
Attended vs. Unattended Automation
Organization Modeling in Orchestrator
Administration of Modern Folders
Security Best Practices
Deployment and Configuration Considerations
Maintenance Considerations
Encrypting Web.Config Sections
Encrypting the SQL Server
Disabling HTTP Method Override Requests
Identity Server
About Identity Server
Identity Management Portal
External Identity Providers
Field Descriptions for External Providers Page
Installation Access Token
Authentication
About Authentication
Enabling Windows Authentication
Setting Up Auto Login for Users Under an Active Directory Group
Resetting Your Password Through Your Email
Configuring the SMTP server
Changing the Windows Authentication Protocol
SmartCard Authentication
Single Sign-On Authentication Using SAML 2.0
ADFS Authentication
Google Authentication
OKTA Authentication
Custom Mapping
Self-Signed Certificates
Setting Orchestrator to Use a Private Key Certificate
Google Authentication Using OpenID Connect
Azure AD Authentication
Licensing
About Licensing
Activating Your License
Managing Your Licenses
Field Descriptions for the License Page
Field Descriptions for the Attended Licenses Pages
Field Descriptions for the Unattended Licenses Pages
Other Configurations
Increasing the Size Limit of Package Files
Opting Out of Telemetry
Setting up Encryption Key per Tenant
GZIP Compression
System Administrator
About System Administrators
Managing Tenants
Field Descriptions for the Tenants Page
Field Descriptions for the Host Audit Page
Field Descriptions for the Host Settings Page
Field Descriptions for the Admin Profile Page
Maintenance Mode
Tenants
About Tenants
Configuring Tenant Settings
Field Descriptions for the Tenant Settings Page
Monitoring Menu
About Monitoring
Robots
Fields Descriptions for the Robots Page
Folder Overview
Jobs
Job States
Managing Jobs
Field Descriptions for the Jobs Page
Jobs Overview
Queues
SLA
Logs
Managing Logs in Orchestrator
Field Descriptions
Logging Levels
Orchestrator Logs
Protecting Sensitive Information in Studio
Processes
About Processes
About Recording
Managing Processes
Field Descriptions
Triggers
About Triggers
Managing Triggers
Field Descriptions
Using Cron Expressions
Queues and Transactions
About Queues and Transactions
Queue Item Statuses
Business Exception vs Application Exception
Studio Activities Used with Queues
Managing Queues in Orchestrator
Managing Queues in Studio
Managing Transactions
Editing Transactions
Managing Review Requests
Field Descriptions for Queues
Field Descriptions for Transactions
Field Descriptions for the Transactions .csv File
Field Descriptions for Review Requests
Assets
About Assets
Managing Assets in Orchestrator
Managing Assets in Studio
Field Descriptions
Action Center
About Actions
Managing Actions
Field Descriptions for the Actions Page
About Action Catalogs
Managing Action Catalogs
Field Descriptions for the Action Catalogs Page
Storage Buckets
About Storage Buckets
CORS/CSP Configuration
Managing Storage Buckets
Field Descriptions
Folders
About Folders
Managing Folders
Field Descriptions
Key Features and Behavior
Using Modern Folders
Users
About Users
User Types
Managing Users
Field Descriptions
FAQ
Roles
About Roles
Default Roles
Managing Roles
Field Descriptions
Robots
About Robots
Robot Statuses
Robot Settings
Robots in Classic Folders
Managing Robots
Field Descriptions
Setup Samples
Robots in Modern Folders
Managing Robots
Setup Samples
Connecting Robots to Orchestrator
How the Connection Between the Robot and Orchestrator Works
Storing Robot Credentials in CyberArk
Environments
About Environments
Managing Environments
Field Descriptions
Machines
About Machines
Managing Machines
Field Descriptions
Packages
About Packages
Publishing a Project from Studio to Orchestrator
Managing Packages
Field Descriptions
Libraries
About Libraries
Managing Libraries
Field Descriptions
Profile
About the Profile Page
Managing Profile Settings
Field Descriptions for the Profile Page
Credential Stores
About Credential Stores
CyberArk® Integration
Azure Key Vault Integration
Managing Credential Stores
Credential Store Plugins
Field Descriptions
Audit
About Audit
Field Descriptions
Alerts
About Alerts
About Email Alerts
Setting Up Email Alerts
Email Alerts Dashboard Description
Alert Severity Levels
Field Descriptions
Integrations
About Input and Output Parameters
Example of Using Input and Output Parameters
About Webhooks
Types of Events
Managing Webhooks
Field Descriptions
The Testing Menu
Test Cases
Field Descriptions for the Test Cases Page
Test Sets
Managing Test Sets
Field Descriptions for the Test Sets Page
Test Executions
Field Descriptions for the Test Executions Page
Test Schedules
Managing Test Schedules
Field Descriptions for the Test Schedules Page
Troubleshooting
IE 11.0.9600.17031 Issues
Frequently Encountered Orchestrator Errors
Cron Expressions
Identity Server Troubleshooting
Insights Troubleshooting
Orchestrator Mobile App
About Push Notifications
About Favorite Processes
About Favorite Jobs
Getting Started
Introduction
User Interface
Dashboard
Activities Feeds
About Installation
Backward and Forward Compatibility
Best Practices
Automation Best Practices
Managing Large Deployments
Attended vs. Unattended Automation
Organization Modeling in Orchestrator
Administration of Modern Folders
Security Best Practices
Deployment and Configuration Considerations
Maintenance Considerations
Encrypting Web.Config Sections
Encrypting the SQL Server
Disabling HTTP Method Override Requests
Identity Server
About Identity Server
Identity Management Portal
External Identity Providers
Field Descriptions for External Providers Page
Installation Access Token
Authentication
About Authentication
Enabling Windows Authentication
Setting Up Auto Login for Users Under an Active Directory Group
Resetting Your Password Through Your Email
Configuring the SMTP server
Changing the Windows Authentication Protocol
SmartCard Authentication
Single Sign-On Authentication Using SAML 2.0
ADFS Authentication
Google Authentication
OKTA Authentication
Custom Mapping
Self-Signed Certificates
Setting Orchestrator to Use a Private Key Certificate
Google Authentication Using OpenID Connect
Azure AD Authentication
Licensing
About Licensing
Activating Your License
Managing Your Licenses
Field Descriptions for the License Page
Field Descriptions for the Attended Licenses Pages
Field Descriptions for the Unattended Licenses Pages
Other Configurations
Increasing the Size Limit of Package Files
Opting Out of Telemetry
Setting up Encryption Key per Tenant
GZIP Compression
System Administrator
About System Administrators
Managing Tenants
Field Descriptions for the Tenants Page
Field Descriptions for the Host Audit Page
Field Descriptions for the Host Settings Page
Field Descriptions for the Admin Profile Page
Maintenance Mode
Tenants
About Tenants
Configuring Tenant Settings
Field Descriptions for the Tenant Settings Page
Monitoring Menu
About Monitoring
Robots
Fields Descriptions for the Robots Page
Folder Overview
Jobs
Job States
Managing Jobs
Field Descriptions for the Jobs Page
Jobs Overview
Queues
SLA
Logs
Managing Logs in Orchestrator
Field Descriptions
Logging Levels
Orchestrator Logs
Protecting Sensitive Information in Studio
Processes
About Processes
About Recording
Managing Processes
Field Descriptions
Triggers
About Triggers
Managing Triggers
Field Descriptions
Using Cron Expressions
Queues and Transactions
About Queues and Transactions
Queue Item Statuses
Business Exception vs Application Exception
Studio Activities Used with Queues
Managing Queues in Orchestrator
Managing Queues in Studio
Managing Transactions
Editing Transactions
Managing Review Requests
Field Descriptions for Queues
Field Descriptions for Transactions
Field Descriptions for the Transactions .csv File
Field Descriptions for Review Requests
Assets
About Assets
Managing Assets in Orchestrator
Managing Assets in Studio
Field Descriptions
Action Center
About Actions
Managing Actions
Field Descriptions for the Actions Page
About Action Catalogs
Managing Action Catalogs
Field Descriptions for the Action Catalogs Page
Storage Buckets
About Storage Buckets
CORS/CSP Configuration
Managing Storage Buckets
Field Descriptions
Folders
About Folders
Managing Folders
Field Descriptions
Key Features and Behavior
Using Modern Folders
Users
About Users
User Types
Managing Users
Field Descriptions
FAQ
Roles
About Roles
Default Roles
Managing Roles
Field Descriptions
Robots
About Robots
Robot Statuses
Robot Settings
Robots in Classic Folders
Managing Robots
Field Descriptions
Setup Samples
Robots in Modern Folders
Managing Robots
Setup Samples
Connecting Robots to Orchestrator
How the Connection Between the Robot and Orchestrator Works
Storing Robot Credentials in CyberArk
Environments
About Environments
Managing Environments
Field Descriptions
Machines
About Machines
Managing Machines
Field Descriptions
Packages
About Packages
Publishing a Project from Studio to Orchestrator
Managing Packages
Field Descriptions
Libraries
About Libraries
Managing Libraries
Field Descriptions
Profile
About the Profile Page
Managing Profile Settings
Field Descriptions for the Profile Page
Credential Stores
About Credential Stores
CyberArk® Integration
Azure Key Vault Integration
Managing Credential Stores
Credential Store Plugins
Field Descriptions
Audit
About Audit
Field Descriptions
Alerts
About Alerts
About Email Alerts
Setting Up Email Alerts
Email Alerts Dashboard Description
Alert Severity Levels
Field Descriptions
Integrations
About Input and Output Parameters
Example of Using Input and Output Parameters
About Webhooks
Types of Events
Managing Webhooks
Field Descriptions
The Testing Menu
Test Cases
Field Descriptions for the Test Cases Page
Test Sets
Managing Test Sets
Field Descriptions for the Test Sets Page
Test Executions
Field Descriptions for the Test Executions Page
Test Schedules
Managing Test Schedules
Field Descriptions for the Test Schedules Page
Troubleshooting
IE 11.0.9600.17031 Issues
Frequently Encountered Orchestrator Errors
Cron Expressions
Identity Server Troubleshooting
Insights Troubleshooting
Orchestrator Mobile App
About Push Notifications
About Favorite Processes
About Favorite Jobs
Introduction to the Orchestrator API
About OData and References
API References
Logical Resources and Metadata
Available Operations
The Swagger Definition
Managing Logical Resources
Building API Requests
Basics
Permissions Per Endpoint
Examples Using the Orchestrator API
Authenticating
Environments Requests
Robots Requests
Retrieving License Information
Packages Requests
Processes Requests
Libraries Requests
Jobs Requests
Schedules Requests
Transaction Requests
Assets Requests
Settings Requests
Users Requests
Roles Requests
Permissions Requests
License Requests
Tenants Requests
Webhooks Requests
Folders Requests
Calendars Requests
Actions Requests
Action Catalogs Requests
Generic Actions Requests
Form Actions Requests
Cloud
Consuming Cloud API
Getting Started
Introduction
Activities Feeds
About Installation
View All 4
Best Practices
Automation Best Practices
Security Best Practices
Identity Server
About Identity Server
Identity Management Portal
External Identity Providers
View All 4
Authentication
About Authentication
Enabling Windows Authentication
Setting Up Auto Login for Users Under an Active Directory Group
View All 9
Licensing
About Licensing
Activating Your License
Managing Your Licenses
View All 6
Other Configurations
Increasing the Size Limit of Package Files
Opting Out of Telemetry
Setting up Encryption Key per Tenant
View All 4
System Administrator
About System Administrators
Managing Tenants
Field Descriptions for the Tenants Page
View All 7
Tenants
About Tenants
Configuring Tenant Settings
Field Descriptions for the Tenant Settings Page
Monitoring Menu
About Monitoring
Robots
Jobs
View All 5
Processes
About Processes
Managing Processes
Field Descriptions
Triggers
About Triggers
Managing Triggers
Field Descriptions
View All 4
Queues and Transactions
About Queues and Transactions
Managing Queues in Orchestrator
Managing Queues in Studio
View All 8
Assets
About Assets
Managing Assets in Orchestrator
Managing Assets in Studio
View All 4
Action Center
About Actions
Managing Actions
Field Descriptions for the Actions Page
View All 6
Storage Buckets
About Storage Buckets
Managing Storage Buckets
Field Descriptions
Folders
About Folders
Managing Folders
Field Descriptions
View All 5
Users
About Users
User Types
Managing Users
View All 5
Roles
About Roles
Default Roles
Managing Roles
View All 4
Robots
About Robots
Robots in Classic Folders
Robots in Modern Folders
View All 5
Environments
About Environments
Managing Environments
Field Descriptions
Machines
About Machines
Managing Machines
Field Descriptions
Packages
About Packages
Managing Packages
Field Descriptions
Libraries
About Libraries
Managing Libraries
Field Descriptions
Profile
About the Profile Page
Managing Profile Settings
Field Descriptions for the Profile Page
Credential Stores
About Credential Stores
Managing Credential Stores
Credential Store Plugins
View All 4
Audit
About Audit
Field Descriptions
Alerts
About Alerts
About Email Alerts
Alert Severity Levels
View All 4
Integrations
About Input and Output Parameters
About Webhooks
Managing Webhooks
View All 4
The Testing Menu
Test Cases
Test Sets
Test Executions
View All 4
Troubleshooting
IE 11.0.9600.17031 Issues
Frequently Encountered Orchestrator Errors
Cron Expressions
View All 5
Orchestrator Mobile App
About Push Notifications
About Favorite Processes
About Favorite Jobs
Introduction to the Orchestrator API
About OData and References
API References
Logical Resources and Metadata
View All 4
The Swagger Definition
Managing Logical Resources
Building API Requests
Basics
Permissions Per Endpoint
Examples Using the Orchestrator API
Authenticating
Environments Requests
Robots Requests
View All 24
Cloud
Consuming Cloud API