UiPath Activities

The UiPath Activities Guide

Orchestrator HTTP Request

🚧

This activity is available starting with v2018.1.

UiPath.Core.Activities.OrchestratorHttpRequest

Performs HTTP requests to the Orchestrator API by authenticating under the Robot it is executed on. You can use the GET, POST, PUT, PATCH and DELETE verbs to extract data or manipulate it, and send specific information through JSON. Please note that for each request you might need different rights on the Orchestrator Robot role, depending on what requests you are doing, and the Robot has to be connected to Orchestrator. For example, to run PUT requests on organization units, you need View, Create, and Edit permissions. The activity runs under the Robot which executes it.

Properties

Common

  • ContinueOnError - Specifies if the automation should continue even when the activity throws an error. This field only supports Boolean values (true, false). The default value is false. As a result, if the field is blank and an error is thrown, the execution of the project stops. If the value is set to true, the execution of the project continues regardless of any error.
  • DisplayName - The display name of the activity.
  • TimeoutMS - Specifies the amount of time (in milliseconds) to wait for the activity to run before an error is thrown. The default value is 30000 milliseconds (30 seconds).

Input

  • JSONPayload - The information you want to send to the indicated Orchestrator endpoint, in a JSON format. The JSON must not be indented. This field supports only strings, string variables or string expressions.
  • Method - The request method to be used when calling the Orchestrator API. The following HTTP verbs are supported: GET, POST, PUT, PATCH and DELETE. By default, the GET verb is selected.
  • RelativeEndpoint - The endpoint at which to make requests, relative to your base Orchestrator URL.

Misc

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

Output

  • JSONResponse - The JSON returned by the HTTP request, as a string variable.
  • StatusCode - The status code returned by the HTTP request, as an integer variable.

For example, the request in the following screenshot enables you to create a new organization unit, Documentation, on the Orchestrator your Robot is connected to. The JSON response and status code are saved as variables.

Updated 2 months ago


Orchestrator HTTP Request


Suggested Edits are limited on API Reference Pages

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