Expose the Robot in Orchestrator as a REST API

api

#1

Hello,

I need some help to expose my robot as a REST API. which allow user to call the Url and will trigger my robot.
I have studied the forum and tutorial, however, it didn’t tell exactly how to achieve it. Can anyone has this experience before. Could share your step to me.


#2

Robot REST API is not supported anymore. We recommend using Orchestrator API.
Please check the posts related(most of them have the tag “api”) and you can give it a try with Orchestrator CE: https://platform.uipath.com/ here:
https://platform.uipath.com/swagger/ui/index#/


#3

the orchestrator API can only call the orchestrator function. e.g. create robot, process, trigger jobs., I don’t see any default API which allow me to call my robot and execute it.

is there anyway I can expose my robot after I have deployed to orchestrator?


#4

Doesn’t this mean to trigger a job? After provision the Robot to Orchestrator, link it to an Environment, deploy the Process you want your Robot to run and then you can Start a job via API. Here is an example;

If your Robot is Attended(meaning you cannot start/schedule a job from Orchestrator) you wouldn’t be able to run it.


#5

But how can I pass the parameter via the Url ?


#6

Hi

you require to call the following activities after each other:

  1. Authentication
  2. use the auth-key gathered in “1” to inject your data into the queue (if applicable)
  3. list releases. Chose the release name you want to and select the release key
  4. use the release key to start your job accordingly

The Swagger UI helps to research the required functions mentioned above and to parametrize them accordingly… helps?


#7

Hi @binaer,

Thanks for you reply.

however, I am looking for something like trigger a Post /odata/Jobs/UiPath.Server.Configuration.OData.StartJobs endpoint, and pass in the parameters which required in the Rot workflow. and the endpoint will response the message e.g. “OK/Fail” generated by Rot. Is it possible to do that? I have read this article https://www.uipath.com/kb-articles/uipath-robot-api and expect to have some samiliar to this article in the Orchestrator. Is it doable in Orchestrator?


#8

Hi

yes, this is complete doable and that’s what the REST-API is for. check this one:
https://platform.uipath.com/swagger/ui/index#!/Jobs/Jobs_StartJobs