API Access

Overview

Data Service Open API allows you to manage UiPath^® Data Service resources from an external application of your choice, and does so by enabling you to authorize the external app without sharing any credentials, through the Oauth 2.0 authorization framework.

Learn how to register the external application in UiPath^® Automation Cloud.

API Permissions

To use the Data Service OpenAPI, you must grant API permissions to the external application. These API permissions are known as scopes, and there are three types for Data Service:

DataService.Schema.Read - this User Scope allows your external app to read your tenant's Data Service schema, and it's dependent on the user's permissions.
DataService.Data.Read - this User Scope allows your external app to read your tenant's Data Service data, and it's dependent on the user's permissions.
DataService.Data.Write - this User Scope allows your external app to edit your tenant's Data Service data by deleting, updating or creating new data, and it's dependent on the user's permissions.

Learn more about the user roles and permissions in Data Service.

Download the OpenAPI Specification

Once you set the permissions for your external application and users, download the OpenAPI specification of your tenant Data Service data:

On the Data Service page, click API Access, then select Download OpenAPI file (JSON).

This operation downloads the OpenAPI 3.0 specifications of your tenant Data Service entities, in JSON format.

Clicking Copy OpenAPI link copies the API endpoint that generates the tenant Data Service OpenAPI specification.

Authorizing the API Calls

Authorize your external application to use the Data Service OpenAPI by creating an access token for your external application. Use the App ID and App Secret that were generated at the external application registration. The authorization method depends on the application's type (confidential or non-confidential).

Learn more about the authorization methods for external apps.

API Endpoints

OAuth2.0 authorization framework helps you generate a access token that allows your external application to make REST API calls to Data Service endpoints, for a limited time (one hour).

To continue calling the APIs you need to generate a new access token or request a refresh token.

A Data Service API endpoint has the following syntax:

HTTP method + BaseURL + The resource category + The Data Service entity + The Operation + Path variables and query parameters

Data Service Entity Example

To describe each API request/response body, we are using the Olympics entity fields created in the Data Service. While we document the generic endpoint, such as Get Entity Records, your endpoint contains the exact name of your entity (for example, Get Olympics Records). The response and request bodies include all the fields from your entity, replicating the entity's structure.

Further, let's use the Data Service API guide to dive into each endpoint and discover how you can put it to good use.