API アクセス

概要

Data Service OpenAPI を使用すると、選択した外部アプリケーションから UiPath^® Data Service のリソースを管理できます。そのため、OAuth 2.0 の認可フレームワークを使用して、資格情報を共有せずに外部アプリを認可できます。

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

API の権限

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

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

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 のユーザースコープのリソースにアクセスするには、次のいずれかの方法で外部アプリケーションを認可します。

認可コード (機密の外部アプリの場合)
PKCE の認可コード (非機密の外部アプリの場合)

API エンドポイント

OAuth2.0 認可フレームワークではアクセストークンを生成できます。このアクセストークンを使用すると、制限時間内 (1 時間) に外部アプリケーションが Data Service エンドポイントに REST API 呼び出しを実行できます。API の呼び出しを継続するには、アクセストークンを新しく生成するか、更新トークンを要求する必要があります。

Data Service API エンドポイントの構文は次のようになっています。

HTTP メソッド + ベース URL + リソースカテゴリ + Data Service エンティティ + 操作 + パス変数とクエリパラメーター

Data Service のエンティティの例

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

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