API アクセス

概要

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

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

API の権限

Data Fabric / Data Service OpenAPI を使用するには、外部アプリケーションに API 権限を付与する必要があります。これらの API 権限はスコープと呼ばれ、Data Fabric と Data Service には次の 3 種類があります。

• Data Fabric / Data Service.Schema.Read - この ユーザー スコープ は、外部アプリがテナントの Data Fabric / Data Service のスキーマを読み取ることができます。これはユーザーの権限によって異なります。
• Data Fabric / Data Service.Data.Read - この ユーザー スコープ では、外部アプリがテナントの Data Fabric / Data Service のデータを読み取ることができます。このデータはユーザーの権限によって異なります。
• Data Fabric / Data Service.Data.Write - この ユーザー スコープ では、外部アプリがテナントの Data Fabric / Data Service のデータを削除、更新、または作成して編集できます。これはユーザーの権限によって異なります。

Data Fabric / Data Service の ユーザー ロールと権限 について詳しくは、こちらをご覧ください。

OpenAPI 仕様をダウンロードする

外部アプリケーションとユーザーの権限を設定したら、テナントの Data Fabric/Data Service データの OpenAPI 仕様をダウンロードします。

• [Data Fabric/Data Service] ページで [ API アクセス] を選択し、[ OpenAPI ファイル (JSON) をダウンロード] を選択します。

この操作により、テナントの Data Fabric/Data Service エンティティの OpenAPI 3.0 仕様が JSON 形式でダウンロードされます。

[ OpenAPI リンクをコピー ] を選択すると、テナントの Data Fabric / Data Service OpenAPI 仕様を生成する、API エンドポイントがコピーされます。

API 呼び出しを認証する

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

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

API エンドポイント

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

API の呼び出しを継続するには、アクセス トークンを新しく生成するか、更新トークンを要求する必要があります。

Data Fabric/Data Service API エンドポイントの構文は次のとおりです。

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

  

Data Fabric/Data Service のエンティティの例

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

さらに、『 Data Fabric / Data Service API ガイド』を使用して各エンドポイントを詳しく確認 し、その有効活用方法を見つけましょう。