Die REST-API bietet die Möglichkeit mit Hilfe der HTTP-Methoden Ressourcen der Datenbank abzufragen, zu verändern, löschen oder zu erstellen. Die verschiedenen Anfragen liefern das Ergebnis im JSON Format zurück.
| HTTP-Methode | Beschreibung | ||||||
|---|---|---|---|---|---|---|---|
| Fordert die angegebene Ressource vom Server an. | ||||||
| Fügt eine neue (Sub-)Ressource unterhalb der angegebenen Ressource ein. Da die neue Ressource noch keinen URI besitzt, adressiert der URI die übergeordnete Ressource. | ||||||
| Die angegebene Ressource wird geändert. | ||||||
| Löscht die angegebene Ressource. |
Jede Ressourcen Anfrage braucht folgende Header:
...
- Alle Datensätze einer Tabelle abfragen
- Datensätze in einer Tabelle abfragen anhand Kriterien
- Tabelle leeren
- Datensatz abfragen
- Datensatz anlegen
- Datensatz löschen
- Datensatz updaten
- Alle verknüpften Datensätze abfragen
- Alle verknüpften Datensätze Verknüpfungen zu Datensätzen einer Tabelle löschen
- Verknüpften Datensatz abfragen
- Verknüpften Datensatz anlegen
- Verknüpften Datensatz löschen
...
| Parameter Name | Erläuterung | Beispiel |
|---|---|---|
| $COLLATION | Die Kollation setzt sich aus dem ISO 639-1 Sprachcode sowie dem ISO_3166-1 Ländercode zusammen | de_DE |
| $IDENTIFIER | Der Tabellen Identifier aus dem angefragtem brandbox Zielsystem. Verfügbare Identifier abfragen | shopArticle |
| $ACCESS_TOKEN | Authentifizierung | |
| $QUERY | Doctrine Simple Conditions als JSON Objekt. | {"shopArticleName":"%Sony%"} oder {"id": ["2","4"]} |
| $DATASET_VALUES | Formular Body der Anfrage mit den Werten die auf den Datensatz gemapped werden | shopArticleName:Neuer Artikel |
| $ID | ID des Datensatzes | 15 |
$PARENT_IDENTIFIER | Der Tabellen Identifier der Eltern Tabelle | shopGroup |
| $CHILD_IDENTIFIER | Der Tabellen Identifier der Kind Tabelle | shopGroup |
| $RELATION_ID | ID des verknüpften Datensatzes | 33 |
...