新しいREST APIメタデータをAPIデザイナーから作成する - Cloud

Talend Cloud Real-Time Big Data Platform Studioユーザーガイド

author
Talend Documentation Team
EnrichVersion
Cloud
EnrichProdName
Talend Cloud
task
ジョブデザインと開発
EnrichPlatform
Talend Management Console
Talend Studio

始める前に

  • Talend CloudサブスクリプションでTalend Cloud API DesignerTalend Cloud API Testerの使用が許可されていること、およびStudioへの接続に使用するユーザーに、アカウント内でそれらのモジュールを使用する正しい権限(ロール)があることを確認します。
  • [Talend] > [Talend Cloud]ビューの[Preferences] (環境設定)ダイアログボックスからTalend Cloudへの接続が設定されていること。Studioの環境設定を定義する方法は、Talend Studioの環境設定を参照して下さい。

手順

  1. Integrationパースペクティブの[Repository] (リポジトリー)ツリービューで、[Metadata] (メタデータ)ノードの下にある[REST API Definitions] (REST API定義)ノードを右クリックし、コンテキストメニューから[Create API definition] (API定義の作成)を選択します。
    [Import API definition] (API定義のインポート)ウィザードが開きます。
  2. [Import from API designer] (APIデザイナーからインポート)を選択します。Talend Cloud API Designer内に所有するAPI定義(オーナーはTalend Cloud Preferencesで使用するユーザーと同じです)および、Talend Cloud API Designerでこのユーザーと共有されているすべてのAPI定義が表示されます。
    このダイアログが空のままなら、共有されているAPI定義を所有していないか、またはアクセス権がない可能性があります。その場合は、Talend Cloud API Designerを確認して下さい。
  3. リストからインポートするAPIを選択し、[Next] (次へ)をクリックします。
  4. [Next] (次へ)をクリックして、APIのコンテンツが自動的に入力されるAPI定義のプロパティを表示します。

    フィールド

    説明

    [Name] (名前)

    API定義の名前。このフィールドは編集可能です。

    禁止文字を入力すると、メッセージが表示されます。

    [Purpose] (目的)

    目的、またはAPI定義に関する有用な情報。このフィールドは編集可能です。

    [Description] (説明)

    処理内容や動作の仕組みのわかりやすい情報が含まれるAPI定義の説明。このフィールドは編集可能です。

    [Author] (作成者)

    デフォルトで現在のユーザーログインを表示する読み取り専用フィールド。

    [Locker] (ロック保持者)

    デフォルトで現在のジョブのロックを保持しているユーザーがログインしていることを示す読み取り専用フィールド。このフィールドはAPIを作成する時は空で、既存のAPIのプロパティを編集する時のみデータが存在します。

    [Version] (バージョン)

    読み取り専用のフィールド。[M]および[m]ボタンを使用して、手動でバージョンを高くすることができます。

    Status (ステータス)

    作成中のジョブのステータスから選択するリスト。

    [Path] (パス)

    API定義が作成されるフォルダーから選択するリスト。

  5. [Finish] (終了)をクリックし、作成を確定してウィザードを閉じます。
    作成したAPI定義は、[Repository] (リポジトリー)ツリービューの[Metadata] (メタデータ) > [REST API Definitions] (REST API定義)ノードの下にリスト表示されています。
    コンテキストメニューから、以下のことができます。
    • [Open in API Designer] (APIデザイナー内に開く): 外部のWebページを開き、APIデザイナー内にAPI定義を表示する。
    • [Open API documentation] (APIドキュメンテーションを開く): 外部のWebページを開き、APIのドキュメンテーションを表示する。
    • [Open in API Tester] (APIテスター内に開く): APIテスターをローカルに外部のWebブラウザ上に開く。
    • [Edit API definition] (API定義の編集): API定義のプロパティを編集する。
    • [Update API definition] (API定義の更新): 更新を使用して、API定義の新バージョン/更新バージョンを取得する。