Skip to main content

Common API (1.6.0)

APIs for common InsuranceSuite platform objects like activities and notes

Retrieve the OpenAPI 3.0 schema for this API

Retrieves the OpenAPI 3.0 schema for this API

gw-resourceType: CommonOpenApiSchema
Authorizations:
query Parameters
enablePolymorphism
boolean
Default: true

Whether or not to use the discriminator/oneOf pattern to output schemas in cases where the valid set of fields can vary based on some attribute of the data such as the country or subtype. Defaults to true. See the documentation for more information.

filterByUser
boolean
Default: false

Whether or not to filter endpoints and schema properties by the authorization of the caller. Defaults to false.

omitInclusions
boolean
Default: false
gw-sinceVersion: 1.4.0

Whether or not to omit the included properties on request and response schemas. Defaults to false. See the documentation for more information. (Since 1.4.0)

prettyPrint
boolean
Default: false

Whether or not to pretty-print the returned schema, making it larger but more human readable. Defaults to false.

Responses

Response samples

Content type
application/json
"string"