Tri

JSON:API permet de récupérer plusieurs ressources dans une seule requête, ces routes sont appelées routes de « collection ». On peut récupérer une collection de ressources en envoyant une requête GET à la route de base de la ressource, par exemple GET /jsonapi/node/article, sans inclure un UUID. Par défaut, cela inclura toutes les ressources du type spécifié.

Le filtrage et le tri sont disponibles par défaut sur toutes les ressources standard.

En-têtes

Les en-têtes suivants sont obligatoires sur toutes les requêtes GET pour obtenir une requête et réponse JSON:API correcte.

• Accept: application/vnd.api+json

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

L’en-tête suivant est nécessaire pour que les exemples fonctionnent :

• Authorization: Basic YXBpOmFwaQ==

Tri des collections

Tri par la date de création ('created')

Triez une collection par son horodatage "created" (tri par ordre croissant par défaut)

COURT
sort=created

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

Tri par nom d’utilisateur de l’auteur

Triez une collection par le nom d’utilisateur de l’auteur, en ordre décroissant. Notez que le signe moins (-) indique un ordre décroissant.

COURT
sort=-uid.name

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

Tri par plusieurs champs

Triez une collection par plusieurs champs.

COURT
sort=-created,uid.name

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

Article extrait de la documentation Drupal.