新しいREST 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

手順

  1. Integrationパースペクティブの[Repository] (リポジトリー)ツリービューで、[Metadata] (メタデータ)ノードの下にある[REST API Definitions] (REST API定義)ノードを右クリックし、コンテキストメニューから[Create API definition] (API定義の作成)を選択します。
    [Import API definition] (API定義のインポート)ウィザードが開きます。
  2. [Import from file] (ファイルからインポート)を選択し、ローカルのREST APIファイルに移動します。
    APIの自動検証が実行されます。ファイルが有効な場合は、[Next] (次へ)ボタンと[Finish] (終了)ボタンが有効になります。検証に失敗すると、次へ進むことができません。ただし、検証で警告のみが表示された場合は、このダイアログに表示されるリンクを使用して警告の内容を確認し、警告に従って次へ進んでよいかどうかを判断して下さい。ほとんどのユースケースでは警告は該当せず、注意を払う必要のある情報を示しているだけあり、ダイアログから[Next] (次へ)[Finish] (終了)のアクションへ進むことができます。
  3. [Next] (次へ)をクリックして、APIのコンテンツが自動的に入力されるAPI定義のプロパティを表示します。

    フィールド

    説明

    [Name] (名前)

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

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

    [Purpose] (目的)

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

    [Description] (説明)

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

    [Author] (作成者)

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

    [Locker] (ロック保持者)

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

    [Version] (バージョン)

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

    Status (ステータス)

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

    [Path] (パス)

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

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