Qodex.ai

UiPath Add-ins Guide

Number of APIs: 18

What is this about:

The UiPath Orchestrator API is used by third-party platforms to build Add-ins as described here. Common use cases of Add-ins are to start jobs in UiPath Orchestrator or create queue items which can be processes by robots. This guide describes only UiPath Orchestrator APIs that can be used to build these Add-ins. There are more APIs in UiPath platform available, like Automation Hub or Data Service, but not explained in this document.

Please notice: Add-ins were formerly called Connectors.

Why build an Add-in:

Add-ins give you the flexibility to stay connected to your UiPath resources from outside of the UiPath products. So, if you want to invoke or retrieve information about a UiPath Orchestrator resource from within your application (e.g. start a process, add a Queue item, etc.), then a Add-in is the ideal integration to build. This allows you to seamlessly integrate robots into your local software ecosystem.

For example, your application is an issue management system and you want a robot to run a specific business process after a user or system event (e.g., a new ticket is created). By integrating with the Orchestrator API via am Add-in, you have the ability to send requests that instruct a robot to run the business process that typically follows the event (e.g., escalate ticket based on its category, content, etc.)

  1. Authentication-External Apps (oAuth 2.0 ) - GET Folders GET {{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/orchestrator_/odata/folders?$Filter=DisplayName eq 'UnattendedProcesses'

  2. Folders-Validation and Type - GET Folders GET {{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/orchestrator_/odata/folders

  3. Start Job-Modern Folder - Get Folder by Name GET {{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/odata/Folders?$Filter=DisplayName eq 'Video'

  4. Start Job-Modern Folder - Get Releases by Name GET {{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/odata/Releases?$filter=Name eq 'Add a pet to pet store by queue item'

  5. Start Job-Modern Folder - Start Process POST {{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs

  6. Start Job-Input Parameters-Simple Key Vale Input Parameters - Get Folder by Name GET {{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/odata/Folders?$Filter=DisplayName eq 'UnattendedProcesses'

  7. Start Job-Input Parameters-Simple Key Vale Input Parameters - Get Releases by Name GET {{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/odata/Releases?$filter=ProcessKey eq 'PetStore_UpdatePet'

  8. Start Job-Input Parameters-Simple Key Vale Input Parameters - Start Process POST {{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs

  9. Start Job-Input Parameters-Data Table Input Parameters - Get Releases by Name GET {{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/odata/Releases?$filter=ProcessKey eq 'CreateTableauSAPorder'

  10. Start Job-Input Parameters-Data Table Input Parameters - Start Process POST {{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs