リソース

呼び出し元アプリケーションと ClaimCenter との間で情報を受け渡す主要メカニズムはリソースです。リソースは、作成、変更、削除、またはクエリの対象にできるデータのインスタンスです。リソースは、JSON スキーマファイルで定義されています。

すべてのリソースにタイプがあります。タイプによって、リソースがマッピングされている Guidewire データモデルエンティティが定義されます。例えば、Activity リソースは Activity データモデルエンティティにマッピングされています。多くの場合、各リソースは 1 つのデータモデルエンティティにマッピングされています。ただし、一部のリソースは、複数のデータモデルエンティティにマッピングされています。例えば、ClaimContact リソースは、ClaimCenter の 3 つのデータモデルエンティティ(ClaimContactContact、および ClaimContactRole)にマッピングされています。

リソースには、一連のフィールドが含まれています。各フィールドには、リソースに関する情報が保存されています。コンテキストに応じて、フィールドはプロパティまたは属性とも呼ばれます。

リソースは、要求オブジェクトおよび応答オブジェクトのペイロードでやり取りされます。ペイロードは、JSON 形式テキストのブロックであり、関連リソースからのフィールドおよびそれらの値が含まれています。以下は、Activity リソースの応答ペイロードの一部です。

"attributes": {
    "assignedGroup": {
        "displayName": "Auto1 - TeamA",
        "id": "demo_sample:31"
    },
    "assignedUser": {
        "displayName": "Andy Applegate",
        "id": "demo_sample:1"
    },
    "dueDate": "2020-11-16T08:00:00.000Z",
    "id": "xc:20",
    "priority": {
        "code": "urgent",
        "name": "Urgent"
    "subject": "Contact claimant"
}

フィールドには以下のものを保存できます。

  • スカラー値(subject フィールドなど)。
  • 一連の値(assignedUser フィールドなど)。これは、インラインオブジェクトと呼ばれます。
  • オブジェクトの配列(Activity には、これに該当する例はありません。存在する場合、フィールド名の後に、配列を区切る角かっこ([ と ])が続きます。各配列メンバーは、中かっこ({ と })内にリストされます)。

各リソースは、そのリソース ID で一意に定義できます。この値は、データモデルエンティティの PublicID フィールドにマッピングされています。前の例のアクティビティは、アクティビティ xc:20 です。

単一のリソースは要素と呼ばれます。例えば、/contact/xc:203 は要素です(一部の REST API では、これはシングルトンとも呼ばれています)。

リソースのセットはコレクションと呼ばれます。例えば、/contact/xc:203/addresses(連絡先 xc:203 に関連付けられている住所)はコレクションです。