Search treaties

get

https://{host}/platform/riskdata/v1/exposures/{exposureId}/treaties

Returns a list of treaties.

This operation supports response filtering based the value of a subset of properties. Depending on the property, you may use a combination of comparison operators, list operators, and logical operators.

To learn more, see Response Filtering.

Path Params

exposureId

int64

required

≥ 1

ID of EDM.

Query Params

filter

string

Query string to select response data based on property values.

Property	Type	Comparison
`aggregateDeductible`	Number	`=`, `!=`, `<=`, `>=`, `>`, `<`
`aggregateLimit`	Number	`=`, `!=`, `<=`, `>=`, `>`, `<`
`attachmentBasis`	String	`=`, `!=`,`LIKE`, `NOT LIKE`
`attachmentLevel`	String	`=`, `!=`,`LIKE`, `NOT LIKE`
`attachmentPoint`	Number	`=`, `!=`, `<=`, `>=`, `>`, `<`
`cedant`	String	`=`, `!=`, `LIKE`, `NOT LIKE`
`currency`	String	`=`, `!=`, `LIKE`, `NOT LIKE`
`isValid`	Boolean	`=`, `!=`
`maolAmount`	Number	`=`, `!=`, `<=`, `>=`, `>`, `<`
`numberOfReinstatements`	Number	`=`, `!=`, `<=`, `>=`, `>`, `<`
`occurrenceLimit`	Number	`=`, `!=`, `<=`, `>=`, `>`, `<`
`percentageCovered`	Number	`=`, `!=`, `<=`, `>=`, `>`, `<`
`percentagePlaced`	Number	`=`, `!=`, `<=`, `>=`, `>`, `<`
`percentageRetention`	Number	`=`, `!=`, `<=`, `>=`, `>`, `<`
`percentageRiShare`	Number	`=`, `!=`, `<=`, `>=`, `>`, `<`
`premium`	Number	`=`, `!=`, `<=`, `>=`, `>`, `<`
`priority`	Number	`=`, `!=`, `<=`, `>=`, `>`, `<`
`producer`	String	`=`, `!=`, `LIKE`, `NOT LIKE`
`reinstatementCharge`	Number	`=`, `!=`, `<=`, `>=`, `>`, `<`
`retentionAmount`	Number	`=`, `!=`, `<=`, `>=`, `>`, `<`
`riskLimit`	Number	`=`, `!=`, `<=`, `>=`, `>`, `<`
`treatyId`	Number	`=`, `!=`, `<=` `>=` `>` `<`
`treatyName`	String	`=`, `!=`, `LIKE`, `NOT LIKE`
`treatyNumber`	String	`=`, `!=`, `LIKE`, `NOT LIKE`
`treatyType`	String	`=`, `!=`, `LIKE`, `NOT LIKE`
`userId1`	String	`=`, `!=`, `LIKE`, `NOT LIKE`
`userId2`	String	`=`, `!=`, `LIKE`, `NOT LIKE`

All parameter support the IN, NOT IN list operators and the AND and OR logical operators. See Filtering Responses.

sort

string

Comma-delimited list of properties. Sort order defined by one of ASC (ascending) or DESC (descending).

Supported properties: aggregateDeductible, aggregateLimit, attachmentBasis, attachmentLevel, attachmentPoint, currency, isValid, maolAmount, numberOfReinstatements, occurrenceLimit, percentageCovered, percentagePlaced, percentageRetention, percentageRiShare, premium, priority, reinstatementCharge, retentionAmount, riskLimit, treatyId, treatyName, treatyNumber, treatyType, userId1, userId2

See Response Pagination.

limit

int32

Number of records returned per page. See Response Pagination

offset

int32

Number of the page displaying the returned records, starting at 0

Responses

Language

Credentials

URL

Loading…

Response

Choose an example:

application/json

200List of treaties retrieved.

400Bad Request

401Unauthorized

403Forbidden

404The requested resource was not found.

500Internal Server Error