Paramètres de requête communs

Les endpoints de listage de WEEGLOO (les GET qui renvoient une collection, comme GET /spaces/{spaceId}/contents) acceptent des paramètres de requête communs. Avec ces paramètres, vous limitez le nombre d'éléments récupérés par page, vous définissez le critère de tri, vous récupérez les ressources associées en même temps, vous ne recevez que les champs nécessaires, vous restreignez la liste par condition et vous passez à la page suivante ou précédente.

Ces paramètres fonctionnent de la même manière quel que soit le type de ressource. Les références de chaque ressource ne décrivent que les conditions propres à cette ressource, et renvoient à cette page pour les paramètres communs traités ici.

Paramètres

Les types de champs sys utilisés dans order, select sont indiqués dans Propriétés système (sys).

Filtre

Les conditions de filtre ne sont pas encapsulées dans filter[], elles sont envoyées directement comme paramètres de requête. Le format est {champ}[{opérateur}]={valeur}, et si vous omettez l'opérateur, il est interprété comme eq. Pour l'ensemble des opérateurs utilisables, reportez-vous à Opérateurs ci-dessous.

{champ}[{opérateur}]={valeur}

Par exemple, pour ne récupérer que les éléments dont name commence par gourde, envoyez name[prefix]=gourde. Les règles et les points de vigilance sont les suivants.

• N'encapsulez pas les conditions dans filter[]. Une encapsulation comme filter[name[prefix]]=gourde ne fonctionne pas.
• Plusieurs conditions sont combinées par ET. Seuls les éléments qui les satisfont toutes sont conservés ; la recherche OU, où il suffit qu'une seule de plusieurs conditions soit satisfaite, n'est pas prise en charge. Pour faire correspondre l'une de plusieurs valeurs sur un même champ, utilisez in.
• Une condition fields. inclut la locale. Par exemple, fields.file.ko-KR.mimeGroups=Image ne conserve que les fichiers image dans une liste de Media, et sys.createdAt[gte]=2026-06-01T00:00:00Z ne conserve que les éléments créés après ce moment.
• Filtrer ou trier une liste de Content par une condition fields. requiert aussi le Content Type. Vous devez envoyer en même temps sys.contentType.sys.id (uniquement pour la liste plate /contents) ; un simple contentType= ne s'y substitue pas. Pour les détails, reportez-vous à la référence Content.

Opérateurs

Les champs RichText et Json ne sont pas indexés pour la recherche et ne peuvent donc pas être utilisés dans les conditions de filtre.

Recherche avancée (Advanced Search)

Les opérateurs regex, near, within ainsi que la recherche plein texte sur le texte ne fonctionnent qu'avec la recherche avancée. La recherche avancée s'active en ajoutant l'en-tête X-Weegloo-Advanced-Search: true à la requête de listage, et la réponse renvoie le même en-tête.

• Recherche plein texte : si vous utilisez eq sur un champ texte (LongText) pour lequel la recherche plein texte est activée, la requête ne trouve pas seulement les éléments dont la valeur est exactement identique, mais aussi ceux qui contiennent cette valeur, par correspondance partielle ou approchée. Si la recherche avancée n'est pas activée ou si votre offre ne propose pas la recherche avancée, le même eq fonctionne en correspondance exacte.
• Recherche Location : near (rayon) et within (polygone) s'utilisent uniquement sur les champs Location et ne fonctionnent qu'avec la recherche avancée.
• Si vous envoyez regex, near ou within dans une requête où la recherche avancée n'est pas disponible, ils ne sont pas acceptés.

Pagination (curseur)

Le corps de la réponse de listage contient un objet links, qui inclut next, prev. links.next est le chemin complet vers la page suivante.

/v1/spaces/HnQ32YiH/contents?limit=15&next=<curseur>

Il y a deux façons de récupérer la page suivante. Vous appelez directement le chemin links.next, ou vous extrayez la valeur du curseur next depuis links.next et vous la passez comme paramètre next de la requête suivante. S'il n'y a pas de links.next, c'est la dernière page. Pour la page précédente, vous procédez de la même manière avec links.prev.

N'augmentez pas skip pour passer d'une page à l'autre. Si des éléments sont ajoutés ou supprimés entre les listages, la position de skip se décale et des éléments peuvent être omis ou dupliqués. Le curseur (next, prev) ne présente pas ce problème.

Voici un exemple de structure d'une réponse de listage. Le sys.type de l'enveloppe est TotalPageResponse, items contient le tableau d'éléments et links contient les chemins de navigation.

{
  "sys": { "type": "TotalPageResponse" },
  "limit": 15,
  "totalCount": 42,
  "items": [
    {
      "sys": {
        "id": "3trmXRM3RqbgSnifyg7PUl8DzDgDzP",
        "type": "Content",
        "space": { "sys": { "id": "HnQ32YiH", "type": "Refer", "targetType": "Space" } },
        "createdAt": "2026-06-18T09:51:14.597Z",
        "updatedAt": "2026-06-18T09:51:44.128Z",
        "version": 2,
        "status": "Published"
      }
    }
  ],
  "links": {
    "self": "/v1/spaces/HnQ32YiH/contents?limit=15",
    "next": "/v1/spaces/HnQ32YiH/contents?limit=15&next=Q3Vyc29yVmFsdWU"
  }
}

totalCount est le nombre total d'éléments correspondant à la condition, et limit est la taille de page appliquée à cette réponse. items ne contient que les éléments correspondant à cette page.

Documents connexes

• Propriétés système (sys) : les champs sys utilisés dans order, select.
• Conventions : type de média, JSON Patch, concurrence.