Prebuilt UiPath Integrations

Gaining access to the UiPath features on Humley Studio will mean that, on the creation of a new project, a number of pre-configured Integrations will be made available. These, along with the pre-loaded Variables, and the UiPath Subscribe module made available in Flow, will allow you to quickly build actions that interact with, query and trigger your UiPath automations.

Setting up your UiPath Integration Template

In order to access the pre-built UiPath Integration requests, you will first need to set-up a UiPath Template.

  1. On the Integrations page, click Create Integration.

  2. Choose the Templates card.

  3. Choose the UiPath card applicable to your UiPath tenancy - either UiPath (On-Premise) or UiPath (Cloud).

  4. In the sidebar, name the Template Integration and add the authentication details relevant to your UiPath tenancy. These credentials are described in the UiPath Orchestrator API documentation here.

  5. Click Create Template in the sidebar.

    Your new UiPath integration will be shown in the Template Integrations section.

Prebuilt Requests

The Template Integrations section contains all prebuilt requests available. Each request allows you to call different endpoints of the UiPath Orchestrator API.

Authentication is automatically handled by the Integration request, using the credentials you added when setting up the Template Integration

Although all the prebuilt Integration requests are editable, avoiding any changes to them will ensure their re-usability throughout multiple flows. See a UiPath Flow Example to see how to use a UiPath Integration in a Flow.

The following list of available prebuilt requests includes links to the relevant UiPath Docs that include example API requests and responses:

Assets

Request Name Request Type Description UiPath Docs
Create Assets POST Creates a new Asset more info
Edit Asset PUT Edits an existing Asset more info
Get All Assets GET Gets all Assets within the tenancy more info
Get All + Per Robot Values GET Gets all Assets and displays Per Robot values in the response. For global Assets, this call provides no extra features. more info
Get Asset By Name GET Gets a single Asset by a specified name more info

Environments

Request Name Request Type Description UiPath Docs
Add Robot To Environment POST Associates a Robot to a given environment more info
Get All Environments GET Gets all Environments for the tenancy more info
Remove Robot from Environment POST Removes a Robot from an environment more info

Folders

Request Name Request Type Description UiPath Docs
Get All Folders GET Gets all Folders for the tenancy more info

Jobs

Request Name Request Type Description UiPath Docs
Get All Jobs GET Gets all Jobs for the tenancy more info
Start Job POST Adds a new job and sets it in Pending state for each Robot based on the input parameters and notifies the respective Robots about the pending job more info
Start Job With Inputs POST Adds a new job with input arguments and sets it in Pending state for each Robot based on the input parameters and notifies the respective Robots about the pending job more info
Stop Job POST Stops a Job that is in a Run state more info

Machine/License Mappings

Request Name Request Type Description UiPath Docs
Get All Machine/License Mappings GET Get all machine/license mappings for the tenancy more info

Machines

Request Name Request Type Description UiPath Docs
Create Machine POST Creates a new machine more info
Get All Machines GET Gets all machines for the tenancy more info

Organization Units

Request Name Request Type Description UiPath Docs
Get All Organization Units GET Get all organization units for the tenacy more info

Packages

Request Name Request Type Description UiPath Docs
Update To Latest Package Version POST Updates the package version for the given release to the latest available more info
Update To Specific Package Version POST Updates the specified package version for the given release more info

Processes

Request Name Request Type Description UiPath Docs
Get All Processes GET Gets all processes for the tenancy more info

Process Versions

Request Name Request Type Description UiPath Docs
Get a Process GET Gets a single process by ID more info

Queue Items

Request Name Request Type Description UiPath Docs
Create Queue Item POST Adds a new item to a queue based on input parameters more info
Get All Queue Items By Queue ID GET Gets all items in a queue more info

Queues

Request Name Request Type Description UiPath Docs
Create Queue POST Creates a new queue on the tenancy more info
Set Transaction Result POST Updates the given queue item based on Robot processing outcome. more info
Start Transaction POST Adds a new queue item if the specific content is not null and then returns the new item or returns the next item in the queue to be processed. It also sets the state to InProgress for the returned item. more info

Releases

Request Name Request Type Description UiPath Docs
Get All Releases GET Gets all releases for the tenancy more info
Get Release By Name GET Gets a release by name specified more info
Rollback To Previous Release Version POST Reverts the package versions for the given release to the last version it had before the current one more info

Robots

Request Name Request Type Description UiPath Docs
Create Robot POST Creates a new Robot more info
Edit Robot PUT Edit an existing Robot more info
Get All Robots GET Gets all Robots more info
Get Robot By ID GET Gets a Robot by a specified ID more info
Get Robot By Name GET Gets a Robot by a specified name more info

Roles

Request Name Request Type Description UiPath Docs
Get All Roles GET Gets all Roles more info

Sessions

Request Name Request Type Description UiPath Docs
Get All Sessions GET Get all sessions for the tenancy more info

Further help

Getting Started with UiPath
Subscribe Module within Flow
UiPath Flow Example

Still need help? Get in touch!
Last updated on 3rd Apr 2020