通知を受け取る

UiPath Data Service

UiPath Data Service ガイド

API アクセス

概要


Data Service Open API を使用すれば、お好きな外部アプリケーションから UiPath Data Service のリソースを管理できます。また、OAuth 2.0 の認可フレームワークを使用して、資格情報を共有せずに外部アプリを認可できます。

Learn how to register the external application in UiPath Automation Suite.

API の権限


Data Service OpenAPI を使用するには、外部アプリケーションに API のアクセス許可を付与する必要があります。このような API アクセス許可は「スコープ」とも呼ばれます。Data Service には次の 3 種類のスコープがあります。

  • DataService.Schema.Read - このユーザー スコープでは、外部アプリがテナントの Data Service のスキーマを読み取ることができます。スコープはユーザーの権限に依存します。
  • DataService.Data.Read - このユーザー スコープでは、外部アプリがテナントの Data Service のデータを読み取ることができます。スコープはユーザーの権限に依存します。
  • DataService.Data.Write - このユーザー スコープでは、外部アプリがテナントの Data Service のデータを編集 (削除、更新、新規作成) できます。スコープはユーザーの権限に依存します。

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

OpenAPI 仕様をダウンロードする


外部アプリケーションにユーザー権限を設定したら、次はお使いのテナントの Data Service データの、OpenAPI 仕様をダウンロードします。この操作を行うには、テナントの [Data Service] タブの右上のメニュー > [API アクセス] > [OpenAPI ファイル (JSON) をダウンロード] に移動します。

ここをクリックすると、テナントの Data Service エンティティの OpenAPI 3.0 仕様が JSON 形式で取得されます。[OpenAPI リンクをコピー] をクリックすると、テナントの Data Service OpenAPI 仕様を生成する、API エンドポイントがコピーされます。

API 呼び出しを認証する


外部アプリケーションに対してアクセス トークンを作成し、Data Service OpenAPI を使用する外部アプリケーションを認可します。これには、外部アプリケーションの登録時に生成されたアプリ IDアプリ シークレットを使用します。認可の方法は、アプリケーションの種類 (機密または非機密) によって異なります。

Learn more about the authorization methods for external apps.

API エンドポイント


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.

Data Service API エンドポイントの構文は次のようになっています。
HTTP method + BaseURL + The resource category + The Data Service entity + The Operation + Path variables and query parameters

25652565

🚧

API 経由でのファイル アップロードの接続制限

Automation Suite でデプロイされた Data Service では、アクティブな接続 1 つあたりに設定できるアクティブなファイル アップロードの API 呼び出しは 1 つだけです。
To prevent running into this API limitation, make sure to pass the Connection: close header in your request.

Data Service のエンティティの例


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.

16011601

各エンドポイントについて詳しくは、それぞれのページをご覧ください。

5 か月前に更新


API アクセス


改善の提案は、API リファレンスのページでは制限されています

改善を提案できるのは Markdown の本文コンテンツのみであり、API 仕様に行うことはできません。