How To Make Orchestrator API Requests Using HTTP Request Activities?

[system]

How to make Orchestrator API Requests using HTTP Request activities?

Note: In the below example, usage of the "/odata/ProcessSchedules" REST API endpoint is explained. Readapt the steps based on current needs.

In order to make Orchestrator API Requests using HTTP Request activities, two options are present:

1. Orchestrator HTTP Request Activity
2. HTTP Request Activity

1. Using Orchestrator HTTP Request Activity

• To use this approach, Robot should be connected to Orchestrator and it does not require to authenticate the Orchestrator using Authenticate API.
  • Pass the relative endpoint in the "RelativeEndpoint" like "/odata/ProcessSchedules"

Refer the Orchestrator HTTP Request .

Example for the Orchestrator HTTP Request Activity

1. Find the Orchestrator HTTP Request activity in Activities panel


2. Make sure that Robot is connected to Orchestrator in Studio


3. The activity Properties panel should look like this

Method: GET

RelativeEndpoint: "/odata/ProcessSchedules"

Folder Path (specify the full folder path in Orchestrator): "Shared/UnattendedFolder"

4. Create a variable for JSONResponse (it will have a String type): JSONResponse


5. Use the Deserialize JSON activity


6. In JsonString provide the already created variable JSONResponse, and in JsonObject create a new variable JsonObject (TypeArgument: Newtonsoft.Json.Linq.JObject)


7. In order to retrieve the needed data, use the For Each activity:

In: JsonObject.GetValue("value")

Message: "Id: "+ Convert.ToString(item.GetValue("Id")) + ", Name: "+Convert.ToString(item.GetValue("Name")) + " ->StartProcessCronDetails: " +Convert.ToString(item.GetValue("StartProcessCronDetails"))


Results:

2. Using HTTP Request Activity

Robot connectivity with Orchestrator is not required and it is required to authenticate the Orchestrator by making a HTTP POST request to the below API endpoint:

• [Orchestrator Url]/api/Account/Authenticate
  • Its response will return a token, which is stored in the "result" key of the JSON response
  • The above parameters need to be passed in the header, to make HTTP Post Request to Start Jobs API.

Example for the Orchestrator HTTP Request Activity:

1. Find the HTTP Request activity in Activities panel


2. In the Properties panel you should have these values in place:

Timeout (milliseconds): 10000

Endpoint: "https://ORCHESTRATOR_URL/api/Account/Authenticate"

Method: POST

Body:

@"{

" + "\n" +

@"""tenancyName"":""TENANT_NAME"",

" + "\n" +

@"""usernameOrEmailAddress"":""USERNAME"",

" + "\n" +

@"""password"":""PASSWORD""

" + "\n" +

@"}";

BodyFormat: application/json

Result (create a new variable): ResponseResults


3. Use the Deserialize JSON activity


In JsonString use ResponseResults variable

In JsonObject create a new variable AccessToken (it will have Type: Newtonsoft.Json.Linq.JObject)


4. Use the Assign activity to transform the Access token value to the expected String value in the Authorization header request.

Create a new variable AccessTokenString that is having this value "Bearer " + Convert.ToString(AccessToken.GetValue("result"))


5. Add a small delay to make sure the robot prepared already the AccessTokenString



6. Use a new HTTP Request activity that is having these values configured:

AccepptFormat: ANY

Endpoint: "https://laptop-8fj7qmnd/odata/ProcessSchedules"

Method: GET

BodyFormat: application/json

In Options -> Headers add two values:

• Authorization in String AccessTokenString
• X-UIPATH-OrganizationUnitId In String "7" (this is the folder id where the processes are located)


In Output -> Result create a new variable GetResults

7. Use the Deserialize JSON activity


JsonString: GetResults

JsonObject (create a new variable): GetResultsFromDeserialize


8. With For Each activity, extract the needed data

• TypeArgument: Newtonsoft.Json.Linq.JObject
• Values: GetResultsFromDeserialize.GetValue("value")


9. Log Message activity:

LogLevel: LogLevel.Info

Message: "Id: "+ Convert.ToString(item.GetValue("Id")) + ", Name: "+Convert.ToString(item.GetValue("Name")) + " ->StartProcessCronDetails: " +Convert.ToString(item.GetValue("StartProcessCronDetails"))

Results:


====

In the case when it is needed to check the @odata.count value of the JSON response, check by adding an extra Log Message activity in workflow with this Message:

"@odata.count: " + Convert.ToString(JsonObject.GetValue("@odata.count"))

Results:

[L_H]

Can you fix the screenshots on this? Most don’t seem to be available any longer. Thank you!

[marian.platonov]

Yes, I will fix them soon.

[marian.platonov]

@L_H please check https://uipath.my.salesforce-sites.com/CaseView/articles/Knowledge/How-To-Make-Orchestrator-API-Requests-Using-HTTP-Request-Activities-or-Orchestrator-HTTP-Request?lang=en_US

[L_H]

Thank you! I appreciate the help

[rmorgan]

Trying desperatly to follow your knowledge base instructions but stuck on the below

plus it says that it does not support post?

[marian.platonov]

You didn’t follow my article. For Cloud instance, you need to use client_credentials to obtain to the token, and also the URL is incorrect.

For UiPath Cloud Orchestrator the URL will be https://cloud.uipath.com/identity_/connect/token

Next time, read the full article.