Schema-Anwendungsbereiche

Schemas werden mit unterschiedlichen Anwendungsbereichen verwendet. Objekteigenschaften können je nach den Merkmalen der Eigenschaft oder dem API-Design nur für eine Teilmenge der Bereiche anwendbar sein. Die vier Anwendungsbereiche werden im Folgenden erläutert.

RETURNABLE

Rückgabefähige Eigenschaften sind die Eigenschaften, die in Feature-Darstellungen enthalten sind, wenn Features abgerufen werden. Standardmäßig sind alle Eigenschaften rückgabefähig, es sei denn, die Eigenschaft wird explizit ausgeschlossen. In Frage kommende Eigenschaften können explizit ausgeschlossen werden, z. B. wenn die Eigenschaft nur in Abfragen verwendet werden soll (als Queryable oder Sortable), aber niemals in den Features selbst kodiert werden soll.

RECEIVABLE

Empfangbare Eigenschaften sind die Eigenschaften, die in Feature-Darstellungen enthalten sein können, wenn Features erzeugt oder aktualisiert werden. Standardmäßig sind alle Eigenschaften empfangbar, es sei denn, die Eigenschaft ist konstant oder explizit ausgeschlossen. In Frage kommende Eigenschaften können explizit ausgeschlossen werden, z.B. wenn die Eigenschaft abgeleitet ist oder eine andere Darstellung im Datenspeicher als in der Antwort verwendet.

QUERYABLE

Abfragbare Eigenschaften sind die Eigenschaften, die in Filterausdrücken verwendet werden können. Standardmäßig können alle Eigenschaften abgefragt werden, es sei denn, die Eigenschaft ist explizit ausgeschlossen, verwendet concat / coalesce oder ist vom Typ OBJECT / OBJECT_ARRAY. In Frage kommende Eigenschaften können explizit ausgeschlossen werden, zum Beispiel, wenn die Eigenschaft nicht für die Verwendung in Abfragen optimiert ist.

SORTABLE

Sortierbare Eigenschaften sind die Eigenschaften, die zum Sortieren von Features in Antworten verwendet werden können. Standardmäßig können alle direkten Eigenschaften einer Objektart, die vom Typ STRING, FLOAT, INTEGER, DATE oder DATETIME sind, sortierbar sein, es sei denn, die Eigenschaft wird explizit ausgeschlossen oder verwendet concat / coalesce. In Frage kommende Eigenschaften können explizit ausgeschlossen werden, zum Beispiel wenn die Eigenschaft nicht für die Verwendung in Abfragen optimiert ist.