API アクセス

概要

Data Service Open API を使用すれば、お好きな外部アプリケーションから 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 OpenAPI を使用する外部アプリケーションを認可します。これには、外部アプリケーションの登録時に生成されたアプリ ID とアプリシークレットを使用します。認可の方法は、アプリケーションの種類 (機密または非機密) によって異なります。

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

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)。応答と要求の本文には、エンティティの構造を反映してエンティティのすべてのフィールドを含めます。

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