Orchestrator
2022.10
false
Banner background image
Orchestrator API Guide
Last updated May 21, 2024

Read Me

Important:

We plan to upgrade the Orchestrator Swagger version to Swagger 3.0 (currently, Orchestrator APIs are defined using Swagger 2.0).

Do not worry about backwards compatibility with your existing API clients: we will ensure the API remains compatible.

We recommend using your previous clients, as JSON changes do not alter them, thanks to our request structure backwards compatibility.

Important: After the Swagger 3.0 update, all regenerated API clients based on the new JSON definition will imply major adjustments.

If you plan on integrating our APIs with your client, you need to be aware of the possible updates and changes that may happen to the Swagger definition, JSON schemas, or API endpoints.

The below list provides information and recommendations regarding Swagger changes. If you have further questions, contact our support team.

Information and Recommendations About Swagger Changes

  1. The JSON API description represented in the Swagger JSON document can change at any time. However, it will describe the same underlying API, to ensure backwards compatibility.
  2. The Swagger interface and the corresponding JSON are generated based on the current endpoints, and we always publish the latest version. To ensure backwards compatibility, we support the same request structure.
  3. As an alternative to runtime generated API clients, use fixed or compile time API clients. Doing so reduces dependency and prevents major automation updates in case the API or Swagger definition changes.
  4. Items marked as deprecated are available for a limited time, after which the items are removed from the Swagger definition and JSON API.
  5. Whenever certain APIs changes internally, a new Swagger API version is published. The API version number does not influence the usage of the client API. We do not recommend relying on API versioning.

API Examples

The examples provided in the existing Orchestrator reference document describe complex scenarios and endpoints.

You can see all available APIs in the Swagger JSON, which contains the latest updates.

See how to access the Orchestrator Swagger, depending on the Orchestrator deployment mode.

  • Information and Recommendations About Swagger Changes
  • API Examples

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.