Oracle Cloud Infrastructureドキュメント

ヘッダーの追加および管理

RESTリクエストのヘッダー・セクションに渡す1つ以上のヘッダーを定義します。ヘッダーにはキーと値があります。REST APIリクエストの標準ヘッダーがすべてサポートされています。

たとえば、POSTまたはPUTリクエストにContent-Typeヘッダーを追加できます。

次の手順を使用して、メインHTTP URLまたはオプションのポーリングURLおよび終了URLのヘッダーを追加および管理できます。

ヘッダーの作成

メインHTTPメソッドまたはオプションのポーリングおよび終了HTTPメソッドのリクエスト・ヘッダーを作成します。

ヘッダーを作成するには:

  1. 「REST API詳細の構成」ページの「実行詳細の定義」ステップで、「ヘッダー」を選択してRESTタスクのヘッダーを作成します。

    投票または終了URLのヘッダーを作成するには、「完了基準の指定」ページに移動し、「待機なしRESTコールのポーリングおよび終了条件を構成します」チェック・ボックスを選択します。「Polling」または「Termination」タブで、「Header」を選択します。

  2. 「ヘッダーの追加」をクリックします。
  3. 「キー」フィールドに、ヘッダーの名前の入力を開始します。
    一致するキーが見つかると、候補リストがメニューに表示されます。必要なヘッダーを選択します。
  4. 「値」フィールドに、ヘッダー値の入力を開始します。
    一致する値が見つかると、候補リストがメニューに表示されます。必要なヘッダー値を選択します。
  5. 「追加」をクリックします。

    ヘッダーのキーと値が「ヘッダー」表に追加されます。

    ヘッダーのキーと値のペアの値にパラメータを割り当てるには、「タスク・パラメータとして公開」をクリックします。ヘッダー値のパラメータ化を参照してください。

ヘッダーの編集

ヘッダーのキーと値を編集できます。

ヘッダー値がパラメータ化されている場合は、パラメータを編集してデフォルトのパラメータ値を変更します。パラメータ化されたヘッダーの値の編集を参照してください。

ヘッダーのキーと値のペアを編集するには:

  1. 「REST API詳細の構成」ページの「実行詳細の定義」ステップで、「ヘッダー」を選択してRESTタスクのヘッダーを編集します。

    ポーリングまたは終了URLのヘッダーを編集するには、「完了基準の指定」ページに移動します。「Polling」または「Termination」タブで、「Header」を選択します。

  2. 表内のヘッダーの行で、アクション・メニュー(アクション・メニュー)から「編集」を選択します。
  3. ヘッダーの編集パネルで、「キー」および「値」フィールドの値を変更し、「保存」をクリックします。

    いずれかのフィールドへの入力を開始して、一致する項目が見つかると、候補リストがメニューに表示されます。次に、必要なヘッダー・キーまたはヘッダー値を選択できます。

    ノート

    「値」フィールドの値が${PARAMETER_HEADER}などのパラメータ文字列で、キーと一致するヘッダー値で文字列を上書きすると、「保存」をクリックするとそのパラメータが削除されます。ヘッダー値を再度パラメータ化するには、「ヘッダー値のパラメータ化」の説明に従って、「タスク・パラメータとして公開」をクリックします。

ヘッダーの削除

ヘッダーを削除すると、RESTタスクからヘッダーのキーと値のペアが削除されます。

ヘッダーを削除するには:

  1. 「REST API詳細の構成」ページの「実行詳細の定義」ステップで、「ヘッダー」を選択してRESTタスクのヘッダーを削除します。

    ポーリングまたは終了URLのヘッダーを削除するには、「完了基準の指定」ページに移動します。「Polling」または「Termination」タブで、「Header」を選択します。

  2. 表内のヘッダーの行で、「アクション」メニュー(アクション・メニュー)から「削除」を選択します。
  3. 「ヘッダーの削除」ダイアログ・ボックスで「削除」をクリックします。

    ヘッダーのキーと値のペアが「ヘッダー」表から削除されます。

    ノート

    ヘッダー値がパラメータ化されていた場合、ヘッダー値に関連付けられたパラメータは削除されません。パラメータを削除するには、RESTタスク・パラメータの削除を参照してください。
ヘッダー値のパラメータ化

ヘッダーのキーと値のペアを定義した後で、タスク・パラメータをヘッダー値に割り当てることができます。

ヘッダーのヘッダー値をパラメータ化するには:

  1. 「REST API詳細の構成」ページの「実行詳細の定義」ステップで、「ヘッダー」を選択します。

    ポーリングまたは終了URLのヘッダー値をパラメータ化するには、「完了基準の指定」ページに移動します。「Polling」または「Termination」タブで、「Header」を選択します。

  2. 表の行でヘッダー値の横にある「タスク・パラメータとして公開」をクリックします。
  3. 「パラメータの追加」パネルで、「識別子」フィールドにパラメータの名前を入力するか、デフォルト値を使用します。

    パラメータ名はRESTタスク内で一意である必要があります。タスク内のパラメータの現在のリストを確認する方法は、RESTタスク内のすべてのパラメータの表示を参照してください。

  4. (オプション)他のユーザーにパラメータの目的がわかるように、説明を入力します。
  5. 「データ型」はStringです。データ型を変更することはできません。
  6. 長さを設定します。
  7. パラメータのデフォルト値を設定します。
    設計時または実行時に値を変更しないかぎり、デフォルトのヘッダー値が実行時に使用されます。
  8. 「追加」をクリックします。
    表内のヘッダーの行が更新され、ヘッダー値の横にパラメータ名が表示されます。
パラメータ化されたヘッダーの値の編集

変更できるのはパラメータのデフォルト値のみです。

パラメータ化されたヘッダー値のデフォルト値を編集するには:

  1. 「REST API詳細の構成」ページの「実行詳細の定義」ステップで、「ヘッダー」を選択します。

    ポーリングまたは終了URLのパラメータ化されたヘッダー値を編集するには、「完了基準の指定」ページに移動します。「Polling」または「Termination」タブで、「Header」を選択します。

  2. 変更するヘッダー値の表の行で、パラメータ名の横にある「パラメータの編集」をクリックします。
  3. パラメータの編集パネルで、パラメータ値を変更します。
  4. 「保存」をクリックします
ヘッダー値パラメータの削除

ヘッダー値パラメータを削除すると、ヘッダーのヘッダー値とパラメータの関連付けのみが削除されます。

ヘッダー値パラメータを削除しても、ヘッダーのキーと値のペアは削除されません。

ヘッダー値パラメータを削除するには:

  1. 「REST API詳細の構成」ページの「実行詳細の定義」ステップで、「ヘッダー」を選択します。

    ポーリングまたは終了URLのヘッダー値パラメータを削除するには、「完了基準の指定」ページに移動します。「Polling」または「Termination」タブで、「Header」を選択します。

  2. 削除するヘッダー値パラメータの表の行で、「パラメータの削除」をクリックします。
  3. 「パラメータの削除」ダイアログで、「削除」をクリックします。

    ヘッダーのヘッダー値からパラメータの割当てが解除されます。パラメータに割り当てられていた値がヘッダー値になります。

    ノート

    ヘッダー値パラメータはRESTタスクから削除されません。パラメータを削除するには、RESTタスク・パラメータの削除を参照してください。