Schema properties overview

A list of logical actions that you can take on an entity. This encompasses standard HTTP operations on the element or collection, as well as custom actions.

A product definition property that references the answer schema definition. Only available when the inlineProductDefinition query parameter is set to true.

For entities that can be accessed through a Cloud API endpoint, this object contains the URI to the collection endpoint.

For entities that can be accessed through a Cloud API endpoint, this object contains the URI to the individual element endpoint.

For entities that can be accessed through a Cloud API endpoint, this object contains the ID of the parent entity.

An object whose keys represent schema properties that have dynamic values. Dynamic values are calculated based on evaluation of static values retrieved through JsonLogic.

An object containing information about child objects of an entity.

This property contains typelist values associated with the entity objects. It is included in the schema response when the inlineTypelists query parameter is set to true.

A property attached to the coverage in the schema. It provides a coverage code, description, name, and sort order.

A product definition property that references the coverage schema definition. Only available when the inlineProductDefinition query parameter is set to true.

This property differentiates address information for a covered location from LOB-specific additions.

This property contains an array of one or more values that indicate properties that are forbidden for use in a particular context. Often used within an x-gw-rules object to identify fields that cannot be used in certain situations.

• Forbidden and required fields
• Country-specific fields
• Coverage parent/child dependencies

When the

If an entity is associated with a policy line, this property contains the ID and name of the policy line.

x-gw-owningProducts

If an entity is LOB-specific, this property will display an ID and name of all products associated with the entity.

This property identifies fields that are required for a particular entity to be valid. A typical use case is to define required fields in an address.

• Forbidden and required fields
• Country-specific fields

This property contains a jsonLogic attribute where you can apply conditional rules to various schema elements.

• Rules
• Country-specific fields
• Coverage parent/child dependencies
• Tags

A product definition property that references the scheduled items schema definition. Only available when the inlineProductDefinition query parameter is set to true.

Contains a Boolean value specifying whether the entity is based off of a segment field in APD.

The sequence number of coverable fields defined in APD.

• Sort order
• Choice values

This object represents tags that have been attached to clauses, clause terms, and so on in APD.

This property provides the name of the property that stores a term, scheduled item property, or answer value.