Subscribe
UiPath Automation Hub
Product Lifecycle
Submit Product Feedback
{{user.name}}
Log In
The UiPath Automation Hub Guide
UiPath Automation Hub
Overview
UiPath Action Center
UiPath Activities
UiPath AI Center™
UiPath Apps
UiPath Automation Cloud™
UiPath Automation Hub
UiPath Automation Ops
UiPath Automation Suite
UiPath Chatbot Connector - Preview
UiPath Connectors
UiPath Customer Portal
UiPath Data Service
UiPath Developer
UiPath Document Understanding
UiPath Insights
UiPath Installation and Upgrade
UiPath Integration Service
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
v1.0
v1.0
stable
(Cloud)
v2021.10
(On-premises via Automation Suite)
v2022.4
(On-premises via Automation Suite)
v2022.10
(On-premises via Automation Suite)
Home
UiPath Automation Hub Guide
Recipes
UiPath Automation Hub API Guide
Reference
Changelog
Discussions
Page Not Found
Search
{{ state.current().meta.title }}
API Logs
Home
UiPath Automation Hub Guide
UiPath Automation Hub API Guide
{{search.symbol}}K
discard
Save Edits
Submit
Suggested Edits
Release Notes
2022
November 2022
October 2022
September 2022
August 2022
July 2022
June 2022
May 2022
April 2022
March 2022
February 2022
January 2022
2021
December 2021
November 2021
October 2021
September 2021
August 2021
July 2021
June 2021
May 2021
April 2021
March 2021
February 2021
January 2021
2020
December 2020
November 2020
October 2020
September 2020
August 2020
July 2020
June 2020
May 2020
April 2020
March 2020
February 2020
January 2020
2019
December 2019
November 2019
General Availability
Getting Started
Introduction
Software Requirements and Browser Compatibility
The User Interface
User Options
Localization
Security
Regions
Creating a Trial Tenant
Automation Hub on an existing Automation Cloud Trial Account
Automation Hub on an existing Automation Cloud Community Account
Trial Services
Sign up Process
FAQ
Roles & Permissions
Role Description and Matrix
Collaborator Roles Information and Matrix
Understanding the Roles and Collaborator Roles
Citizen Developer Roles and Collaborator Roles
Starting as
Starting as the Account Owner
Starting as the System Admin
Predefined Content from the Tenant
Starting as an RPA Sponsor
Starting as a Component Curator
Starting as a Program Manager
Starting as an Idea Approver
Starting as an Authorized User
Starting as a Standard User
Starting as a Citizen Developer
Starting as a Citizen Developer Self User
Starting as a Citizen Developer Power User
Starting as a Business Reviewer
Starting as a Technical Reviewer
Understanding the Citizen Developer Flow
Learn More with Courses from Academy
Admin Console
Admin Console Overview
Account
Customizing Your Tenant
Updating the Settings
Audit Logs
Manage Access
Adding New User Accounts
Managing User Accounts
Completing the User Account Form
Assigning Categories to Roles and Collaborator Roles
Downloading and Uploading a CSV
Creating a New User Role
Creating a New Collaborator Role
Platform Setup
Categories
App Inventory
Documentation
Managing the Cost
Import your Pipeline
Generating your API Token
Enable Insights Connection
Customize assessments
Assessments per Category
Customization Examples
Manage Components
Curating a Component
Component Statuses
Deleting Data
Jira Integration
Workspace
Workspace Overview
Automation Pipeline
Review
Decision Pipeline
Implementation
Live
Column Information
My Submissions
Managing my Ideas
Managing my Automations
Managing Drafts
Managing my Change Requests
My Collaborations
My Components
Uploading a Component
Creating a New Version for a Component
Following
Explore
Explore Overview
Automation Program
Automation Profile Page
About Information
Detailed Assessment
Detailed Assessment Algorithm
Citizen Developer Assessment
Execution Assessment
Performing the Cost Benefit Analysis
Documentation
Components
Collaborators
Change requests
Automation Phase and Status
People
User Profile
Accomplishments
Components
Component Profile Page
FAQ
Leaderboard
Leveling Up
Share Idea or Automation
Submit an Idea
Submitting an Employee-driven Idea
Submitting a CoE-driven Idea
Submit an Idea from UiPath Process Mining
Submit an Idea from UiPath Task Mining
Information About the Idea Score
Idea Review Flow
Submit an Automation
Sharing an Automation
Submit a Change Request
Using the Jira Integration
FAQ
Dashboards
Dashboards Overview
Automation Program Performance
Average Automation Cost
Planning Report
Cost Report
Downloading Information from Dashboards
Integrating with Insights
My Tasks
My Tasks Overview
Incomplete Tasks
Reviewing My Assigned Tasks
Complete Tasks
Notifications
Notifications
Reviewing My Notifications
Email Notifications
Email Types
Email Content
Email Settings
Resources
Resources
Updating My Profile
Open API
Introduction to Automation Hub API
Consuming API
Available Operations
Input Dictionary
Building API Requests
Examples of API Calls
Automation Hub Open API Power Query Data Parsing
Automation Hub Custom Connector - Preview
Process Mining Integration
Set up Integration with UiPath Process Mining
Studio Integration
Linking a Project to an Idea in Automation Hub
Task Capture Integration
Documenting your Ideas and Automations Using Task Capture
Downloading Task Capture
Editing a Document Using Task Capture
Task Capture Usage Specifications
Automation Hub - Automation Cloud Integration
Introduction to the Automation Cloud Integration
Migration Guide
Migration - Case: New Automation Cloud Account
Migration - Case: Existing Automation Cloud Account
Migration FAQ
Provisioning
Enabling Automation Hub in Automation Cloud
Provisioning from Automation Hub
License Allocation and Management
Managing Automation Hub Service
User Management
Adding Individual Users
Bulk Upload Users
Managing Groups
Azure Active Directory Integration
Differences in the Service View
Automation Store
Overview
Enabling the Store
Enable from Automation Cloud
Instant consumption settings
Orchestrator connection
UiPath Assistant connection
Permissions
Automation Store Flow
Publishing to Store
Publishing from the Citizen Development flow
Publishing a Live - In Production Automation Idea
Publish settings
Store experience
Browsing the Store gallery
Getting and requesting Automations
Pricing Plans
Pricing Plans Details
Trial Plan
Standard Plan
Video Tutorials
Getting Started
Admin Console
Platform Setup
Manage Components
Workspace
Manage the Automation Pipeline as a Program Manager
Upload Components and Update their Version
Explore
Ideas
Components
People
Leaderboard
Dashboards
My Tasks and Notifications
Integration with Task Capture
Citizen Developer Flow
Additional Resources
Glossary
Academy Courses
Release Notes
2022
November 2022
October 2022
September 2022
August 2022
July 2022
June 2022
May 2022
April 2022
March 2022
February 2022
January 2022
2021
December 2021
November 2021
October 2021
September 2021
August 2021
July 2021
June 2021
May 2021
April 2021
March 2021
February 2021
January 2021
2020
December 2020
November 2020
October 2020
September 2020
August 2020
July 2020
June 2020
May 2020
April 2020
March 2020
February 2020
January 2020
2019
December 2019
November 2019
General Availability
Getting Started
Introduction
Software Requirements and Browser Compatibility
The User Interface
User Options
Localization
Security
Regions
Creating a Trial Tenant
Automation Hub on an existing Automation Cloud Trial Account
Automation Hub on an existing Automation Cloud Community Account
Trial Services
Sign up Process
FAQ
Roles & Permissions
Role Description and Matrix
Collaborator Roles Information and Matrix
Understanding the Roles and Collaborator Roles
Citizen Developer Roles and Collaborator Roles
Starting as
Starting as the Account Owner
Starting as the System Admin
Predefined Content from the Tenant
Starting as an RPA Sponsor
Starting as a Component Curator
Starting as a Program Manager
Starting as an Idea Approver
Starting as an Authorized User
Starting as a Standard User
Starting as a Citizen Developer
Starting as a Citizen Developer Self User
Starting as a Citizen Developer Power User
Starting as a Business Reviewer
Starting as a Technical Reviewer
Understanding the Citizen Developer Flow
Learn More with Courses from Academy
Admin Console
Admin Console Overview
Account
Customizing Your Tenant
Updating the Settings
Audit Logs
Manage Access
Adding New User Accounts
Managing User Accounts
Completing the User Account Form
Assigning Categories to Roles and Collaborator Roles
Downloading and Uploading a CSV
Creating a New User Role
Creating a New Collaborator Role
Platform Setup
Categories
App Inventory
Documentation
Managing the Cost
Import your Pipeline
Generating your API Token
Enable Insights Connection
Customize assessments
Assessments per Category
Customization Examples
Manage Components
Curating a Component
Component Statuses
Deleting Data
Jira Integration
Workspace
Workspace Overview
Automation Pipeline
Review
Decision Pipeline
Implementation
Live
Column Information
My Submissions
Managing my Ideas
Managing my Automations
Managing Drafts
Managing my Change Requests
My Collaborations
My Components
Uploading a Component
Creating a New Version for a Component
Following
Explore
Explore Overview
Automation Program
Automation Profile Page
About Information
Detailed Assessment
Detailed Assessment Algorithm
Citizen Developer Assessment
Execution Assessment
Performing the Cost Benefit Analysis
Documentation
Components
Collaborators
Change requests
Automation Phase and Status
People
User Profile
Accomplishments
Components
Component Profile Page
FAQ
Leaderboard
Leveling Up
Share Idea or Automation
Submit an Idea
Submitting an Employee-driven Idea
Submitting a CoE-driven Idea
Submit an Idea from UiPath Process Mining
Submit an Idea from UiPath Task Mining
Information About the Idea Score
Idea Review Flow
Submit an Automation
Sharing an Automation
Submit a Change Request
Using the Jira Integration
FAQ
Dashboards
Dashboards Overview
Automation Program Performance
Average Automation Cost
Planning Report
Cost Report
Downloading Information from Dashboards
Integrating with Insights
My Tasks
My Tasks Overview
Incomplete Tasks
Reviewing My Assigned Tasks
Complete Tasks
Notifications
Notifications
Reviewing My Notifications
Email Notifications
Email Types
Email Content
Email Settings
Resources
Resources
Updating My Profile
Open API
Introduction to Automation Hub API
Consuming API
Available Operations
Input Dictionary
Building API Requests
Examples of API Calls
Automation Hub Open API Power Query Data Parsing
Automation Hub Custom Connector - Preview
Process Mining Integration
Set up Integration with UiPath Process Mining
Studio Integration
Linking a Project to an Idea in Automation Hub
Task Capture Integration
Documenting your Ideas and Automations Using Task Capture
Downloading Task Capture
Editing a Document Using Task Capture
Task Capture Usage Specifications
Automation Hub - Automation Cloud Integration
Introduction to the Automation Cloud Integration
Migration Guide
Migration - Case: New Automation Cloud Account
Migration - Case: Existing Automation Cloud Account
Migration FAQ
Provisioning
Enabling Automation Hub in Automation Cloud
Provisioning from Automation Hub
License Allocation and Management
Managing Automation Hub Service
User Management
Adding Individual Users
Bulk Upload Users
Managing Groups
Azure Active Directory Integration
Differences in the Service View
Automation Store
Overview
Enabling the Store
Enable from Automation Cloud
Instant consumption settings
Orchestrator connection
UiPath Assistant connection
Permissions
Automation Store Flow
Publishing to Store
Publishing from the Citizen Development flow
Publishing a Live - In Production Automation Idea
Publish settings
Store experience
Browsing the Store gallery
Getting and requesting Automations
Pricing Plans
Pricing Plans Details
Trial Plan
Standard Plan
Video Tutorials
Getting Started
Admin Console
Platform Setup
Manage Components
Workspace
Manage the Automation Pipeline as a Program Manager
Upload Components and Update their Version
Explore
Ideas
Components
People
Leaderboard
Dashboards
My Tasks and Notifications
Integration with Task Capture
Citizen Developer Flow
Additional Resources
Glossary
Academy Courses
Introduction
Introduction to Automation Hub API
API References
Generate your Token from Automation Hub
Consuming API
Logical Resources and Metadata
Available Operations
Get Started
Input Dictionary
Input for Automation Pipeline
Input for Submission Type
Input for Phase
Input for Status
Input for Phase and Status Update
Input for Business Unit
Input for Applications
Input for Category
Input for Cost Benefit Analysis
Input for High Level Assessment
Input for Detailed Assessment
Input for Automation Idea Creation Date
Input for Automation Idea Update Date
Input for Users
Input for User Status
Input for Collaborators
Output Dictionary
Permissions Per Endpoint
Response Codes
Authentication Error Codes
Submit Idea Error Codes
Add/Update User Error Codes
Token Without an Assigned User Error Codes
The Swagger Definition
Managing Logical Resources
Building API Requests
Examples
Automation Idea
Retrieve Automation Idea in Idea Phase Awaiting Review Status
Import Automation Idea Through the Employee-driven Flow
Import an Automation Idea Through the CoE Flow
Retrieve the Cost Benefit Analysis for a Specific Idea
Update Automation Idea Phase and Status
Power BI Integration Video Tutorial
Service Now Outbound Integration Video Tutorial
Import Ideas Video Tutorial
Categories
Retrieve Automation Categories
Application Inventory
Retrieve Automation Inventory
Users
Retrieve a User Account
Import a New User Account
Update Account Details for Employees from Automation Hub
Inactivate User Accounts that are Not Part of the Company
Release Notes
2022
2021
2020
View All 4
Getting Started
Introduction
Software Requirements and Browser Compatibility
The User Interface
View All 8
Roles & Permissions
Role Description and Matrix
Collaborator Roles Information and Matrix
Understanding the Roles and Collaborator Roles
View All 4
Starting as
Starting as the Account Owner
Starting as the System Admin
Starting as an RPA Sponsor
View All 10
Admin Console
Admin Console Overview
Account
Manage Access
View All 8
Workspace
Workspace Overview
Automation Pipeline
My Submissions
View All 6
Explore
Explore Overview
Automation Program
People
View All 5
Share Idea or Automation
Submit an Idea
Submit an Automation
Submit a Change Request
View All 5
Dashboards
Dashboards Overview
Integrating with Insights
My Tasks
My Tasks Overview
Incomplete Tasks
Complete Tasks
Notifications
Notifications
Email Notifications
Email Types
Email Content
Email Settings
Resources
Resources
Open API
Introduction to Automation Hub API
Consuming API
Available Operations
View All 8
Process Mining Integration
Set up Integration with UiPath Process Mining
Studio Integration
Linking a Project to an Idea in Automation Hub
Task Capture Integration
Documenting your Ideas and Automations Using Task Capture
Editing a Document Using Task Capture
Task Capture Usage Specifications
Automation Hub - Automation Cloud Integration
Introduction to the Automation Cloud Integration
Migration Guide
Migration FAQ
View All 9
Automation Store
Overview
Enabling the Store
Permissions
View All 7
Pricing Plans
Pricing Plans Details
Video Tutorials
Getting Started
Admin Console
Workspace
View All 8
Additional Resources
Glossary
Academy Courses