ldproxy

Sorting

specdraftimplproposal

Sortieren von Features in Rückgaben.

Umfang

Konformitätsklassen

Das Modul implementiert die Konformitätsklasse "Sorting" des Entwurfs von OGC API - Records - Part 1: Coreopen in new window.

Operationen

RessourcePfadMethodenFormateBeschreibung
Sortables
collections/{collectionId}/sortables
GET
HTML, JSON
Die Sortables-Ressource identifiziert die Eigenschaften, auf die im Parameter "sortby" Bezug genommen werden kann, um die Features in der Antwort zu ordnen. Die Antwort wird als JSON-Schema-Dokument zurückgegeben, das ein einzelnes JSON-Objekt beschreibt, bei dem jede Eigenschaft ein Sortable ist. Beachten Sie, dass das Sortables-Schema kein Schema eines Objekts angibt, das über die API abgerufen werden kann. JSON Schema wird für die Sortables verwendet, um einen konsistenten Ansatz für die Beschreibung von Schemainformationen zu haben. JSON Schema wird in anderen Teilen der API außerdem dazu verwendet, um das Schema für JSON-Antwortdokumente zu beschreiben, einschließlich in OpenAPI-Dokumenten.

Query Parameter

NameRessourcenBeschreibung
sortby
Features
Ist der Parameter angegeben, werden die Features sortiert zurückgegeben. Sortiert wird nach den in einer kommaseparierten Liste angegebenen Attributen. Dem Attributnamen kann ein + (aufsteigend, das Standardverhalten) oder ein - (absteigend) vorangestellt werden. Beispiel: sortby=type,-name.
f
Sortables
Wählt das Ausgabeformat der Antwort. Wenn kein Wert angegeben wird, gelten die Standard-HTTP Regeln, d.h. der "Accept"-Header wird zur Bestimmung des Formats verwendet.

Konfiguration

Optionen

NameDefaultBeschreibungTypSeit
buildingBlock
Immer SORTING.
string
v2.0
extensionType
Deprecated Siehe buildingBlock.
string
v2.0
enabled
false
Soll das Modul aktiviert werden?
boolean
v2.0
sortables
[]
Deprecated Ersetzt durch included. Steuert, welche der Attribute in Queries für die Sortierung von Daten verwendet werden können. Erlaubt sind nur direkte Attribute (keine Attribute aus Arrays oder eingebetteten Objekten) der Datentypen STRING, DATE, DATETIME, INTEGER und FLOAT.
array
v2.0
included
[]
Ersetzt durch included. Steuert, welche der Attribute in Queries für die Sortierung von Daten verwendet werden können. Als Sortables kommen nur direkte Attribute (keine Attribute aus Arrays oder eingebetteten Objekten) der Datentypen STRING, DATE, DATETIME, INTEGER und FLOAT in Frage, es sei denn isSortable ist für die Eigenschaft auf false gesetzt. Der spezielle Wert * schließt alle infrage kommenden Eigenschaften als sortierbar ein. Standardmäßig ist keine Eigenschaft sortierbar (dies dient der Abwärtskompatibilität, in v4.0 wird das Standardverhalten auf alle infrage kommenden Eigenschaften geändert werden).
array
v3.4
excluded
[]
Die Liste der Eigenschaften, die aufgrund von included sortierbar wären, aber nicht sortierbar sein sollen.
array
v3.4
pathSeparator
DOT
Das Zeichen, das im Falle von objektwertigen Eigenschaften als Pfadseparator verwendet wird. Entweder DOT (Punkt) oder UNDERSCORE (Unterstrich).
string
v3.4

Beispiele


- buildingBlock: SORTING
  enabled: true
  included:
  - name
  - function
  - height
ImpressumDatenschutzerklärung