UiPath Integrations

The UiPath Integrations Guide

Welcome to the UiPath Integrations guide. You will find comprehensive guides and documentation to help you start working with UiPath Integrations, as well as support if you get stuck.

In order to download the solutions mentioned here please visit the official UiPath Go! Marketplace here.

*Note that only integrations built in-house at UiPath are detailed below. For a complete list of UiPath's technology partners, see here.

Get All Batch Instances


Retrieves all active Batches with a specified status.



  • DisplayName (String) - The display name of the activity.


  • Private (Boolean) - If selected, the values of variables and arguments are no longer logged at Verbose level.


  • Status (String) - The status of batch instances to retrieve. Possible options are as follows:
    • New
    • Ready
    • Running
    • Ready_For_Review
    • Ready_For_Validation
    • Error
    • Finished
    • Deleted
    • Restarted
    • Restart_In_Progress
    • Transferred
    • Remote
    • Shared_Folder_Error
    • License_Error


  • BatchInstances (BatchInstance[ ]) - A collection of batches with the indicated status that are currently being processed.

Custom Classes


  • BatchName (Single) - The name given to the batch (possibly with the Upload Batch activity)
  • Executed Modules (Single) - A list of modules (such as the extraction module) through which this batch has already passed.
  • Identifier (DataTable) - A unique ID for this batch.
  • LocalFolder (EphesoftField[ ]) - The location in the Folder Management section containing this batch.
  • UncSubFolder (Single) - A specific folder in the Transact database into which a batch is placed when an instance of it is created.

Updated 3 months ago

Get All Batch Instances

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.