Gemeinsame Query-Parameter

Die Listen-Endpunkte von WEEGLOO (also GET-Anfragen, die eine Sammlung zurückgeben, wie GET /spaces/{spaceId}/contents) akzeptieren gemeinsame Query-Parameter. Mit diesen Parametern begrenzen Sie die Anzahl der pro Seite abgerufenen Einträge, legen die Sortierung fest, rufen verknüpfte Ressourcen mit ab, beschränken die Antwort auf die benötigten Felder, grenzen die Liste über Bedingungen ein und navigieren zur nächsten oder vorherigen Seite.

Diese Parameter verhalten sich unabhängig vom Ressourcentyp auf dieselbe Weise. Die Referenz der einzelnen Ressourcen beschreibt nur deren ressourcenspezifische Bedingungen gesondert; für die hier behandelten gemeinsamen Parameter verweist sie auf diese Seite.

Parameter

Welche sys-Felder in order und select verwendet werden können, finden Sie unter Systemeigenschaften (sys).

Filter

Filterbedingungen werden nicht in filter[] eingeschlossen, sondern direkt als Query-Parameter gesendet. Das Format lautet {Feld}[{Operator}]={Wert}, und wird der Operator weggelassen, wird er als eq interpretiert. Alle verwendbaren Operatoren finden Sie unten unter Operatoren.

{Feld}[{Operator}]={Wert}

Um beispielsweise nur Einträge abzurufen, deren name mit Thermobecher beginnt, senden Sie name[prefix]=Thermobecher. Es gelten die folgenden Regeln und Hinweise.

• Bedingungen werden nicht in filter[] eingeschlossen. Ein Einschließen wie bei filter[name[prefix]]=Thermobecher funktioniert nicht.
• Mehrere Bedingungen werden mit AND verknüpft. Es bleiben nur die Einträge übrig, die alle erfüllen. Eine OR-Suche, bei der das Erfüllen nur einer von mehreren Bedingungen ausreicht, wird nicht unterstützt. Um in einem einzelnen Feld einen von mehreren Werten zu treffen, verwenden Sie in.
• Eine fields.-Bedingung enthält die Locale. Zum Beispiel behält fields.file.ko-KR.mimeGroups=Image in einer Media-Liste nur Bilddateien, und sys.createdAt[gte]=2026-06-01T00:00:00Z behält nur Einträge, die nach diesem Zeitpunkt erstellt wurden.
• Das Filtern oder Sortieren einer Content-Liste nach einer fields.-Bedingung erfordert zusätzlich den Content Type. Senden Sie sys.contentType.sys.id mit (nur bei der flachen /contents-Liste); ein bloßes contentType= ersetzt dies nicht. Einzelheiten finden Sie in der Content-Referenz.

Operatoren

RichText- und Json-Felder sind nicht durchsuchbar und können daher nicht in Filterbedingungen verwendet werden.

Erweiterte Suche (Advanced Search)

Die Operatoren regex, near und within sowie die Volltextsuche in Texten funktionieren nur mit der erweiterten Suche. Die erweiterte Suche aktivieren Sie, indem Sie der Listenabfrage den Header X-Weegloo-Advanced-Search: true hinzufügen; derselbe Header wird auch in der Antwort mitgeführt.

• Volltextsuche: Verwenden Sie eq auf einem Textfeld (LongText), für das die Volltextsuche aktiviert ist, werden nicht nur exakt übereinstimmende Werte gefunden, sondern über Teil- und Ähnlichkeitstreffer auch Einträge, die diesen Wert enthalten. Ist die erweiterte Suche nicht aktiviert oder bietet der Tarif keine erweiterte Suche, arbeitet dasselbe eq als exakte Übereinstimmung.
• Location-Suche: near (Radius) und within (Polygon) werden nur auf Location-Feldern verwendet und funktionieren nur mit der erweiterten Suche.
• Werden regex, near oder within in einer Anfrage gesendet, in der die erweiterte Suche nicht verfügbar ist, werden sie nicht akzeptiert.

Paginierung (Cursor)

Der Antworttext einer Liste enthält ein links-Objekt, in dem next und prev enthalten sind. links.next ist der vollständige Pfad zur nächsten Seite.

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

Es gibt zwei Möglichkeiten, die nächste Seite abzurufen. Sie rufen den Pfad links.next unverändert auf oder Sie entnehmen aus links.next den Wert des next-Cursors und übergeben ihn als next-Parameter der nächsten Anfrage. Fehlt links.next, ist es die letzte Seite. Zur vorherigen Seite navigieren Sie auf dieselbe Weise über links.prev.

Erhöhen Sie beim Blättern nicht den Wert von skip. Werden zwischen den Listenabrufen Einträge hinzugefügt oder gelöscht, verschiebt sich die skip-Position, sodass Einträge fehlen oder doppelt erscheinen können. Beim Cursor (next, prev) tritt dieses Problem nicht auf.

Im Folgenden ein Beispiel für die Struktur einer Listenantwort. Der sys.type des Wrappers ist TotalPageResponse, in items steht das Array der Einträge und in links stehen die Navigationspfade.

{
  "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 ist die Gesamtzahl der Einträge, die der Bedingung entsprechen, und limit ist die auf diese Antwort angewandte Seitengröße. In items sind nur die zu dieser Seite gehörenden Einträge enthalten.

Verwandte Dokumente

• Systemeigenschaften (sys): Die sys-Felder, die in order und select verwendet werden.
• Konventionen: Medientyp, JSON Patch, Nebenläufigkeit.