Guidewire Cloud Claims Center

https://docs.guidewire.com/cloud/cc/202507/
Admin
Guidewire Cloud Claims Center is a cloud-based claims management platform that enables insurance...
Tokens:999,770
Snippets:1,555
Trust Score:10
Update:6 months ago
Show doc for...
Tokens:
Raw
### GET /rest/admin/v1/catastrophes

Source: https://docs.guidewire.com/cloud/cc/202507/apiref/generated/Admin%20API/catastrophes--get

Retrieves a collection of catastrophes from the ClaimCenter system.

```APIDOC
## GET /rest/admin/v1/catastrophes

### Description
Retrieve a collection of catastrophes. This endpoint supports filtering, sorting, and pagination.

### Method
GET

### Endpoint
/rest/admin/v1/catastrophes

### Parameters
#### Query Parameters
- **fields** (Array of strings) - Optional - Allows the caller to specify the set of fields that should be included on the response.
- **filter** (Array of strings) - Optional - Filters the list of results based on the specified field, operator, and value.
- **include** (Array of strings) - Optional - Used to request that additional resources be returned with the API response.
- **includeLocalizations** (Array of strings) - Optional - A comma-separated list of language codes to include localizations for.
- **includeTotal** (Array of strings) - Optional - Used to request that results should include a count of the total number of results available.
- **pageSize** (Array of strings) - Optional - The maximum number of results to return in the response.
- **pageOffset** (string) - Optional - The offset of the first result to fetch when fetching a paginated set of results.
- **sort** (Array of strings) - Optional - Controls the sorting of elements within a response.

### Response
#### Success Response (200)
- **Successful response** - The request was processed successfully.
```

--------------------------------

### Response Sample for /websites/guidewire_cloud_cc_202507

Source: https://docs.guidewire.com/cloud/cc/202507/apiref/generated/Admin%20API/groups--groupId--queues--get

This snippet details the structure of a successful JSON response (200 OK) for requests related to the /websites/guidewire_cloud_cc_202507 endpoint.

```APIDOC
## GET /websites/guidewire_cloud_cc_202507

### Description
Retrieves a list of resources with associated attributes, links, and related information.

### Method
GET

### Endpoint
/websites/guidewire_cloud_cc_202507

### Response
#### Success Response (200)
- **count** (integer) - The number of items in the data array.
- **data** (array) - An array of resource objects.
  - **attributes** (object) - Contains descriptive properties of the resource.
    - **description** (string) - A textual description.
    - **id** (string) - A unique identifier.
    - **name** (string) - The name of the resource.
    - **subGroupVisible** (boolean) - Indicates if the subgroup is visible.
  - **checksum** (string) - A checksum for data integrity.
  - **id** (string) - A unique identifier for the resource.
  - **links** (object) - Contains links to related resources or actions.
    - **property1** (object) - Link details.
      - **href** (string) - The URL for the link.
      - **methods** (array of strings) - Allowed HTTP methods for this link.
    - **property2** (object) - Link details.
      - **href** (string) - The URL for the link.
      - **methods** (array of strings) - Allowed HTTP methods for this link.
  - **method** (string) - The HTTP method associated with this resource.
  - **refid** (string) - A reference identifier.
  - **related** (object) - Contains nested related resources.
    - **property1** (object) - Related resource details.
      - **count** (integer) - The number of related items.
      - **data** (array) - An array of related item objects.
        - **displayName** (string) - The display name of the related item.
        - **id** (string) - The unique identifier of the related item.
        - **jsonPath** (string) - The JSON path to the related item.
        - **refid** (string) - A reference identifier for the related item.
        - **type** (string) - The type of the related item.
        - **uri** (string) - The URI of the related item.
      - **total** (integer) - The total number of related items.
    - **property2** (object) - Related resource details.
      - **count** (integer) - The number of related items.
      - **data** (array) - An array of related item objects.
        - **displayName** (string) - The display name of the related item.
        - **id** (string) - The unique identifier of the related item.
        - **jsonPath** (string) - The JSON path to the related item.
        - **refid** (string) - A reference identifier for the related item.
        - **type** (string) - The type of the related item.
        - **uri** (string) - The URI of the related item.
      - **total** (integer) - The total number of related items.
  - **type** (string) - The type of the resource.
  - **uri** (string) - The URI of the resource.
- **links** (object) - Top-level links for pagination or actions.
  - **property1** (object) - Link details.
    - **href** (string) - The URL for the link.
    - **methods** (array of strings) - Allowed HTTP methods for this link.
  - **property2** (object) - Link details.
    - **href** (string) - The URL for the link.
    - **methods** (array of strings) - Allowed HTTP methods for this link.
- **total** (integer) - The total number of resources available.

### Request Example
(No request example provided in the source text)

### Response Example
```json
{
  "count": 0,
  "data": [
    {
      "attributes": {
        "description": "string",
        "id": "string",
        "name": "string",
        "subGroupVisible": true
      },
      "checksum": "string",
      "id": "string",
      "links": {
        "property1": {
          "href": "string",
          "methods": [
            "string"
          ]
        },
        "property2": {
          "href": "string",
          "methods": [
            "string"
          ]
        }
      },
      "method": "string",
      "refid": "string",
      "related": {
        "property1": {
          "count": 0,
          "data": [
            {
              "displayName": "string",
              "id": "string",
              "jsonPath": "string",
              "refid": "string",
              "type": "string",
              "uri": "string"
            }
          ],
          "total": 0
        },
        "property2": {
          "count": 0,
          "data": [
            {
              "displayName": "string",
              "id": "string",
              "jsonPath": "string",
              "refid": "string",
              "type": "string",
              "uri": "string"
            }
          ],
          "total": 0
        }
      },
      "type": "string",
      "uri": "string"
    }
  ],
  "links": {
    "property1": {
      "href": "string",
      "methods": [
        "string"
      ]
    },
    "property2": {
      "href": "string",
      "methods": [
        "string"
      ]
    }
  },
  "total": 0
}
```
```

--------------------------------

### GET /rest/claim/v1/swagger.json

Source: https://docs.guidewire.com/cloud/cc/202507/apiref/generated/Claim%20API/swagger-json--get

Returns the Swagger schema for the ClaimCenter Claim API.

```APIDOC
## GET /rest/claim/v1/swagger.json

### Description
Returns a Swagger 2.0 schema for this API as JSON.

### Method
GET

### Endpoint
/rest/claim/v1/swagger.json

### Response
#### Success Response (200)
- **schema** (object) - The Swagger 2.0 schema for the API.
```

--------------------------------

### Response Samples

Source: https://docs.guidewire.com/cloud/cc/202507/apiref/generated/Admin%20API/attributes--attributeId---get

This section details the structure of successful responses (200 OK) for various resources within the Guidewire Cloud CC 202507 API.

```APIDOC
## Response Samples

### Success Response (200)

This endpoint returns a JSON object containing `data` and `included` fields. The `data` field represents the primary resource, while `included` contains related resources.

#### Data Structure

- **data** (object)
  - **attributes** (object)
    - **description** (string) - Description of the attribute.
    - **id** (string) - Unique identifier for the attribute.
    - **name** (string) - Name of the attribute.
    - **type** (object)
      - **code** (string) - Code representing the attribute type.
      - **name** (string) - Name of the attribute type.
  - **checksum** (string) - Checksum of the data.
  - **id** (string) - Unique identifier for the data.
  - **links** (object) - Links related to the data.
    - **property1** (object)
      - **href** (string) - URL for the link.
      - **methods** (array of strings) - Allowed HTTP methods for this link.
    - **property2** (object)
      - **href** (string) - URL for the link.
      - **methods** (array of strings) - Allowed HTTP methods for this link.
  - **method** (string) - HTTP method associated with this data.
  - **refid** (string) - Reference ID for the data.
  - **related** (object) - Related resources.
    - **property1** (object)
      - **count** (integer) - Number of related items.
      - **data** (array of objects) - Array of related items.
        - **displayName** (string) - Display name of the related item.
        - **id** (string) - Unique identifier of the related item.
        - **jsonPath** (string) - JSON path to the related item.
        - **refid** (string) - Reference ID of the related item.
        - **type** (string) - Type of the related item.
        - **uri** (string) - URI of the related item.
      - **total** (integer) - Total number of related items.
    - **property2** (object)
      - **count** (integer) - Number of related items.
      - **data** (array of objects) - Array of related items.
        - **displayName** (string) - Display name of the related item.
        - **id** (string) - Unique identifier of the related item.
        - **jsonPath** (string) - JSON path to the related item.
        - **refid** (string) - Reference ID of the related item.
        - **type** (string) - Type of the related item.
        - **uri** (string) - URI of the related item.
      - **total** (integer) - Total number of related items.
  - **type** (string) - Type of the data.
  - **uri** (string) - URI of the data.

#### Included Resources

- **included** (object)
  - **AssignableQueue** (array of objects)
    - **attributes** (object)
      - **description** (string) - Description of the assignable queue.
      - **id** (string) - Unique identifier for the assignable queue.
      - **name** (string) - Name of the assignable queue.
      - **subGroupVisible** (boolean) - Indicates if the sub-group is visible.
    - **checksum** (string) - Checksum of the assignable queue.
    - **id** (string) - Unique identifier for the assignable queue.
    - **links** (object) - Links related to the assignable queue.
      - **property1** (object)
        - **href** (string) - URL for the link.
        - **methods** (array of strings) - Allowed HTTP methods for this link.
      - **property2** (object)
        - **href** (string) - URL for the link.
        - **methods** (array of strings) - Allowed HTTP methods for this link.
    - **method** (string) - HTTP method associated with this assignable queue.
    - **refid** (string) - Reference ID for the assignable queue.
    - **related** (object) - Related resources for the assignable queue.
      - **property1** (object)
        - **count** (integer) - Number of related items.
        - **data** (array of objects) - Array of related items.
          - **displayName** (string) - Display name of the related item.
          - **id** (string) - Unique identifier of the related item.
          - **jsonPath** (string) - JSON path to the related item.
          - **refid** (string) - Reference ID of the related item.
          - **type** (string) - Type of the related item.
          - **uri** (string) - URI of the related item.
        - **total** (integer) - Total number of related items.
      - **property2** (object)
        - **count** (integer) - Number of related items.
        - **data** (array of objects) - Array of related items.
          - **displayName** (string) - Display name of the related item.
          - **id** (string) - Unique identifier of the related item.
          - **jsonPath** (string) - JSON path to the related item.
          - **refid** (string) - Reference ID of the related item.
          - **type** (string) - Type of the related item.
          - **uri** (string) - URI of the related item.
        - **total** (integer) - Total number of related items.
    - **type** (string) - Type of the assignable queue.
    - **uri** (string) - URI of the assignable queue.
  - **Attribute** (array of objects)
    - **attributes** (object)
      - **description** (string) - Description of the attribute.
      - **id** (string) - Unique identifier for the attribute.
      - **name** (string) - Name of the attribute.
      - **type** (object)
        - **code** (string) - Code representing the attribute type.
        - **name** (string) - Name of the attribute type.
    - **checksum** (string) - Checksum of the attribute.
    - **id** (string) - Unique identifier for the attribute.
    - **links** (object) - Links related to the attribute.
      - **property1** (object)
        - **href** (string) - URL for the link.
        - **methods** (array of strings) - Allowed HTTP methods for this link.
      - **property2** (object)
        - **href** (string) - URL for the link.
        - **methods** (array of strings) - Allowed HTTP methods for this link.
    - **method** (string) - HTTP method associated with this attribute.
    - **refid** (string) - Reference ID for the attribute.
    - **related** (object) - Related resources for the attribute.
      - **property1** (object)
        - **count** (integer) - Number of related items.
        - **data** (array of objects) - Array of related items.
          - **displayName** (string) - Display name of the related item.
          - **id** (string) - Unique identifier of the related item.
          - **jsonPath** (string) - JSON path to the related item.
          - **refid** (string) - Reference ID of the related item.
          - **type** (string) - Type of the related item.
          - **uri** (string) - URI of the related item.
        - **total** (integer) - Total number of related items.
      - **property2** (object)
        - **count** (integer) - Number of related items.
        - **data** (array of objects) - Array of related items.
          - **displayName** (string) - Display name of the related item.
          - **id** (string) - Unique identifier of the related item.
          - **jsonPath** (string) - JSON path to the related item.
          - **refid** (string) - Reference ID of the related item.
          - **type** (string) - Type of the related item.
          - **uri** (string) - URI of the related item.
        - **total** (integer) - Total number of related items.
    - **type** (string) - Type of the attribute.
    - **uri** (string) - URI of the attribute.
  - **AuthorityLimit** (array of objects)
    - **attributes** (object)
      - **costType** (object)
        - **code** (string) - Code for the cost type.
        - **name** (string) - Name of the cost type.
      - **coverageType** (object)
        - **code** (string) - Code for the coverage type.
        - **name** (string) - Name of the coverage type.
      - **id** (string) - Unique identifier for the authority limit.
      - **limitAmount** (object)
        - **amount** (string) - The monetary amount.
        - **currency** (string) - The currency of the amount.
      - **limitType** (object)
        - **code** (string) - Code for the limit type.
        - **name** (string) - Name of the limit type.
      - **policyType** (object)
        - **code** (string) - Code for the policy type.
        - **name** (string) - Name of the policy type.
    - **checksum** (string) - Checksum of the authority limit.
    - **id** (string) - Unique identifier for the authority limit.
    - **links** (object) - Links related to the authority limit.
      - **property1** (object)
        - **href** (string) - URL for the link.
        - **methods** (array of strings) - Allowed HTTP methods for this link.
      - **property2** (object)
        - **href** (string) - URL for the link.
        - **methods** (array of strings) - Allowed HTTP methods for this link.
    - **method** (string) - HTTP method associated with this authority limit.

### Response Example

```json
{
  "data": {
    "attributes": {
      "description": "string",
      "id": "string",
      "name": "string",
      "type": {
        "code": "string",
        "name": "string"
      }
    },
    "checksum": "string",
    "id": "string",
    "links": {
      "property1": {
        "href": "string",
        "methods": [
          "string"
        ]
      },
      "property2": {
        "href": "string",
        "methods": [
          "string"
        ]
      }
    },
    "method": "string",
    "refid": "string",
    "related": {
      "property1": {
        "count": 0,
        "data": [
          {
            "displayName": "string",
            "id": "string",
            "jsonPath": "string",
            "refid": "string",
            "type": "string",
            "uri": "string"
          }
        ],
        "total": 0
      },
      "property2": {
        "count": 0,
        "data": [
          {
            "displayName": "string",
            "id": "string",
            "jsonPath": "string",
            "refid": "string",
            "type": "string",
            "uri": "string"
          }
        ],
        "total": 0
      }
    },
    "type": "string",
    "uri": "string"
  },
  "included": {
    "AssignableQueue": [
      {
        "attributes": {
          "description": "string",
          "id": "string",
          "name": "string",
          "subGroupVisible": true
        },
        "checksum": "string",
        "id": "string",
        "links": {
          "property1": {
            "href": "string",
            "methods": [
              "string"
            ]
          },
          "property2": {
            "href": "string",
            "methods": [
              "string"
            ]
          }
        },
        "method": "string",
        "refid": "string",
        "related": {
          "property1": {
            "count": 0,
            "data": [
              {
                "displayName": "string",
                "id": "string",
                "jsonPath": "string",
                "refid": "string",
                "type": "string",
                "uri": "string"
              }
            ],
            "total": 0
          },
          "property2": {
            "count": 0,
            "data": [
              {
                "displayName": "string",
                "id": "string",
                "jsonPath": "string",
                "refid": "string",
                "type": "string",
                "uri": "string"
              }
            ],
            "total": 0
          }
        },
        "type": "string",
        "uri": "string"
      }
    ],
    "Attribute": [
      {
        "attributes": {
          "description": "string",
          "id": "string",
          "name": "string",
          "type": {
            "code": "string",
            "name": "string"
          }
        },
        "checksum": "string",
        "id": "string",
        "links": {
          "property1": {
            "href": "string",
            "methods": [
              "string"
            ]
          },
          "property2": {
            "href": "string",
            "methods": [
              "string"
            ]
          }
        },
        "method": "string",
        "refid": "string",
        "related": {
          "property1": {
            "count": 0,
            "data": [
              {
                "displayName": "string",
                "id": "string",
                "jsonPath": "string",
                "refid": "string",
                "type": "string",
                "uri": "string"
              }
            ],
            "total": 0
          },
          "property2": {
            "count": 0,
            "data": [
              {
                "displayName": "string",
                "id": "string",
                "jsonPath": "string",
                "refid": "string",
                "type": "string",
                "uri": "string"
              }
            ],
            "total": 0
          }
        },
        "type": "string",
        "uri": "string"
      }
    ],
    "AuthorityLimit": [
      {
        "attributes": {
          "costType": {
            "code": "string",
            "name": "string"
          },
          "coverageType": {
            "code": "string",
            "name": "string"
          },
          "id": "string",
          "limitAmount": {
            "amount": "string",
            "currency": "string"
          },
          "limitType": {
            "code": "string",
            "name": "string"
          },
          "policyType": {
            "code": "string",
            "name": "string"
          }
        },
        "checksum": "string",
        "id": "string",
        "links": {
          "property1": {
            "href": "string",
            "methods": [
              "string"
            ]
          },
          "property2": {
            "href": "string",
            "methods": [
              "string"
            ]
          }
        },
        "method": "string"
      }
    ]
  }
}

```

--------------------------------

### GET /websites/guidewire_cloud_cc_202507

Source: https://docs.guidewire.com/cloud/cc/202507/apiref/generated/Claim%20API/unverified-policies--post

Retrieves details about the Guidewire Cloud CC 202507 project, including associated data structures like claims, reserves, and user information.

```APIDOC
## GET /websites/guidewire_cloud_cc_202507

### Description
Retrieves details about the Guidewire Cloud CC 202507 project, including associated data structures like claims, reserves, and user information.

### Method
GET

### Endpoint
/websites/guidewire_cloud_cc_202507

### Response
#### Success Response (200)
- **claimToReportingExchangeRateInUse** (object) - Exchange rate details for claim to reporting.
  - **market** (object)
    - **code** (string)
    - **name** (string)
  - **rate** (string)
- **comments** (string) - General comments.
- **coverage** (object)
  - **code** (string)
  - **name** (string)
- **createTime** (string) - Timestamp of creation (ISO 8601 format).
- **createdVia** (object)
  - **code** (string)
  - **name** (string)
- **currency** (object)
  - **code** (string)
  - **name** (string)
- **eroding** (boolean) - Indicates if the item is eroding.
- **id** (string) - Unique identifier.
- **lineItems** (array) - List of line items associated with the claim.
  - **claimAmount** (object)
    - **amount** (number) - The amount of the claim.
    - **currency** (string) - The currency of the claim amount.
  - **comments** (string) - Comments specific to the line item.
  - **id** (string) - Unique identifier for the line item.
  - **lineCategory** (object)
    - **code** (string)
    - **name** (string)
  - **reportingAmount** (object)
    - **amount** (number) - The reported amount.
    - **currency** (string) - The currency of the reported amount.
  - **reservingAmount** (object)
    - **amount** (number) - The reserved amount.
    - **currency** (string) - The currency of the reserved amount.
  - **transactionAmount** (object)
    - **amount** (number) - The transaction amount.
    - **currency** (string) - The currency of the transaction amount.
- **paymentType** (object)
  - **code** (string)
  - **name** (string)
- **reserveLine** (object) - Details about the reserve line.
  - **costCategory** (object)
    - **code** (string)
    - **name** (string)
  - **costType** (object)
    - **code** (string)
    - **name** (string)
  - **exposure** (object)
    - **displayName** (string)
    - **id** (string)
    - **jsonPath** (string)
    - **refid** (string)
    - **type** (string)
    - **uri** (string)
  - **recoveryCategory** (object)
    - **code** (string)
    - **name** (string)
  - **reservingCurrency** (object)
    - **code** (string)
    - **name** (string)
- **status** (object)
  - **code** (string)
  - **name** (string)
- **subtype** (object)
  - **code** (string)
  - **name** (string)
- **transToClaimExchangeRate** (object)
  - **description** (string)
  - **market** (boolean)
  - **rate** (string)
- **transToClaimExchangeRateInUse** (object)
  - **market** (object)
    - **code** (string)
    - **name** (string)
  - **rate** (string)
- **transToReservingExchangeRate** (object)
  - **description** (string)
  - **market** (boolean)
  - **rate** (string)
- **transToReservingExchangeRateInUse** (object)
  - **market** (object)
    - **code** (string)
    - **name** (string)
  - **rate** (string)
- **requestingUser** (object)
  - **displayName** (string)
  - **id** (string)
  - **jsonPath** (string)
  - **refid** (string)
  - **type** (string)
  - **uri** (string)

#### Response Example
```json
{
  "claimToReportingExchangeRateInUse": {
    "market": {
      "code": "USD",
      "name": "US Dollar"
    },
    "rate": "1.0"
  },
  "comments": "Initial claim submission.",
  "coverage": {
    "code": "AUTO",
    "name": "Automobile Insurance"
  },
  "createTime": "2019-08-24T14:15:22Z",
  "createdVia": {
    "code": "WEB",
    "name": "Web Portal"
  },
  "currency": {
    "code": "USD",
    "name": "US Dollar"
  },
  "eroding": false,
  "id": "claim-12345",
  "lineItems": [
    {
      "claimAmount": {
        "amount": 5000.00,
        "currency": "USD"
      },
      "comments": "Damage to front bumper.",
      "id": "line-item-001",
      "lineCategory": {
        "code": "REPAIR",
        "name": "Repair Costs"
      },
      "reportingAmount": {
        "amount": 4500.00,
        "currency": "USD"
      },
      "reservingAmount": {
        "amount": 4800.00,
        "currency": "USD"
      },
      "transactionAmount": {
        "amount": 5000.00,
        "currency": "USD"
      }
    }
  ],
  "paymentType": {
    "code": "DIRECT",
    "name": "Direct Payment"
  },
  "reserveLine": {
    "costCategory": {
      "code": "MATERIAL",
      "name": "Material Costs"
    },
    "costType": {
      "code": "LABOR",
      "name": "Labor Costs"
    },
    "exposure": {
      "displayName": "Vehicle Damage",
      "id": "exposure-001",
      "jsonPath": "$.claim.exposure.vehicle",
      "refid": "ref-exp-001",
      "type": "VEHICLE",
      "uri": "/exposures/vehicle/001"
    },
    "recoveryCategory": {
      "code": "INSURANCE",
      "name": "Insurance Recovery"
    },
    "reservingCurrency": {
      "code": "USD",
      "name": "US Dollar"
    }
  },
  "status": {
    "code": "OPEN",
    "name": "Open"
  },
  "subtype": {
    "code": "AUTO_COLLISION",
    "name": "Auto Collision Claim"
  },
  "transToClaimExchangeRate": {
    "description": "Rate used for translation from transaction currency to claim currency.",
    "market": true,
    "rate": "0.95"
  },
  "transToClaimExchangeRateInUse": {
    "market": {
      "code": "EUR",
      "name": "Euro"
    },
    "rate": "0.95"
  },
  "transToReservingExchangeRate": {
    "description": "Rate used for translation from transaction currency to reserving currency.",
    "market": true,
    "rate": "0.98"
  },
  "transToReservingExchangeRateInUse": {
    "market": {
      "code": "GBP",
      "name": "British Pound"
    },
    "rate": "0.98"
  }
},
"requestingUser": {
  "displayName": "John Doe",
  "id": "user-101",
  "jsonPath": "$.requestingUser",
  "refid": "ref-user-101",
  "type": "USER",
  "uri": "/users/101"
}
```
```

--------------------------------

### GET /rest/claim/v1/role-constraints/{contactRoleId}

Source: https://docs.guidewire.com/cloud/cc/202507/apiref/generated/Claim%20API/role-constraints--contactRoleId---get

Retrieves the constraints for a given contact role.

```APIDOC
## GET /rest/claim/v1/role-constraints/{contactRoleId}

### Description
The constraints of the given contact role.

### Method
GET

### Endpoint
/rest/claim/v1/role-constraints/{contactRoleId}

### Parameters
#### Path Parameters
- **contactRoleId** (string) - Required - The identifier for the contact role.

#### Query Parameters
- **schema** (Array of strings) - Optional - Allows the caller to specify the set of fields that should be included on the response. This can be used to limit the set of fields returned as well as to include optional fields that otherwise wouldn't normally be returned. The parameter is either of the form `fields=<field list>` or `fields=<include>:<field list>`, where `<field list>` consists of a comma-separated list of field or field set names. See the documentation for more information.
- **filter** (Array of strings) - Optional - Filters the list of results based on the specified field, operator, and value. The parameter is either of the form `filter=<field>:<operator>:<value>` or `filter=<include>:<field>:<operator>:<value>`. See the documentation for more information.
- **include** (Array of strings) - Optional - Used to request that additional resources be returned with the API response in the `included` section of the responses. The `include` parameter can appear multiple times, and is a comma-separated list of additional resources to include. See the documentation for more information.
- **includeLocalizations** (Array of strings) - Optional - A comma-separated list of language codes to include localizations for, or the special code `*all` to include all languages configured in the application (Since 1.12.0).
- **includeTotal** (Array of strings) - Optional - Used to request that results should include a count of the total number of results available, which may be more than the total number of results currently being returned. This parameter is of the form `includeTotal=<true|false>` or `includeTotal=<include>:<true|false>`. If not specified, the default is considered to be `false`. See the documentation for more information about response pagination.
- **pageSize** (Array of strings) - Optional - The maximum number of results to return in the response. The parameter is of the form `pageSize=<size>` or `pageSize=<include>:<size>`. The maximum allowed `pageSize` and the default `pageSize` both depend on the specific API endpoint the request is made to. See the documentation for more information about response pagination.
- **sort** (Array of strings) - Optional - Controls the sorting of elements within a response. The sort parameter is of the form `sort=<fields>` or `sort=<include>:<fields>`, where `<fields>` represents a comma-separated list of field names to sort on. Field names can be prefixed with `-` to request a descending sort, otherwise the sort will be ascending. See the documentation for more information.

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **data** (object) - Contains the main data of the response.
  - **attributes** (object) - Attributes of the contact role constraint.
    - **code** (string) - The code of the constraint.
    - **name** (string) - The name of the constraint.
    - **schemaConstraints** (Array of objects) - List of schema constraints.
      - **constraints** (Array of objects) - List of specific constraints.
        - **additionalInfoList** (Array of objects) - Additional information about the constraint.
          - **propertyName** (string) - The name of the property.
          - **value** (string) - The value of the property.
        - **constraintType** (string) - The type of the constraint.
      - **exceptionSubtypes** (Array of strings) - Subtypes that are exceptions to the constraint.
      - **schema** (string) - The schema the constraint applies to.
    - **subtype** (string) - The subtype of the contact role.
  - **checksum** (string) - Checksum of the data.
  - **id** (string) - The unique identifier of the resource.
  - **links** (object) - Links related to the resource.
    - **property1** (object) - Example link property.
      - **href** (string) - The URL of the link.
      - **methods** (Array of strings) - Allowed HTTP methods for the link.
    - **property2** (object) - Example link property.
      - **href** (string) - The URL of the link.
      - **methods** (Array of strings) - Allowed HTTP methods for the link.
  - **method** (string) - The HTTP method associated with the resource.
  - **refid** (string) - A reference identifier for the resource.
  - **related** (object) - Related resources.
    - **property1** (object) - Example related resource.
      - **count** (integer) - The number of related items.
      - **data** (Array of objects) - The data for the related items.
        - **displayName** (string) - Display name of the related item.
        - **id** (string) - ID of the related item.
        - **jsonPath** (string) - JSON path to the related item.
        - **refid** (string) - Reference ID of the related item.
        - **type** (string) - Type of the related item.
        - **uri** (string) - URI of the related item.
      - **total** (integer) - Total number of related items available.
    - **property2** (object) - Example related resource.
      - **count** (integer) - The number of related items.
      - **data** (Array of objects) - The data for the related items.
        - **displayName** (string) - Display name of the related item.
        - **id** (string) - ID of the related item.
        - **jsonPath** (string) - JSON path to the related item.
        - **refid** (string) - Reference ID of the related item.
        - **type** (string) - Type of the related item.
        - **uri** (string) - URI of the related item.
      - **total** (integer) - Total number of related items available.
  - **type** (string) - The type of the resource.
  - **uri** (string) - The URI of the resource.

#### Response Example
```json
{
  "data": {
    "attributes": {
      "code": "string",
      "name": "string",
      "schemaConstraints": [
        {
          "constraints": [
            {
              "additionalInfoList": [
                {
                  "propertyName": "string",
                  "value": "string"
                }
              ],
              "constraintType": "string"
            }
          ],
          "exceptionSubtypes": [
            "string"
          ],
          "schema": "string"
        }
      ],
      "subtype": "string"
    },
    "checksum": "string",
    "id": "string",
    "links": {
      "property1": {
        "href": "string",
        "methods": [
          "string"
        ]
      },
      "property2": {
        "href": "string",
        "methods": [
          "string"
        ]
      }
    },
    "method": "string",
    "refid": "string",
    "related": {
      "property1": {
        "count": 0,
        "data": [
          {
            "displayName": "string",
            "id": "string",
            "jsonPath": "string",
            "refid": "string",
            "type": "string",
            "uri": "string"
          }
        ],
        "total": 0
      },
      "property2": {
        "count": 0,
        "data": [
          {
            "displayName": "string",
            "id": "string",
            "jsonPath": "string",
            "refid": "string",
            "type": "string",
            "uri": "string"
          }
        ],
        "total": 0
      }
    },
    "type": "string",
    "uri": "string"
  }
}
```
```
Tokens:
Raw