Queries

{warning} Die brshop24 API hat den Status "Work in progress". Bei dieser Dokumentation handelt sich um einen Vorabzug zu Testzwecken.

Queries, also Abfragen, sind dazu da um Daten aus dem System über die API zu gewinnen. Dazu gibt es eine grundsätzliche Syntax, die im folgenden kurz beschrieben werden soll.

• Einleitung
• Grundlegende Syntax

Grundlegende Syntax

Eine GraphQL Query kann, aber muss nicht, mit dem Schlüsselwort query eingeleitet werden. Darauf kann eine Bezeichnung der Query folgen und dann in geschweiften Klammern {} die eigentliche Abfrage.

query test {
    ...
}

Die eigentliche Abfrage besteht aus dem Abfragetypen, optional in runde Klammern () gesetzten Abfrageparametern und in geschweiften Klammern gesetzt den Feldern die aus diesem Typen abgefragt werden sollen.

query test {
    testQuery (where: {id:1}) {
        id
        testField
    }
}

Erweiterte Möglichkeiten

Felder in eine Query können unterschiedlichen Typen haben, Basistypen wie integer, string oder boolean, aber auch andere Typen wie Arrays aus Feldern oder zusammen gesetzte Typen.

query test {
    testQuery (where: {id:1}) {
        id
        testField
        testTyp {
            id
            typName
            typDaten {
                daten
                ...
            }
        }
    }
}