Data Service ユーザーガイド

デリバリー:

最終更新日時 2025年5月26日

API アクセス

概要

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

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 呼び出しを実行できます。

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

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

Data Service のエンティティの例

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

さらに、『Data Service API ガイド』で各エンドポイントについて詳しく説明し、その活用方法についても説明します。

外部アプリケーションを使用して Data Service のリソースにアクセスする

外部アプリのきめ細かいアクセス権を設定する

外部アプリは、ユーザーを偽装するのではなく、自身のクライアント資格情報を使用して Data Service のリソースにアクセスします。

外部アプリケーションがエンティティ内でアクションを実行する場合、Data Service は、対応するリソースにアクセスするために必要な権限がアプリにあるかどうかを確認します。認証に関与するユーザーはいないため、リソースを要求するとアクセストークンが生成され、アプリがテナントレベルとエンティティレベルで割り当てているかどうかを検証することができます。検証に成功することによってのみ、外部アプリケーションは、権限が付与されているリソースにアクセスできるようになります。

外部アプリを作成する

管理者として外部アプリを作成し、Data Service のリソースにアクセスできるように設定します。

組織で、[ 管理] > [外部アプリケーション] に移動します。[ 外部アプリケーション ] ページが表示されます。
[ Add Application] をクリックします。
1. 外部アプリの名前を指定します。
2. 外部アプリの種類を選択します。
3. [ 追加] をクリックします。外部アプリが [外部アプリケーション ] リストに表示されます。

dataService.default スコープについての説明カスタムの Data Service ロールが割り当てられている機密アプリケーションの場合は、 DataService.Default スコープを要求する必要があります。このスコープでは、アクセストークンを使用して、アプリがテナントレベルとエンティティレベルで割り当てているかどうかを確認します。検証に成功した後にのみ、外部アプリケーションは、アクセス権が付与されたリソースにアクセスできます。

外部アプリをテナントに追加する

Data Service の管理者は、以下の手順に従い、選択したテナント内のすべてのエンティティへのアクセス権を外部アプリに付与します。

Data Service インスタンスで [ アクセス権を管理] ページに移動します。
[ アクセス権を管理 ] ページで [ ロールを割り当て ] ボタンをクリックします。
[ ロールを割り当て] パネルで、以下の手順を実行します。
1. [ 名前を追加] フィールドに外部アプリの名前を入力し、リストから選択します。
2. [ ロールを選択] リストから、以前に作成したカスタムロールと Data Reader ロールを選択します。外部アプリに割り当てる他のロールを選択することもできますが、 データ閲覧者は 必須の選択です。
3. [ 保存] をクリックします。[ ロールを割り当て ] タブのリストに、外部アプリが表示されます。

外部アプリをエンティティに追加する

Data Service の管理者は、特定のエンティティに対する外部アプリのアクセス権を管理するには、以下の手順に従います。

Data Service インスタンスで [ アクセス権を管理] ページに移動します。
[ アクセス権を管理 ] ページで [ ロールを作成 ] ボタンをクリックします。
[ロールを作成] パネルで、以下の手順を実行します。
1. カスタムロールの名前を指定します。
2. 必要な管理権限を割り当てます。
3. [ データアクセス権限 ] セクションで [ エンティティを追加] をクリックして目的のエンティティを選択し、そのエンティティ内で外部アプリが持つことができる権限を選択します。
4. [ 保存] をクリックします。外部アプリのカスタムロールが [ ロール ] タブのリストに表示されます。