Mutations

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

Mutations beschreiben in GraphQL die Möglichkeit Daten zu verändern. Das kann ein Erstellen, Verändern oder auch Löschen sein.

• Einleitung
• Aufbau von Mutations
• Create Mutation
• Update Mutation
• Delete Mutation

Aufbau von Mutations

Mutations sind ähnlich aufgebaut wie Queries, allerdings muss hier immer das einleitende Schlüsselwort mutation benutzt werden. Darauf kann, wie bei Queries eine Bezeichner folgen und dann in geschweiften Klammern {} die eigentliche Mutation.

mutation testMutation {
    ...
}

Die Mutation besteht dann aus dem Typen, den Daten die übergeben werden sollen in runden Klammern () und den Feldern die abgefragt werden sollen in geschweiften Klammern {}.

mutation testMutation {
    updateTest (...) {
        ...
    }
}

Create Mutation

Eine Create Mutation dient zum Erstellen von neuen Daten. Dabei ist entsprechend die Übergabe einer Bendingung die den Datensatz ermittelt nicht notwendig.

mutation createPage {
    createPage (data: {title: "Überschrift", body: "Langtext"})
    {
        id
    }
}    

Update Mutation

Bei einer Update Mutation muss entsprechend der Datensatz, der geändert werden soll, ausgewählt werden. Dies geschieht über einen where-Abschnitt in den Parametern. Zudem müssen hier die Daten die verändert werden sollen in einem data-Abschnitt übergeben werden.

mutation updatePost {
    updatePost (
        data: {
            title: "the english post"
            body: "an english text"
        }
        where: {
            id: 18
        }
    ) {
        title
        body
    }

}

Delete Mutation

Delete Mutations benötigen nur die Auswahl des Datensatzes per where-Parameter, Daten müssen hier nicht übergeben werden.

mutation deleteArticle {
    deleteArticle (where: { id: 18})
    {
        id
    }
}