- 基本情報
- セットアップと構成
- Data Service を使用する
- 参照
- 例とチュートリアル

Automation Suite の Data Service ガイド
API アクセス
Data Service Open API を使用すれば、お好きな外部アプリケーションから UiPath Data Service のリソースを管理できます。また、OAuth 2.0 の認可フレームワークを使用して、資格情報を共有せずに外部アプリを認可できます。
UiPath Automation Suite に外部アプリケーションを登録する方法について詳しくは、こちらをご覧ください。
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 のユーザー ロールと権限について詳しくは、こちらをご覧ください。
外部アプリケーションにユーザー権限を設定したら、次はお使いのテナントの Data Service データの、OpenAPI 仕様をダウンロードします。この操作を行うには、テナントの [Data Service] タブの右上のメニュー > [API アクセス] > [OpenAPI ファイル (JSON) をダウンロード] に移動します。
外部アプリケーションに対してアクセス トークンを作成し、Data Service OpenAPI を使用する外部アプリケーションを認可します。これには、外部アプリケーションの登録時に生成されたアプリ ID とアプリ シークレットを使用します。認可の方法は、アプリケーションの種類 (機密または非機密) によって異なります。
外部アプリケーションを認可する方法について詳しくは、こちらをご覧ください。
OAuth2.0 認可フレームワークではアクセス トークンを生成できます。このアクセス トークンを使用すると、制限時間内 (1 時間) に外部アプリケーションが Data Service エンドポイントに REST API 呼び出しを実行できます。API の呼び出しを継続するには、アクセス トークンを新しく生成するか、更新トークンを要求する必要があります。
Data Service API エンドポイントの構文は次のようになっています。
-
HTTP メソッド + ベース URL + リソース カテゴリ + Data Service エンティティ + 操作 + パス変数とクエリ パラメーター
重要:Automation Suite でデプロイされた Data Service では、アクティブな接続 1 つあたりに設定できるアクティブなファイル アップロードの API 呼び出しは 1 つだけです。
この API の制限を回避するため、要求でConnection: close
ヘッダーを渡してください。Data Service のエンティティの例
各 API 要求/応答の本文について説明するために、ここでは Data Service で作成された「Olympics」エンティティ フィールドを例として使用します。汎用エンドポイント (Get Entity Records
など) を文書化する際は、エンドポイントにはエンティティの正確な名前を含めます (例:Get Olympics Records
)。応答と要求の本文には、エンティティの構造を反映してエンティティのすべてのフィールドを含めます。各エンドポイントについて詳しくは、それぞれのページをご覧ください。