Orchestrator Api guide

Can someone please suggest me all steps to work on orchestrator api.

As i have tried few but i think i am not following correct thing.

I basically want to fetch some information from orchestrator using api.

1 Like

Hi @Hitesh1

Hope this article might be helpful to you.

https://docs.uipath.com/orchestrator/reference#managing-logical-resources

cheers :smiley:

Happy learning :smiley:

2 Likes

Can you please tell me what should be my first step?

Authentication ?

Create a Post Request
Headers
Content-Type = application/json
User-Agent = blank
X-UIPATH-TenantName = your tenant name

you’ll get download data back which will include an access token and ID token

what about authentication step?

@Jersey_Practical_Sho- Can you pls describe your last statement-
you’ll get download data back which will include an access token and ID token

Create a Post Request to https://account.uipath.com/oauth/token

Create these headers, set Value for Tenant, as whatever your tenant name is

Put this in the Body

This will give you Access Token which you then use in further requests

Kindly have a view on this

Cheers @Hitesh1

1 Like

@Palaniyappan - Hi , I got access token in first step.

In tried to check authentication, but it is throwing response code as 0 every time, though i have passes right data.

In second step - Generating Code Challenge and Code Verifier:
I am getting error msg “crypto not defined”

done with this, now what is the next step?

every time i am getting below error msg-
message": “{“message”:“You are not authenticated!”,“errorCode”:0,“result”:null,“targetUrl”:null,“success”:false,“error”:{“code”:0,“message”:“You are not authenticated!”,“details”:“You should be authenticated (sign in) in order to perform this operation.”,“validationErrors”:null},“unAuthorizedRequest”:false,”__abp":true}401",

Thats an older way of doing it, If you have the access token you can use that to start jobs etc

Thankyou so much for this information.

Can you just tell me how to call a job now using token?

First you need to get the release key for the process you want to Run

Headers

Authorizations
Change to Bearer and Enter Access Token

Body
Nothing

Send

You’ll get back a list of all the processes available, Copy the Key of the process you want to start

come back to me when you have the release key

can you pls share the url that you have used in your screen shot

https://platform.uipath.com/CHANGE TO TENANT NAME/CHANGE TO TENANT NAME/odata/Releases

@Jersey_Practical_Sho - I am using below url

https://platform.uipath.com/cognizantDefault/odata/Releases/

it is showing could not get any response msg

https://platform.uipath.com/cognizantDefault/cognizantDefault/odata/Releases

Thanks for your reply !!!
In UiPath studio where we should mention bearer token.
For example in properties window where should we set this.

You want to start a job from a workflow?

If so you don’t need any of the api stuff, as studio will connect through your robot to orchestrator, you just need to add a “Start Job”

The API is mainly for external systems to interact with ochestrator and thus the robots. Ie I have an Alteryx Workflow that produces data, at the end of its workflow it uses the api to start a UiPath Robot to process the data

@Jersey_Practical_Sho - Thanksyou so much for this information.

Now it is very much clear to me.

Just one more question , Can you tell me the name of any external source that uses orchestrator api and how we use access token for the same.

Thanks in Advance!!!

I mainly use Alteryx, but the steps would be exactly the same

Authenticate
Get Releases (if you need to know the process key)
Start Job

They will need all the information you used above Headers, Body, Authorisations and URL

1 Like