UiPath Orchestrator icon

UiPath Orchestrator

Interact with UiPath Orchestrator API

Actions148

Custom API Call → Make Custom API Request

AI-generated

Summary

Send a custom HTTP request to a UiPath Orchestrator API endpoint with specified method, path, query parameters, headers, and optional JSON body; return the response body or full response including headers and status code if requested.

Inputs

  • HTTP Method (required) — The HTTP method to use for the request (GET, POST, PUT, PATCH, DELETE).
  • Endpoint Path (required) — The API endpoint path to call (e.g., /odata/YourCustomEndpoint). Do not include the base URL.
  • Query Parameters — Optional query parameters to append to the URL, which can be specified either as UI name-value pairs or as a JSON object (JSON input overrides UI input).
  • Request Body — A JSON-formatted request body, required only for POST, PUT, or PATCH methods.
  • Headers — Custom headers to include in the request, specified as UI name-value pairs or as JSON (JSON input overrides UI input).
  • Options — Additional options: 'Full Response' to return complete HTTP response including headers and status code, and 'Unwrap OData Response' to automatically extract the .value property from OData responses (enabled by default).

Output shape

The parsed JSON response body by default, or the full HTTP response object including headers and status code if 'Full Response' option is enabled.

'Unwrap OData Response' option extracts the .value field from responses to simplify handling OData-formatted data. If both UI and JSON inputs are provided for query parameters or headers, JSON inputs take precedence.

Examples

Example 1: Make a GET request to /odata/CustomEntity with $filter query parameter and unwrap OData response

Set HTTP Method to GET, Endpoint Path to '/odata/CustomEntity', Query Parameters JSON to '{"$filter": "Status eq 'Successful'"}', Options with Unwrap OData Response enabled.

Example 2: Send a POST request with custom headers and JSON body

Set HTTP Method to POST, Endpoint Path to '/api/CustomEndpoint', provide Headers JSON with custom header values, and Request Body as JSON for the required payload.

Links

Discussion