Subscribe
UiPath Orchestrator
Product Lifecycle
Submit Product Feedback
{{user.name}}
Log In
The UiPath Orchestrator Guide
UiPath Orchestrator
UiPath Action Center
UiPath Activities
UiPath AI Center
UiPath Apps
UiPath Automation Cloud
UiPath Automation Hub
UiPath Automation Ops
UiPath Chatbot Connector - Preview
UiPath Connectors
UiPath Data Service
UiPath Developer
UiPath Document Understanding
UiPath Insights
UiPath Installation and Upgrade
UiPath Marketplace
UiPath Orchestrator
UiPath Process Mining
UiPath Release Notes
UiPath Robot
UiPath Studio
UiPath StudioX
UiPath Task Capture
UiPath Task Mining
UiPath Test Suite
v2021.4
v0
(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
deprecated
v2020.10
v2021.4
stable
Home
UiPath Orchestrator Guide
Recipes
UiPath Orchestrator API Guide
Reference
Changelog
Discussions
Page Not Found
Search
{{ state.current().meta.title }}
API Logs
Home
UiPath Orchestrator Guide
UiPath Orchestrator API Guide
{{search.symbol}}K
discard
Save Edits
Submit
Suggested Edits
Getting Started
Introduction
Activities Feeds
Robots
Robot Statuses
Robot Settings
Backward and Forward Compatibility
Orchestrator Installation
Release Notes
2021.4.1
Best Practices
Automation Best Practices
Managing Large Deployments
Attended vs. Unattended Automation
Organization Modeling in Orchestrator
Administration of Modern Folders
Security Best Practices
Performance Best Practices
🌐 Tenant Context
About the Tenant Context
About Tenants
Robots
Managing Robots
Connecting Robots to Orchestrator
Setup Samples
Storing Robot Credentials in CyberArk
Folders
Managing Folders
Folders Administration
Personal Workspaces
Managing Personal Workspaces
Key Features and Behavior
Using Modern Folders
Users
User Types
Managing Users
FAQ
Roles
Default Roles
Managing Roles
Machines
Managing Machines
Packages
Managing Packages
About Libraries
Managing Libraries
Audit
Credential Stores
Managing Credential Stores
CyberArk® Integration
CyberArk® CCP Integration
Azure Key Vault Integration
Webhooks
Types of Events
Managing Webhooks
Licensing
Activating Your License
Managing Your Licenses
Alerts
Alert Severity Levels
Setting Up Email Alerts
Settings
⚡ Actions
About Actions
Managing Actions
📁 Folders Context
About the Folders Context
Home
📁 Automations
About Automations
📁 Processes
About Processes
Managing Processes
About Recording
📁 Jobs
About Jobs
Managing Jobs
Job States
📁 Triggers
About Triggers
Managing Triggers
Using Cron Expressions
📁 Folder Packages
About Packages
Managing Packages
📁 Logs
About Logs
Logging Levels
Managing Logs in Orchestrator
Orchestrator Logs
Protecting Sensitive Information in Studio
📁 Monitoring
About Monitoring
Machines
Processes
Queues
Queues SLA
📁 Queues
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
Field Descriptions for the Transactions .csv File
Review Requests
📁 Assets
About Assets
Managing Assets in Orchestrator
Managing Assets in Studio
📁 Storage Buckets
About Storage Buckets
CORS/CSP Configuration
Managing Storage Buckets
Moving Bucket Data Between Storage Providers
📁 Testing
Test Automation
Test Cases
Field Descriptions for the Test Cases Page
Test Sets
Field Descriptions for the Test Sets Page
Test Executions
Field Descriptions for the Test Executions Page
Test Schedules
Field Descriptions for the Test Schedules Page
Test Data Queues
Managing Test Data Queues in Orchestrator
Managing Test Data Queues in Studio
Field Descriptions for the Test Data Queues Page
Test Data Queue Activities
📁 Action Catalogs
About Action Catalogs
Managing Action Catalogs
👤 Profile
About the Profile Page
Managing Profile Settings
🔧 System Administrator
About System Administrators
Managing Tenants
Maintenance Mode
Identity Server
About Identity Server
Identity Management Portal
External Identity Providers
Installation Access Token
Registering External Applications
Managing External Applications
Authentication
About Authentication
Configuring the SMTP server
SmartCard Authentication
Enabling Windows Authentication
Setting Up Auto Login for Users Under an Active Directory Group
Resetting Your Password Through Your Email
Changing the Windows Authentication Protocol
Single Sign-On Authentication Using SAML 2.0
ADFS Authentication
Google Authentication
OKTA Authentication
PingOne Authentication
Custom Mapping
Self-Signed Certificates
Setting Orchestrator to Use a Private Key Certificate
Google Authentication Using OpenID Connect
Azure AD Authentication
Other Configurations
Increasing the Size Limit of Package Files
Setting up Encryption Key per Tenant
GZIP Compression
Integrations
About Input and Output Arguments
Example of Using Input and Output Arguments
Classic Robots
Robots
Managing Robots
Robot Statuses
Setup Samples
Environments
Managing Environments
Jobs
Triggers
Assets
Queues
Logs
Monitoring
Robots
Processes
Queues
Queues SLA
Troubleshooting
Frequently Encountered Orchestrator Errors
Cron Expressions
Upgrade Issues
Orchestrator Mobile App
Push Notifications
Favorite Processes
Favorite Jobs
Mobile Device Management
Getting Started
Introduction
Activities Feeds
Robots
Robot Statuses
Robot Settings
Backward and Forward Compatibility
Orchestrator Installation
Release Notes
2021.4.1
Best Practices
Automation Best Practices
Managing Large Deployments
Attended vs. Unattended Automation
Organization Modeling in Orchestrator
Administration of Modern Folders
Security Best Practices
Performance Best Practices
🌐 Tenant Context
About the Tenant Context
About Tenants
Robots
Managing Robots
Connecting Robots to Orchestrator
Setup Samples
Storing Robot Credentials in CyberArk
Folders
Managing Folders
Folders Administration
Personal Workspaces
Managing Personal Workspaces
Key Features and Behavior
Using Modern Folders
Users
User Types
Managing Users
FAQ
Roles
Default Roles
Managing Roles
Machines
Managing Machines
Packages
Managing Packages
About Libraries
Managing Libraries
Audit
Credential Stores
Managing Credential Stores
CyberArk® Integration
CyberArk® CCP Integration
Azure Key Vault Integration
Webhooks
Types of Events
Managing Webhooks
Licensing
Activating Your License
Managing Your Licenses
Alerts
Alert Severity Levels
Setting Up Email Alerts
Settings
⚡ Actions
About Actions
Managing Actions
📁 Folders Context
About the Folders Context
Home
📁 Automations
About Automations
📁 Processes
About Processes
Managing Processes
About Recording
📁 Jobs
About Jobs
Managing Jobs
Job States
📁 Triggers
About Triggers
Managing Triggers
Using Cron Expressions
📁 Folder Packages
About Packages
Managing Packages
📁 Logs
About Logs
Logging Levels
Managing Logs in Orchestrator
Orchestrator Logs
Protecting Sensitive Information in Studio
📁 Monitoring
About Monitoring
Machines
Processes
Queues
Queues SLA
📁 Queues
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
Field Descriptions for the Transactions .csv File
Review Requests
📁 Assets
About Assets
Managing Assets in Orchestrator
Managing Assets in Studio
📁 Storage Buckets
About Storage Buckets
CORS/CSP Configuration
Managing Storage Buckets
Moving Bucket Data Between Storage Providers
📁 Testing
Test Automation
Test Cases
Field Descriptions for the Test Cases Page
Test Sets
Field Descriptions for the Test Sets Page
Test Executions
Field Descriptions for the Test Executions Page
Test Schedules
Field Descriptions for the Test Schedules Page
Test Data Queues
Managing Test Data Queues in Orchestrator
Managing Test Data Queues in Studio
Field Descriptions for the Test Data Queues Page
Test Data Queue Activities
📁 Action Catalogs
About Action Catalogs
Managing Action Catalogs
👤 Profile
About the Profile Page
Managing Profile Settings
🔧 System Administrator
About System Administrators
Managing Tenants
Maintenance Mode
Identity Server
About Identity Server
Identity Management Portal
External Identity Providers
Installation Access Token
Registering External Applications
Managing External Applications
Authentication
About Authentication
Configuring the SMTP server
SmartCard Authentication
Enabling Windows Authentication
Setting Up Auto Login for Users Under an Active Directory Group
Resetting Your Password Through Your Email
Changing the Windows Authentication Protocol
Single Sign-On Authentication Using SAML 2.0
ADFS Authentication
Google Authentication
OKTA Authentication
PingOne Authentication
Custom Mapping
Self-Signed Certificates
Setting Orchestrator to Use a Private Key Certificate
Google Authentication Using OpenID Connect
Azure AD Authentication
Other Configurations
Increasing the Size Limit of Package Files
Setting up Encryption Key per Tenant
GZIP Compression
Integrations
About Input and Output Arguments
Example of Using Input and Output Arguments
Classic Robots
Robots
Managing Robots
Robot Statuses
Setup Samples
Environments
Managing Environments
Jobs
Triggers
Assets
Queues
Logs
Monitoring
Robots
Processes
Queues
Queues SLA
Troubleshooting
Frequently Encountered Orchestrator Errors
Cron Expressions
Upgrade Issues
Orchestrator Mobile App
Push Notifications
Favorite Processes
Favorite Jobs
Mobile Device Management
Introduction to the Orchestrator API
About OData and References
API References
Logical Resources and Metadata
Available Operations
Enumerated Types
The Swagger Definition
Managing Logical Resources
Building API Requests
Basics
Authenticating
Using OAuth for External Apps
Permissions Per Endpoint
Response Codes
Examples Using the Orchestrator API
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
Getting Started
Introduction
Activities Feeds
Robots
View All 5
Release Notes
2021.4.1
Best Practices
Automation Best Practices
Security Best Practices
Performance Best Practices
🌐 Tenant Context
About the Tenant Context
Robots
Folders
View All 13
⚡ Actions
About Actions
Managing Actions
📁 Folders Context
About the Folders Context
Home
📁 Automations
About Automations
📁 Processes
About Processes
Managing Processes
About Recording
📁 Jobs
About Jobs
Managing Jobs
Job States
📁 Triggers
About Triggers
Managing Triggers
Using Cron Expressions
📁 Folder Packages
About Packages
Managing Packages
📁 Logs
About Logs
Logging Levels
Managing Logs in Orchestrator
View All 5
📁 Monitoring
About Monitoring
Machines
Processes
View All 5
📁 Queues
About Queues and Transactions
Managing Queues in Orchestrator
Managing Queues in Studio
View All 5
📁 Assets
About Assets
Managing Assets in Orchestrator
Managing Assets in Studio
📁 Storage Buckets
About Storage Buckets
Managing Storage Buckets
Moving Bucket Data Between Storage Providers
📁 Testing
Test Automation
Test Cases
Test Sets
View All 6
📁 Action Catalogs
About Action Catalogs
Managing Action Catalogs
👤 Profile
About the Profile Page
Managing Profile Settings
🔧 System Administrator
About System Administrators
Managing Tenants
Maintenance Mode
Identity Server
About Identity Server
Identity Management Portal
External Identity Providers
View All 5
Authentication
About Authentication
Configuring the SMTP server
SmartCard Authentication
View All 10
Other Configurations
Increasing the Size Limit of Package Files
Setting up Encryption Key per Tenant
GZIP Compression
Integrations
About Input and Output Arguments
Example of Using Input and Output Arguments
Classic Robots
Robots
Environments
Jobs
View All 8
Troubleshooting
Frequently Encountered Orchestrator Errors
Cron Expressions
Upgrade Issues
Orchestrator Mobile App
Push Notifications
Favorite Processes
Favorite Jobs
View All 4
Introduction to the Orchestrator API
About OData and References
API References
Logical Resources and Metadata
View All 5
The Swagger Definition
Managing Logical Resources
Building API Requests
Basics
Authenticating
Using OAuth for External Apps
Permissions Per Endpoint
View All 4
Examples Using the Orchestrator API
Environments Requests
Robots Requests
Retrieving License Information
View All 23