DELETE のチェックサム

要求ペイロードを許可しない処理の場合、チェックサムを要求ヘッダーに指定できます。これは、DELETE と要求ペイロードを許可しない少数のビジネスアクション POST に適用されます。

チェックサムのヘッダーキーは、GW-Checksum です。ヘッダーに指定されたチェックサムは、ルートリソースにのみ適用されます。

Postman を使用した要求ヘッダーでのチェックサムの送信

このタスクについて

Postman から実行された要求ヘッダーでチェックサムを送信できます。

手順

  1. Postman で、［Launchpad］タブの右側の［+］をクリックして、新しい要求を開始します。
  2. 必要に応じて権限を指定します。
  3. チェックサムをヘッダーに追加します。
    • タブの先頭行（［パラメータ］で始まる行）で、［ヘッダー］をクリックします。
    • 既存のキー／値のリストの下部までスクロールします。
    • キー／値のリストの下部にある空白行に、以下を入力します。
      • キー： GW-Checksum
      • 値：<チェックサム値>
  4. 要求の処理と URL を入力します。
  5. ［送信］をクリックします。

タスクの結果

応答が要求の下に表示されます。指定したチェックサム値に応じて、応答には成功コードまたはエラーメッセージが含まれます。

チュートリアル：チェックサムを使用した備考・経緯の DELETE

このチュートリアルでは、Postman を使用する環境を設定し、適切なサンプルデータセットを用意していることを前提としています。詳細については、チュートリアル：Postman 環境のセットアップを参照してください。

このチュートリアルでは、Elizabeth Lee さん（ユーザー名 elee）として呼び出しを送信します。ベースコンフィギュレーションでは、Elizabeth Lee さんは備考・経緯を削除する権限を持つマネージャです。Elizabeth Lee さんとして、備考・経緯を作成します。備考・経緯を 2 回 DELETE してみます。両方の DELETE には、チェックサム値が含まれます。最初の DELETE は失敗し、2 回目の DELETE は成功します。

チュートリアル手順

  1. Postman で、［Launchpad］タブの右側の［+］をクリックして、新しい要求を開始します。
    1. ［権限］タブで、ユーザー名 aapplegate とパスワード gw を使用して、［Basic Auth］を選択します。
  2. 次の呼び出しを入力して、［送信］をクリックします。

    GET http://localhost:8080/cc/rest/common/v1/activities

  3. ペイロードの最初のアクティビティの id を特定します。この値は、下記で <activityId> として参照されます。
  4. 2 つ目の要求タブを開き、1 つ目のタブを右クリックして、［Duplicate Tab］を選択します。
    1. ［権限］タブで、ユーザー名 elee とパスワード gw を使用して、［Basic Auth］を選択します。
  5. 処理を POST に変更し、次の URL を入力します。ただし、［送信］はまだクリックしないでください。
    1. POST http://localhost:8080/cc/rest/common/v1/activities/<activityId>/notes
  6. 要求ペイロードを指定します。
    1. タブの先頭行（［パラメータ］で始まる行）で、［本文］をクリックします。
    2. ラジオボタンの行で［raw］を選択します。
    3. ラジオボタンの行の末尾で、ドロップダウンリストの値を［テキスト］から［JSON］に変更します。
    4. 以下を、ラジオボタンの下のテキストフィールドに貼り付けます。
      {
  "data":
    {
      "attributes": {
        "body": "API tutorial note to be deleted with a checksum"
      }
    }
}
  7. ［送信］をクリックします。応答ペイロードで、備考・経緯の ID を特定します。
  8. 3 つ目の要求タブを開き、2 つ目のタブを右クリックして ［Duplicate Tab］ タブを選択します。
    1. これは 2 つ目のタブの複製なので、このタブでもユーザー elee を使用します。
  9. 処理を DELETE に変更し、次の URL を入力します。ただし、［送信］はまだクリックしないでください。
    1. DELETE http://localhost:8080/cc/rest/common/v1/notes/<noteID>
  10. DELETE では要求本文は指定できません。3 つ目のタブで、［本文］タブに移動し、［なし］ラジオボタンを選択します。
  11. チェックサムをヘッダーに追加します。
    1. タブの先頭行（［パラメータ］で始まる行）で、［ヘッダー］をクリックします。
    2. 既存のキー／値のリストの下部までスクロールします。
    3. キー／値のリストの下部にある空白行に、以下を入力します。
      • キー：GW-Checksum
      • 値：99
  12. ［送信］をクリックします。ヘッダーのチェックサム値は ClaimCenter で計算された備考・経緯のチェックサム値に一致していません。したがって、DELETE は不成功で、エラーメッセージが表示されます。
  13. チェックサム値を変更して、POST ペイロードのチェックサム値に一致するようにします。
  14. 再度［送信］をクリックします。現在、ヘッダーのチェックサム値は ClaimCenter で計算された備考・経緯のチェックサム値に一致しています。したがって、DELETE は成功です（成功する DELETE への応答は「204 - No content」です）。