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) をダウンロード] に移動します。

This will get you the OpenAPI 3.0 specifications of your tenant's Data Service entities, in JSON format. Clicking **Copy OpenAPI link** copies the API endpoint that generates the tenant's Data Service OpenAPI specification.

API 呼び出しを認証する

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

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

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 メソッド + ベース URL + リソース カテゴリ + Data Service エンティティ + 操作 + パス変数とクエリ パラメーター

  

  重要:

  In the Automation Suite-deployed Data Service, each active connection can have only one active file upload API call.

  この API の制限を回避するため、要求で Connection: close ヘッダーを渡してください。

  Data Service のエンティティの例

  各 API 要求/応答の本文について説明するために、ここでは Data Service で作成された「Olympics」エンティティ フィールドを例として使用します。汎用エンドポイント (Get Entity Records など) を文書化する際は、エンドポイントにはエンティティの正確な名前を含めます (例: Get Olympics Records)。応答と要求の本文には、エンティティの構造を反映してエンティティのすべてのフィールドを含めます。

  

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