API access

概要

Data Fabric Open API allows you to manage UiPath^® Data Fabric 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.

UiPath^® Automation Cloud に外部アプリケーションを登録する方法について詳しくは、こちらをご覧ください。

API permissions

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

• Data Fabric.Schema.Read - this User Scope allows your external app to read your tenant's Data Fabric schema, and it's dependent on the user's permissions.
• Data Fabric.Data.Read - this User Scope allows your external app to read your tenant's Data Fabric data, and it's dependent on the user's permissions.
• Data Fabric.Data.Write - this User Scope allows your external app to edit your tenant's Data Fabric 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 Fabric.

Download the OpenAPI specification

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

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

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

Selecting Copy OpenAPI link copies the API endpoint that generates the tenant Data Fabric OpenAPI specification.

Authorizing the API calls

Authorize your external application to use the Data Fabric 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).

外部アプリケーションを認可する方法について詳しくは、こちらをご覧ください。

API endpoints

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

API の呼び出しを継続するには、アクセス トークンを新しく生成するか、更新トークンを要求する必要があります。

A Data Fabric API endpoint has the following syntax:

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

  
  

  

  
  

  Data Fabric entity example

  To describe each API request/response body, we are using the Olympics entity fields created in the Data Fabric. 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 Fabric API guide to dive into each endpoint and discover how you can put it to good use.