Schema Scopes

Schemas are used with different scopes. Properties may be applicable only for a subset of the scopes depending on the characteristics of the property or the API design. The four scopes are discussed below.

RETURNABLE

Returnable properties are the properties that are included in feature representations when features are fetched. By default, all properties are returnable unless the property is explicitly excluded. Eligible properties may be explicitly excluded, for example, if the property should be used only in queries (as a queryable or sortable), but never coded in the features themselves.

RECEIVABLE

Receivable properties are the properties that may be included in feature representations when features are created or updated. By default, all properties are receivable unless the property is constant or explicitly excluded. Eligible properties may be explicitly excluded, for example, if the property is derived or uses a different representation in the data store than in the response.

QUERYABLE

Queryable properties are the properties that may be used in filter expressions. By default, all properties may be queryable unless the property is explicitly excluded, uses concat / coalesce, or is of type OBJECT / OBJECT_ARRAY. Eligible properties may be explicitly excluded, for example, if the property is not optimized for use in queries.

SORTABLE

Sortable properties are the properties that may be used to sort features in responses. By default, all direct properties of a feature type that are of type STRING, FLOAT, INTEGER, DATE, or DATETIME may be sortable unless the property is explicitly excluded, or uses concat / coalesce. Eligible properties may be explicitly excluded, for example, if the property is not optimized for use in queries.