自分に関連付けられたクレームの問い合わせ

通常、GET /claim/v1/claims エンドポイントは、ClaimCenter にあるすべてのクレームを返すわけではありません。このエンドポイントは呼び出し元のリソースアクセスによって制限されます。ベースコンフィギュレーションでは、これは以下のことを意味します。

例えば、Andy Applegate さんと Wendy Gompers さんは 2 人とも、サンプルデータで定義された内部ユーザーです。サンプルデータが読み込まれ、各担当者が以下を実行したとします。

GET /claim/v1/claims?fields=id

Andy Applegate さんの応答ペイロードでは、count と data のセクションが彼の ACL にある 5 つの未了クレームで構成されます。

{
    "count": 5,
    "data": [
        {
            "attributes": {
                "id": "cc:34"
            }
        },
        {
            "attributes": {
                "id": "cc:33"
            }
        },
        {
            "attributes": {
                "id": "demo_sample:20"
            }
        },
        {
            "attributes": {
                "id": "demo_sample:2"
            }
        },
        {
            "attributes": {
                "id": "demo_sample:1"
            }
        }
    ],
...

Wendy Gompers さんの応答ペイロードでは、count と data のセクションが彼女の ACL にある 6 つの未了クレームで構成されます。

{
    "count": 6,
    "data": [
        {
            "attributes": {
                "id": "trucking:7"
            }
        },
        {
            "attributes": {
                "id": "trucking:8"
            }
        },
        {
            "attributes": {
                "id": "demo_sample:30002"
            }
        },
        {
            "attributes": {
                "id": "demo_sample:30001"
            }
        },
        {
            "attributes": {
                "id": "gl:1"
            }
        },
        {
            "attributes": {
                "id": "trucking:6"
            }
        }
    ],
...

自身で確認するためにこの出力を Postman で表示するには、次の手順を実行します。

1. 要求タブを開きます。［権限］タブで、［種類］ドロップダウンリストを［Basic Auth］に設定します。［ユーザー名］と［パスワード］に、それぞれ aapplegate と gw を指定します。
2. GET /claim/v1/claims を実行します。
3. 2 つ目の要求タブを開きます。［権限］タブで、［種類］ドロップダウンリストを［Basic Auth］に設定します。［ユーザー名］と［パスワード］に、それぞれ wgompers と gw を指定します。
4. GET /claim/v1/claims を実行します。
5. 2 つの応答ペイロードを比較します。

リソースアクセスの詳細については、『Cloud API 認証ガイド』を参照してください。

クローズされたクレーム

デフォルトでは、GET /claim/v1/claims エンドポイントは未了クレームのみを返します。次のクエリパラメータを追加すると、未了クレームとクローズされたクレームを問い合わせることができます。

?filter=state:in:open,closed

ドラフトのクレーム

ドラフトクレームは、データベースに保存されているものの、担当者または業者にアサインできるだけの十分な情報が揃っていないクレームです。したがって、一部の呼び出し元に対しては、GET /claim/v1/claims エンドポイントはドラフトクレームを返しません。