RESTタスクの作成

データ統合のRESTタスクでは、HTTPプロトコルを使用してREST APIエンドポイントをコールできます。

プロジェクトまたはフォルダにRESTタスクを作成します。データ統合には、開始時に1つのデフォルト・プロジェクトが含まれています。独自のプロジェクトまたはフォルダを作成するには、プロジェクトおよびフォルダを参照してください。

デフォルトでは、データ統合では、特定の時間にタスクの同時またはパラレル・タスクを実行できます。手動で開始された同時タスク実行を禁止するには、タスクの作成時に「タスクの同時実行の無効化」チェック・ボックスを選択します。同時タスク実行が許可されていない場合、非端末状態の進行中のタスク実行がすでにあると、タスクの実行リクエストは失敗します。

  • 構成UIには、タスクのREST APIおよび認証の詳細を指定し、タスクの範囲にオプションのパラメータ値を指定し、エラーおよび警告がないかチェックする4つのセクションがあります。

    次の手順の各セクションのステップは、RESTタスクの編集時にも使用できます。

    1. タスクを作成するプロジェクトまたはフォルダを開きます。

      プロジェクトまたはフォルダの詳細ページを開くステップは、「プロジェクトの詳細の表示」または「フォルダの詳細の表示」を参照してください。

    2. プロジェクトまたはフォルダの詳細ページで、「タスク」をクリックします。
    3. 「タスク」セクションで、「タスクの作成」をクリックし、「REST」を選択します。
    4. 「RESTタスクの作成」ページで、名前とオプションの説明を入力します

      識別子は、名前に基づいてシステム生成の値です。値を変更できますが、タスクを作成して保存した後は識別子を更新できません。

    5. このタスクの同時実行を禁止する場合は、「タスクの同時実行を無効化」チェック・ボックスを選択します。
    6. (オプション)「プロジェクトまたはフォルダ」で、「選択」をクリックし、タスクを保存する別のプロジェクトまたはフォルダを選択します。
    7. 最初にタスクを保存するには、次のいずれかのボタンをクリックします。
      • 作成: タスクを作成して保存します。タスクの作成と編集を続行できます。

      • 作成してクローズ: タスクを作成して保存し、ページを閉じ、プロジェクトまたはフォルダの詳細ページのタスク・リストに戻ります。

    8. 次のいずれかのボタンをクリックして、作業中に定期的に保存します。
      • 保存: 前回の保存以降の変更をコミットします。保存後に編集を続行できます。

      • 保存してクローズ: プロジェクトまたはフォルダの詳細ページのタスク・リストに戻り、変更をコミットします。

      • 別名保存: 現在のタスクを上書きせずに、変更内容(最後の保存以降)をコミットしてコピーに保存します。コピーの名前を指定し、コピーのために別のプロジェクトまたはフォルダを選択することも、コピーを既存のタスクと同じプロジェクトまたはフォルダに保存することもできます。

    9. 「REST API詳細」セクションで、「構成」をクリックします。

      表示される「REST API詳細の構成」ページで、REST API実行の詳細と、成功したRESTコールの完了基準(成功条件)を指定します。

      1. REST API実行の詳細を定義するには、次のステップを実行します。
        1. HTTPメソッドおよびREST URLを指定します
        2. (オプション)URLパラメータを構成します
        3. RESTリクエスト・ヘッダーを追加します
        4. (オプション)RESTヘッダーの値のタスク・パラメータを追加します
        5. HTTPメソッドPOSTまたはPUTの場合は、リクエスト本文を追加します。
        6. (オプション)リクエスト本文全体のタスク・パラメータを追加します
        7. 構成したREST URLを表示するには、「プレビューURLの表示」をクリックします。
        8. 次へ」をクリックします。
      2. REST API実行の正常完了の基準を指定するには、「条件」セクションにあるデフォルトの成功条件を編集します。
      3. REST APIが長時間実行操作を呼び出す場合は、成功条件に加えて、「待機なしRESTコールのポーリングおよび終了条件を構成します」チェック・ボックスを選択し、ポーリング構成(非同期動作)に必要な詳細を指定します。ポーリングを使用した完了基準の指定を参照してください。
      4. 「構成」をクリックします。

        「RESTタスクの作成」または「RESTタスク: <task name>」ページに戻ります。

    10. 「認証」セクションで、「構成」をクリックします。表示される「認証の構成」パネルで、REST APIエンドポイントを実行するための認証方法を指定します。デフォルトでは、認証方式は必要ありません。
    11. (オプション)「パラメータ」セクションで、「構成」をクリックします。表示される「RESTタスク・パラメータ」ページで、このRESTタスクのスコープで使用可能なパラメータの値を表示および編集します。
    12. (オプション)「タスクの検証」セクションで、「検証」をクリックします。

      エラーまたは警告がある場合は、「メッセージの表示」をクリックします。エラーがあれば、タスクを公開する前に解決します。

    13. RESTタスクの構成が終了したら、「作成してクローズ」または「保存してクローズ」をクリックします。
    RESTタスクをデータ統合のアプリケーションに公開した後で、タスクを実行するか、タスク実行のスケジュールを設定します。情報の公開については、データ統合アプリケーションへの公開を参照してください。
  • oci data-integration task create-task-from-rest-taskコマンドと必要なパラメータを使用して、RESTタスクを作成します:

    oci data-integration task create-task-from-rest-task [OPTIONS]

    CLIコマンドのフラグおよび変数オプションの完全なリストは、コマンドライン・リファレンスを参照してください。

  • 適切なリソース・サブタイプを指定してCreateTask操作を実行し、RESTタスクを作成します。