Composite requests

From a Cloud API perspective, a composite request is a set of requests that are executed in a single InsuranceSuite bundle (which corresponds to a single database transaction).

• A composite request can include one or more subrequests that create or modify data. Either all of the subrequests succeed, or none of them are executed. Each subrequest is a separate unit of work.
• A composite request can also include one or more subselections that query for data.
  • If the composite request has one or more subrequests, the subselections can retrieve data created or modified by those subrequests.
  • A composite request can also have no subrequests. In this case, the subselections merely execute multiple queries to retrieve existing data.

Subrequests and subresponses are executed serially, in the order they are specified in the composite request payload. ClaimCenter then gathers the response to each subrequest and subselection and returns them in a single response payload. The responses to each subrequest and subselection appear in the same order as the original composite request.

Composite requests can make use of variables. This allows data created by the execution of one subrequest to be used by later subrequests.

Composite requests can consist entirely of subrequests that merely retrieve data. For more information, see Composite requests that execute only queries.

Composite requests support the use of most endpoints, but not all of them. They also support many query parameters, but not all of them. For more information, see Composite request limitations.

Composite requests can be submitted asynchronously. For more information, see Asynchronous calls.

Composite requests are limited to a maximum number of subrequests. For more information, see Configuring the maximum number of subrequests.