ExamFinch.com My Study

Study guide

21.3 HTTP Requests: Web APIs, the Orchestrator API & Connector Requests

Practice this exam

UiPath Automation Developer Professional UiPath-ADPv1

Track your progress as you read

Finished sections get a check mark.

1 Chapter 1: Exam Overview & Blueprint Map

1.1 About the UiPath-ADPv1 Exam: Format, Fees & Policies 1.2 The Exam Topics Mapped to This Guide & a Study Plan

2 Chapter 2: REFramework Architecture & State Dynamics

2.1 State Machine Architecture & The Four Core States 2.2 Configuration Management: Settings, Constants, and Assets 2.3 Transaction Types & The Dispatcher vs. Performer Architecture 2.4 Adapting REFramework: Tabular Data, Collections & Linear Processes

3 Chapter 3: REFramework Exception Handling & Recovery

3.1 BusinessRuleException vs. System.Exception Handling Patterns 3.2 Retry Mechanisms: Queue Retries vs. REFramework MaxRetryNumber 3.3 Consecutive System Exceptions & Graceful Process Termination

4 Chapter 4: State Machines, Custom Log Fields & REFramework Testing

4.1 Building State Machine Projects in Studio 4.2 Logging Levels, Robot Logs & Custom Log Fields in REFramework 4.3 Testing a REFramework Project With and Without Orchestrator Queues

5 Chapter 5: LINQ Queries & DataTable Operations

5.1 LINQ Essentials for Collections & Filtering 5.2 Advanced DataTable Querying with LINQ 5.3 In-Memory DataTable Transformations & Column Operations

6 Chapter 6: Regex, DateTime, JSON & Invoke Activities

6.1 Regular Expressions & Text Parsing for Automation 6.2 DateTime Formatting, Timezone Conversions & TimeSpan Calculations 6.3 JSON Parsing, JSONPath & Serialization with Newtonsoft.Json 6.4 Invoke Method & Invoke Code Activities 6.5 Data Referencing in Invokes: DataTable, List & Dictionary Arguments

7 Chapter 7: Modern UI Automation & Unified Targeting

7.1 Modern Design Experience & The Unified Target Concept 7.2 Anchors, Relative Elements & UI Automation Activities 7.3 Dynamic Selectors, Variables & Wildcards in Selectors

8 Chapter 8: Object Repository, Computer Vision & Remote Runtime

8.1 Object Repository & UI Descriptor Libraries 8.2 AI Computer Vision for Unattended & Remote Interfaces 8.3 Automation in Virtual Environments & UiPath Remote Runtime

9 Chapter 9: Advanced UI Automation: Browser Modes, Agentic UI & macOS

9.1 Browser Automation with the WebDriver Protocol 9.2 Agentic UI Automation: ScreenPlay, Semantic Activities & Healing Agent 9.3 macOS Automation: Native Apps, Office Apps & AppleScript

10 Chapter 10: Advanced Control Flow & Exception Architecture

10.1 Flowcharts, Sequences & Parallel Control Flow Patterns 10.2 Global Exception Handler Architecture & ErrorAction Directives 10.3 TryCatch, Retry Scope & Custom Exception Architectures

11 Chapter 11: Orchestrator Queues & Transaction Management

11.1 Queue Architecture, SpecificContent & Transaction Lifecycles 11.2 Queue Items SLA, Postpone, Deadlines & Priority Scheduling 11.3 Bulk Operations, Transaction Status Updates & Queue Triggers

12 Chapter 12: Orchestrator Tenant & Folder Entities

12.1 Asset Types, Per-Robot Assets & External Credential Stores 12.2 Modern Folder Hierarchy, User/Robot Assignment & Permissions 12.3 Storage Buckets, Webhooks & Environment Promotion 12.4 Orchestrator Tags: Labels, Properties & Governance

13 Chapter 13: Unattended Execution, API Triggers & Cloud Robots

13.1 Unattended Job Execution: Folders, Priorities, Background vs. Foreground & Runtimes 13.2 API Triggers: Starting Jobs from External Systems over HTTP 13.3 Serverless and Cloud VM Robots: Cloud-Hosted Execution Options

14 Chapter 14: Monitoring, Recording & Solutions Management

14.1 Orchestrator Monitoring, Trigger Alerts & Job Health 14.2 Job and Transaction Recording: Troubleshooting Faulted Unattended Jobs 14.3 Solutions Management: Packaging and Deploying Automations with Their Resources

15 Chapter 15: Debugging, Remote Debugging & Profiling

15.1 Studio Debugging Tools: Breakpoints, Panels & Execution Control 15.2 Remote Debugging: Remote Machine and Unattended Robot Connections 15.3 Profile Execution: Finding Performance Bottlenecks in Studio

16 Chapter 16: RPA Testing & Test Suite

16.1 UiPath Test Suite Overview, Test Cases & Given-When-Then Structure 16.2 Data-Driven Testing, Test Verification Activities & Mock Activities 16.3 CI/CD Pipelines with uipcli & Test Manager Traceability

17 Chapter 17: Long-Running Workflows, Action Center & Apps

17.1 Long-Running Workflows: Persistence, Suspend and Resume 17.2 Action Center & Human-in-the-Loop Orchestration 17.3 UiPath Apps: Action Apps, Automations & Integration Service

18 Chapter 18: Trigger-Based Attended Automation & Callouts

18.1 Trigger-Based Attended Automation: Forms, Triggers & Global Variables 18.2 Running Local Triggers & the Event Inspection Tool 18.3 Callouts & Forms for Attended Guidance

19 Chapter 19: UiPath Assistant & Robot Sessions

19.1 UiPath Assistant: Automations, Reminders, Widgets & Configuration 19.2 Robot Session (Picture in Picture): Child Session vs. Virtual Desktop

20 Chapter 20: Autopilot for Developers & Autopilot for Everyone

20.1 Autopilot for Developers: AI Assistance in Studio and Studio Web 20.2 Autopilot for Everyone: Chat, Automations & Clipboard AI

21 Chapter 21: API Automation & Integration Service

21.1 Integration Service: Connectors, Connections & Connector Activities 21.2 API Workflows in Studio Web 21.3 HTTP Requests: Web APIs, the Orchestrator API & Connector Requests 21.4 Connector Builder: Custom Integration Service Connectors 21.5 Integration Service Event Triggers: Connected and Disconnected 21.6 GenAI Activities: Generative AI Inside Workflows

22 Chapter 22: Data Service, Context Grounding & Coded Workflows

22.1 Data Fabric (Data Service) Entities: Modeling Business Data 22.2 Data Fabric Activities and the Platform Connector 22.3 Context Grounding: Retrieval-Augmented Generation with Company Data 22.4 Coded Automations: Structure, Arguments & Invoking Workflows 22.5 Coded Automation Services: Orchestrator, UI Automation, Microsoft 365 & Custom Services

23 Chapter 23: Integrated Scenario Practice

23.1 Integrated Scenario Practice: Designing an End-to-End Solution

21.3 HTTP Requests: Web APIs, the Orchestrator API & Connector Requests

Key Takeaways Explain This Topic AI

The WebAPI HTTP Request calls any API with configured authentication; the legacy version has a cURL import wizard, many methods, and a 6-second default timeout.

Orchestrator HTTP Request calls the Orchestrator API as the robot, with GET, POST, PUT, PATCH, or DELETE, a relative endpoint, and a non-indented JSON payload.

Its outputs are Headers, JSON Response, and Status Code, and permissions depend on the endpoint called.

Connector HTTP Request activities reuse an Integration Service connection's authentication for endpoints without dedicated activities.

Check the status code before parsing, and keep API keys in Credential or Secret assets.

Last updated: September 2026

21.3 HTTP Requests: Web APIs, the Orchestrator API & Connector Requests

Core Concept: The exam description lists "REST API and Orchestrator HTTP Request" and "HTTP Request for IS connectors". UiPath offers several ways to call APIs, and each handles authentication differently. Choosing the right one is the key skill.

Three Ways to Send HTTP Requests

  • Activity Calls Authentication
  • HTTP Request (WebAPI package) Any web API You configure it (none, basic, OAuth tokens, client certificates)

Orchestrator HTTP Request (System activities) The Orchestrator API of the robot's tenant Automatically as the robot running the job

HTTP Request inside an Integration Service connector The connector's application API The connection's authentication

The HTTP Request Activity (WebAPI)

The WebAPI package's HTTP Request activity calls any REST endpoint. WebAPI 2.0 introduced an improved HTTP Request; the earlier version is now labeled HTTP Request (legacy) . The legacy activity illustrates the settings you meet in any version:

A wizard to build and preview requests, and an import option for requests in cURL format.

Methods: GET, POST, PUT, DELETE, HEAD, OPTIONS, PATCH, and MERGE.

Authentication: None, Simple HTTP (username and password), OAuth1, or OAuth2 (an access token, usually obtained from another request).

Parameters: query or form parameters, headers, and URL segments written as {id} in the endpoint.

Client certificates (.pfx or .p12) and SSL certificate verification.

Timeout: 6,000 ms (6 seconds) by default in the legacy activity.

Outputs: the response body, headers, and status code . A status code of 0 means the server returned no response, which usually points to connectivity problems.

Working with JSON responses

Use Deserialize JSON to turn the response string into a JObject , then read values such as jObj("customer")("id").ToString . For arrays, use Deserialize JSON Array . Always check the status code before parsing.

The Orchestrator HTTP Request Activity

Orchestrator HTTP Request calls the Orchestrator API authenticated as the robot that runs it, so there are no tokens to manage.

  • Setting Meaning
  • Method GET (default), POST, PUT, PATCH, or DELETE
  • Relative Endpoint The path relative to the Orchestrator URL, for example /odata/Jobs
  • JSON Payload The request body as non-indented JSON
  • Folder Path The folder to act in, if different from the job's folder
  • Timeout Default 300,000 ms (5 minutes); opening the connection is limited to 30 seconds
  • Outputs Headers, JSON Response (string), and Status Code (integer)

Permissions depend on the endpoint. The robot account needs the Orchestrator permissions the endpoint requires, for example Assets View for /odata/Assets and Jobs View for /odata/Jobs , plus Folders View to use the Folder Path field.

Typical uses: reading queue statistics, starting another process's job, or updating an asset from a workflow when no dedicated activity exists.

HTTP Requests Through Connectors

Integration Service connectors offer an HTTP Request activity for endpoints that have no dedicated activity. It reuses the connection , so authentication, token refresh, and base URL are handled for you. In API workflows , the HTTP activity can likewise use connector-based authentication instead of manual credentials.

The UiPath Orchestrator connector also includes a UiPath Orchestrator HTTP Request activity, alongside activities such as Get Asset, Get Queue Items, and Run Job.

Choosing the Right Tool

  • Scenario Choose
  • Read jobs or queue data from the robot's own Orchestrator Orchestrator HTTP Request

Call an endpoint of Salesforce that has no activity, with an existing connection The Salesforce connector's HTTP Request

Call a partner's REST API that has no connector, with an API key WebAPI HTTP Request with the key in a header, stored in a Credential or Secret asset

  • Call many APIs quickly without a robot An API workflow
  • Repeatedly use a REST API without a connector across many projects Build a connector with Connector Builder
  • Worked Example: Checking Queue Backlog

A dispatcher should only add new items if the queue has fewer than 5,000 New items.

Orchestrator HTTP Request with Method GET and a relative endpoint that filters the queue's items by status New and returns the count.

Check that Status Code is 200.

Deserialize JSON on the JSON Response and read the count.

If the count is below 5,000, continue with Bulk Add Queue Items ; otherwise, log a warning and end.

The robot account needs the queue permissions required by the endpoint in that folder, for example Queues View and Transactions View .

Common Traps

Storing API keys in workflow code instead of Credential or Secret assets.

Forgetting that Orchestrator HTTP Request permissions come from the robot's role.

Parsing a response without checking the status code .

Sending an indented JSON payload to Orchestrator HTTP Request.