Developer Guide

You can steer RPA Orchestrator via REST API instead of the RPA Cockpit user interface.

To do so, follow the steps below:

1. Install Tricentis RPA Orchestrator.

2. Set up authentication via bearer token.

3. Send your REST request. You can send the following requests:

   • Grant publish rights to user groups. Only user groups with publish rights can publish Bots in RPA Studio.

     You can also remove publish rights from a user group.

   • Assign user groups to Bots. Only users who are part of a user group that is assigned to a Bot can work with this Bot, for instance run it or check results.

     You can also remove access rights from a user group.

   • View permissions. Request a list of access and publish permissions.

   • Get a list of all published Bots.

   • Get a list of all Agents.

   • Get information on a specific Agent.

   • Get all revisions for a Bot.

   • Get information on a specific Bot revision.

   • Assign Agents to Bots.

     You can also check which Agent is assigned to a Bot or remove the Agent assignation.

   • Trigger a Bot run.

   • Get a Bot result overview.

   • Get detailed Bot results.

   • Get a results summary.

   • Cancel a Bot run.

   • Perform an emergency stop.

   • Schedule a Bot.

   • Check Bot schedules.

   • Modify a Bot schedule.

   • Delete a Bot schedule.

   • Get reports.

Examples

The following chapters contain example requests. You can use them as templates for your own requests.

• "Examples | Schedule a Bot"

• "Examples | Get reports"