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.

Applies to properties of format date or date-time. Indicates a date or date-time that the value must be later than.

Applies to properties of format date or date-time. Indicates a date or date-time that the value must be earlier than.

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.

Indicates that a property can be set when creating the entity (during an initial POST), but not modified.

An array of strings that indicate what default views a property will appear in. Possible values include detail, summary, and none.

An object where each key in the map represents a named rule. The values of such keys have a jsonLogic object defining the rules.

A marker on every schema that corresponds to an entity that contains the id of that entity.

Applies to typekey properties that have typelists that are filtered by categories from other typelists represented on the same object. This property is an array of schema property names for the filtering typekey properties.

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 fields
• Country-specific fields

When the

Used to represent a maximum value for a property that is not a standard JSON integer or decimal, such as a gw-bigdecimal or MonetaryAmount object.

Used to represent a minimum value for a property that is not a standard JSON integer or decimal, such as a gw-bigdecimal or MonetaryAmount object.

Indicates that the value can be set only during updates (PATCH requests), not during the initial creation (POST request).

The precision of a fixed-point decimal value (the total number of digits allowed in a number).

The name of the schema definition associated with a given type when a property is a reference (such as SimpleReference).

The name of the referenced entity type when a property is a reference (such as SimpleReference).

An array of property names for properties whose values must be specified as part of POST requests to create a new 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.

• Required properties
• Country-specific fields

A marker attached to schema definitions such as SimpleReference that indicates that the schema represents a reference to another entity.

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

• Rules
• Country-specific fields

The scale of a fixed-point decimal value (the number of digits allowed to the right of the decimal point).

The sequence number of coverable fields defined in APD.

• Sort order
• Choice values

The name of the typelist when the property is a reference to a TypeKeyReference.