- Open API
- Introduction to Automation Hub API
- Introduction to Automation Hub API (Automation Cloud Public Sector)
- API References
- Generate your Token from Automation Hub
- Authentication to the Automation Hub API
- Authentication to the Automation Hub API (Automation Cloud Public Sector)
- Add users in bulk to Automation Hub using OpenAPI
- Bulk edit users in Automation Hub using OpenAPI
- Retrieve Automation Idea in Idea Phase Awaiting Review Status
- Retrieve the Cost Benefit Analysis for a Specific Idea
- Update Automation Idea Phase and Status
- Retrieve a User Account
- Update Account Details for Employees from Automation Hub
- Inactivate User Accounts that are Not Part of the Company
- Power BI Integration Video Tutorial
- Service Now Outbound Integration Video Tutorial
- 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
Automation Hub api guide
The Open API feature allows UiPath 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 API requests as in below examples:
- 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
The POST /automationidea, POST /coe-automationidea, and POST /processmining-idea endpoints are legacy endpoints that can only be used when idea flow assessments and workflows have not been customized. For all new integrations and customized idea flows, the recommended approach is to use GET /idea-schema to retrieve the structure of the submission form, followed by POST /idea-from-schema to submit the idea.
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:// |
| Delayed Release URL | https:// |
| GET all ideas API structure for Delayed Release Organizations | https:// |
| App key | The app key generated from the Automation Hub UI. |
{orgName} and {tenantName} are variables that refer to the name of your organization and the name of your tenant.
The next step is to Consume the available APIs.
API References
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://<accessURL>/{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://<accessURL>/{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.