REST APIにより、いくつかのメソッドまたはリクエストタイプが使用され、Talend Dictionaryサービスに保管されているデータとのやり取りが簡略化されます。
REST APIドキュメントページはすべて、Swaggerおよび実行リクエストに基づいてアクセスできます。JSONファイルは、REST APIドキュメンテーションのどのページからでもダウンロードできます。
始める前に
Talend Data StewardshipまたはTalend Data Preparationのインストール中にTalend Dictionaryサービスを正しくインストールし、設定している必要があります。
手順
-
ドキュメンテーションにアクセスするアプリケーションに応じて、インストールフォルダー(Talend Data StewardshipとTalend Data Preparationのいずれか)にあるモジュールをすべて開始します。
注: Talend Data PreparationからTalend Dictionaryサービス REST APIにアクセスするには、まず<Installation_Path>/dataprep/config/application.properties設定ファイルでservice.documenationパラメーターの値をtrueに設定する必要があります。
-
Webブラウザーを開いて、次のURLを入力します。
<host>と<port>はインストールに応じて異なります:
http://<host>:<port>/docs/api/swagger-ui.html
-
ページ上部のフィールドで[Semantic Service] (セマンティックサービス)を選択し、Talend Dictionaryサービスドキュメンテーションページを開きます。このページでは操作がさまざまなカテゴリーに分類されています。
例え
-
カテゴリー名をクリックすると、そのカテゴリーの下に操作リストが表示されます。
-
カテゴリーリストから次のように選択します。
| 以下を選択します |
内容 |
|---|
| [Show/Hide] (表示/非表示) |
オペレーションリストを表示、または非表示にします |
| [List Operations] (オペレーションのリスト表示) |
オペレーションリストを展開、または折りたたみます |
| [Expand Operations] (オペレーションの展開) |
操作の詳細を展開 |
-
の順にクリックし、クレデンシャルを使ってログインします。
[Response Headers] (レスポンスヘッダー)エリアにベアラーの認証情報が表示されます。
-
各種操作の実行テストを開始します。
実行した操作の結果を得るには、レスポンスからCurlコマンドを使用します。
ログイン時に取得したベアラートークンを認証ヘッダーの一部として含めます。
例え
curl -X GET --header 'Authorization: Bearer <token>' --header 'Accept: application/json' 'http://<host>:<port>/categories?caseSensitive=false&isExact=false'
