- Open API
- Introduction to Automation Hub API
- Generate your Token from Automation Hub
- 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
Introduction to Automation Hub API
- The entire API calls list can be found in Swagger and Postman documentation.
- Some quick examples on how to use API calls can be found in Examples of API Calls. For an in-depth experience or to test specific API responses, use the Swagger or Postman environment described in API References.
Customized Assessments
GET/idea-schemaPOST/idea-from-schemaGET/automations/{automationId}/schemaPATCH/automations/{automationId}
Automation Ideas
GET/automationsGET/automations/collaboratorsDELETE/automations/{automationId}/collaboratorsPOST/automations/{automationId}/collaboratorsGET/automations/{automationId}/documentsPOST/automations/{automationId}/documentsGET/automations/{automationId}/componentsGET/questionnaireGET/cbaPUT/automations/cba/{automationId}/project-plan-baselinePOST/automationideaPOST/coe-automationideaPOST/processmining-ideaPOST/automations/{automationId}/mediaPOST/automations/statusPOST/automations/{automationId}/tagsPUT/automation/{automationId}/categories
Automation Pipeline
GET/automationpipeline
Users
GET/usersGET/rolesPOST/adduserPOST/edituser
Application Inventory
GET/appinventoryPUT/appinventoryDELETE/appinventory/{applicationId}
Categories
GET/hierarchyPUT/categories
Components
GET/components
Automation Store
GET/automation-storeGET/automation-store/{automationId}/reviews
The API calls reflects actions that a user can perform in the Automation Hub interface.
To start making calls with the following variables access the OpenAPI 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://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/openapi |
|
Delayed Release URL | https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/openapi |
|
GET all ideas API structure for Delayed Release Organizations | https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/openapi |
|
App key |
The app key generated from the Automation Hub UI. |
The next step is to Consume the available APIs.
The Automation Hub API Swagger definition can be accessed directly by adding the Authentication details in the Authorization key in the request call named Header.
https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/api-doc/
The guide herein is built to support the Swagger documentation, by providing relevant and easy to follow examples.
To use Swagger documentation in Delayed Release Organizations, use the following link:
https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/api-doc/
If you prefer to work with Postman, create a Postman environment. Afterwards, check out our API collection made available in Postman. The collection can be imported by clicking the Run in Postman button.
