PATCH の送信

Postman などのリクエストツールを使用して、PATCH の形式が正しいことを確認し、応答ペイロードの構造をレビューすることができます。Postman の詳細については、要求と応答を参照してください。

Postman を使用した PATCH の送信

手順

  1. Postman で、[Launchpad]タブの右側の[+]をクリックして、新しい要求を開始します。
  2. ユーザー名 aapplegate とパスワード gw を使用して Basic Auth 認証を指定します。
  3. [Untitled Request]ラベルで PATCH が選択されていることを確認します。
  4. [Enter request URL]フィールドに、サーバーとエンドポイントの URL を入力します。
    • 例えば、自分のマシンの ClaimCenter のインスタンスで、アクティビティ cc:2 にパッチを適用するには、http://localhost:8080/cc/rest/common/v1/activities/cc:2 と入力します。
  5. 要求ペイロードを指定します。
    • タブの先頭行([パラメータ]で始まる行)で、[本文]をクリックします。
    • ラジオボタンの行で[raw]を選択します。
    • ラジオボタンの行の末尾で、ドロップダウンリストの値を[テキスト]から[JSON]に変更します。
    • 要求ペイロードをラジオボタンの下のテキストフィールドに貼り付けます。
  6. [送信]をクリックします。応答ペイロードが要求ペイロードの下に表示されます。

チュートリアル:アクティビティの PATCH

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

このチュートリアルでは、サンプルデータからオープンなアクティビティを見つけます。次に、そのアクティビティの件名と優先度を更新します。

チュートリアル手順

  1. Postman で、[Launchpad]タブの右側の[+]をクリックして、新しい要求を開始します。
    1. [権限]タブで、ユーザー名 aapplegate とパスワード gw を使用して、[Basic Auth]を選択します。
  2. サンプルデータには、Andy Applegate の「警察調書の取得」アクティビティが 1 つ含まれています。これは、未了クレームに対するオープンなアクティビティであるため、PATCH を実行できます。次の呼び出しを入力し、[送信]をクリックして、このアクティビティに対してクエリを実行します。
    1. GET http://localhost:8080/cc/rest/common/v1/activities?filter=subject:sw:Get%20police%20report
  3. Andy/Alice Applegate にアサインされた応答ペイロードのアクティビティについて、以下の情報に注目します。
    1. アクティビティ ID
    2. 優先度
    3. 件名
  4. 2 つ目の要求タブを開き、1 つ目のタブを右クリックして、[Duplicate Tab]を選択します。
  5. 処理を PATCH に変更し、次の URL を入力します。ただし、[送信]はまだクリックしないでください。
    1. PATCH http://localhost:8080/cc/rest/common/v1/activities/<activityID>
  6. 要求ペイロードを指定します。
    1. タブの先頭行([パラメータ]で始まる行)で、[本文]をクリックします。
    2. ラジオボタンの行で[raw]を選択します。
    3. ラジオボタンの行の末尾で、ドロップダウンリストの値を[テキスト]から[JSON]に変更します。
    4. 以下をラジオボタンの下のテキストフィールドに貼り付けます。件名の末尾に「!」が追加されていることに注意してください。
      {
        "data": {
          "attributes": {
            "subject" : "Get police report!",
            "priority": {
              "code": "low"
              }
          }
        }
      }
  7. [送信]をクリックします。応答ペイロードが要求ペイロードの下に表示されます。

作業の確認

  1. ClaimCenter で変更済みのアクティビティを表示します。
    1. ClaimCenter にユーザー名 aapplegate としてログオンします。Andy のランディングページは[アクティビティ]画面で、Andy にアサインされたオープンなアクティビティが表示されています。デフォルトで[今日の自分のアクティビティ]が表示されていますが、[アクティビティ]画面の上部のドロップダウンリストで、[すべての未了]に変更します。
    2. [優先順位]カラムをクリックして、アクティビティを優先度の昇順で並べ替えます。

PATCH が行われたアクティビティ(現在の優先度が低)は、一覧の最上部かその近くに表示されます。PATCH が行われたアクティビティの件名の末尾は「!」となります。