Sortierung

JSON:API ermöglicht es, mehrere Ressourcen in einer einzigen Anfrage abzurufen. Diese Routen werden als „Sammlungsrouten“ bezeichnet. Eine Sammlung von Ressourcen kann durch das Senden einer GET-Anfrage an die Basisressourcen-Route abgerufen werden, z.B. GET /jsonapi/node/article – dabei wird keine UUID angegeben. Standardmäßig werden so alle Ressourcen des angegebenen Typs zurückgegeben.

Filtern und Sortieren sind standardmäßig für alle normalen Ressourcen verfügbar.

Header

Die folgenden Header sind bei allen GET-Anfragen erforderlich, um eine korrekte JSON:API-Anfrage und -Antwort zu erhalten.

• Accept: application/vnd.api+json

• Content-Type: application/vnd.api+json

Für die Beispielanfragen wird außerdem folgender Header benötigt:

• Authorization: Basic YXBpOmFwaQ==

Sortieren von Sammlungen

Sortieren nach "created"

Eine Sammlung nach dem "created"-Zeitstempel sortieren (standardmäßig aufsteigend sortiert):

KURZ
sort=created

NORMAL
sort[sort-created][path]=created

Sortieren nach Benutzername des Autors

Eine Sammlung nach dem Benutzernamen des Autors sortieren, absteigend. Das Minuszeichen (-) davor gibt die absteigende Reihenfolge an.

KURZ
sort=-uid.name

NORMAL
sort[sort-author][path]=uid.name
sort[sort-author][direction]=DESC

Sortieren nach mehreren Feldern

Eine Sammlung nach mehreren Feldern sortieren:

KURZ
sort=-created,uid.name

NORMAL
sort[sort-created][path]=created
sort[sort-created][direction]=DESC
sort[sort-author][path]=uid.name

Artikel von Drupal Documentation.