API アクセス

概要

データファブリック Open API では、Oauth 2.0 の認可フレームワークを使用して、資格情報を共有せずに外部アプリを認可できるようにし、選択した外部アプリケーションから UiPath^® Data Fabric のリソースを管理できます。

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

API の権限

Data Fabric OpenAPI を使用するには、外部アプリケーションへの API アクセス許可を付与する必要があります。これらの API アクセス許可はスコープと呼ばれ、 Data Fabric には次の 3 つのタイプがあります。

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

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

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

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

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

この操作により、テナント データ ファブリック エンティティの OpenAPI 3.0 仕様が JSON 形式でダウンロードされます。

[ OpenAPI リンクをコピー ] を選択すると、テナントのデータ ファブリック OpenAPI 仕様を生成する API エンドポイントがコピーされます。

API 呼び出しを認証する

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

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

API エンドポイント

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

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

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

• HTTP メソッド + ベース URL + リソース カテゴリ + データ ファブリック エンティティ + 操作 + パス変数とクエリ パラメーター

  
  

  

  
  

  データ・ファブリック ・エンティティの例

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

  さらに、Data Fabric API ガイドを使用して、各エンドポイントを詳しく説明し、それを有効に活用する方法を探ってみましょう。