POST の送信

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

Postman を使用した POST の送信

手順

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

チュートリアル：必須フィールドのみを指定する新しい備考・経緯の作成

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

このチュートリアルでは、既存のアクティビティに「API tutorial note 1」という件名の備考・経緯を作成します。その他のフィールドは指定せず、アプリケーションによるデフォルト値（機密ではない、件名が「一般」であるなど）をアサインします。

チュートリアル手順

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

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

  3. ペイロードの 1 つ目のアクティビティの id を特定します。この値は、以下では <activityId> となります。
  4. 2 つ目の要求タブを開き、1 つ目のタブを右クリックして、［Duplicate Tab］を選択します。
  5. 処理を POST に変更し、次の URL を入力します。ただし、［送信］はまだクリックしないでください。

    POST http://localhost:8080/cc/rest/common/v1/activities/<activityId>/notes

  6. 要求ペイロードを指定します。
    1. タブの先頭行（［パラメータ］で始まる行）で、［本文］をクリックします。
    2. ラジオボタンの行で［raw］を選択します。
    3. ラジオボタンの行の末尾で、ドロップダウンリストの値を［テキスト］から［JSON］に変更します。
    4. ラジオボタンの下のテキストフィールドに以下を貼り付けます。
      {
    "data":
        {
            "attributes": {
                "body": "API tutorial note 1"
                }
        }
}
  7. ［送信］をクリックします。応答ペイロードが要求ペイロードの下に表示されます。

作業の確認

  1. ClaimCenter で新しい備考・経緯を確認します。
    1. この備考・経緯が関連するクレームのクレーム番号が応答ペイロードにあります（relatedTo.displayName フィールドの値です）。
    2. ClaimCenter に aapplegate としてログオンします。
    3. ［クレーム］タブで、ドロップダウン矢印をクリックします。［Claim #］フィールドにクレーム番号を入力して、Enter キーを押します。
    4. 左側のサイドバーで、［備考・経緯］をクリックします。

API チュートリアルの備考・経緯が、備考・経緯の 1 つとして一覧に表示されます。

チュートリアル：オプションのフィールドを指定する新しい備考・経緯の作成

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

このチュートリアルでは、既存のアクティビティに「API tutorial note 2」という件名の備考・経緯を作成します。また、confidential（true に設定）と subject（「Litigation」に設定）の 2 つのオプションのフィールドに値を指定します。

チュートリアル手順

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

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

  3. ペイロードで 1 つ目のアクティビティの id を特定します。この値は、以下では <activityId> となります。
  4. 2 つ目の要求タブを開き、1 つ目のタブを右クリックして、［Duplicate Tab］を選択します。
  5. 処理を POST に変更し、次の URL を入力します。ただし、［送信］はまだクリックしないでください。

    POST http://localhost:8080/cc/rest/common/v1/activities/<activityId>/notes

  6. 要求ペイロードを指定します。
    1. タブの先頭行（［パラメータ］で始まる行）で、［本文］をクリックします。
    2. ラジオボタンの行で［raw］を選択します。
    3. ラジオボタンの行の末尾で、ドロップダウンリストの値を［テキスト］から［JSON］に変更します。
    4. ラジオボタンの下のテキストフィールドに以下を貼り付けます。 
      {
    "data":
        {
            "attributes": {
                "body": "API tutorial note 2",
                "confidential": true,
                "topic": {
                    "code": "litigation"
                }
            }
        }
}
  7. ［送信］をクリックします。応答ペイロードが要求ペイロードの下に表示されます。

作業の確認

  1. ClaimCenter で新しい備考・経緯を確認します。
    1. この備考・経緯が関連するクレームのクレーム番号が応答ペイロードにあります（relatedTo.displayName フィールドの値です）。
    2. ClaimCenter に aapplegate としてログオンします。
    3. ［クレーム］タブで、ドロップダウン矢印をクリックします。［Claim #］フィールドにクレーム番号を入力して、Enter キーを押します。
    4. 左側のサイドバーで、［備考・経緯］をクリックします。

API チュートリアルの備考・経緯が、備考・経緯の 1 つとして一覧に表示されます。この備考・経緯は機密であり、要求ペイロードで指定されたカテゴリが含まれます。