- Open API
- Introduction to Automation Hub API
- API References
- Generate your Token from Automation Hub
- Authenticating to Your Automation Hub Tenant
- Retrieve Automation Idea in Idea Phase Awaiting Review Status
- 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
- Retrieve a User Account
- Update Account Details for Employees from Automation Hub
- Inactivate User Accounts that are Not Part of the Company
- 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 Users
- Input for User Status
- User Status Table
- Input for Collaborators
- Output Dictionary
- Automation Hub Open API Power Query Data Parsing
- Automation Hub Custom Connector - Preview
Introduction to Automation Hub API
The Open API feature allows Automation Hub users to access and manipulate their tenant data programmatically. Based on the feedback received, as well as the platform structure, we've focused on delivering the following API requests:
Customized Assessments
-
GET/idea-schema
-
POST/idea-from-schema
-
GET/automations/{automationId}/schema
-
PATCH/automations/{automationId}
Automation Ideas
-
GET/automations
-
GET/automations/collaborators
-
DELETE/automations/{automationId}/collaborators
-
POST/automations/{automationId}/collaborators
-
GET/automations/{automationId}/documents
-
POST/automations/{automationId}/documents
-
GET/automations/{automationId}/components
-
GET/questionnaire
-
GET/cba
-
PUT/automations/cba/{automationId}/project-plan-baseline
-
POST/automationidea
-
POST/coe-automationidea
-
POST/processmining-idea
-
POST/automations/{automationId}/media
-
POST/automations/status
-
POST/automations/{automationId}/tags
-
PUT/automation/{automationId}/categories
Automation Pipeline
-
GET/automationpipeline
Users
-
GET/users
-
GET/roles
-
POST/adduser
-
POST/edituser
Application Inventory
-
GET/appinventory
-
PUT/appinventory
-
DELETE/appinventory/{applicationId}
Categories
-
GET/hierarchy
-
PUT/categories
Components
-
GET/components
Automation Store
-
GET/automation-store
-
GET/automation-store/{automationId}/reviews
More field examples and API calls can be found in Swagger documentation.
These API calls reflect all the actions that a user can perform in the Automation Hub interface.
In order to start making calls with the following variables access the Open API options from the Automation Hub platform > Admin Console > Platform Setup > Open API and generate your token.
Variable |
Value |
---|---|
Token |
The token generated from the Automation Hub UI. |
URL |
https://govcloud.uipath.us/api/v1/openapi |
Delayed Release URL |
http://ah-gxp-openapi-us.uipath.com/api/v1/openapi/ |
GET all ideas API structure for Delayed Release Organizations |
http://ah-gxp-openapi-us.uipath.com/api/v1/openapi/automations |
App key |
The app key generated from the Automation Hub UI. |
The next step is to Consume the available APIs.
Check out the Logical Resources and the Available Operations.
When building your API request always rely on the Input Dictionary as it contains all the query parameters you will be using.