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 |
|---|---|
GET | Fordert die angegebene Ressource vom Server an. |
POST | 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. |
PUT | Die angegebene Ressource wird geändert. |
DELETE | Löscht die angegebene Ressource. |
Jede Ressourcen Anfrage braucht folgende Header:
Content-Type:application/x-www-form-urlencoded Authorization:$ACCESS_TOKEN
Folgende Möglichkeiten können abgefragt werden:
- Alle Datensätze einer Tabelle abfragen
- Datensätze in einer Tabelle abfragen anhand Kriterien
- Ressourcen#Tabelle leeren
- Ressourcen#Datensatz abfragen
- Ressourcen#Datensatz anlegen
- Datensatz löschen
- Ressourcen#Datensatz updaten
- Alle verknüpften Datensätze abfragen
- Alle Verknüpfungen zu Datensätzen einer Tabelle löschen
- Verknüpften Datensatz abfragen
- Verknüpften Datensatz anlegen
- Verknüpften Datensatz löschen
Lesen Sie hier mehr zu den Parametern.
Alle Datensätze einer Tabelle abfragen
GET
GET $YOUR_DOMAIN_URL/rest/v4/$COLLATION/resource/$IDENTIFIER/ Content-Type:application/x-www-form-urlencoded Authorization:$ACCESS_TOKEN
Datensätze in einer Tabelle abfragen anhand Kriterien
GET
GET $YOUR_DOMAIN_URL/rest/v4/$COLLATION/resource/$IDENTIFIER/?query=$QUERY Content-Type:application/x-www-form-urlencoded Authorization:$ACCESS_TOKEN
Tabelle leeren
DELETE
DELETE $YOUR_DOMAIN_URL/rest/v4/$COLLATION/resource/$IDENTIFIER/ Content-Type:application/x-www-form-urlencoded Authorization:$ACCESS_TOKEN
Datensatz abfragen
GET
GET $YOUR_DOMAIN_URL/rest/v4/$COLLATION/resource/$IDENTIFIER/$ID/ Content-Type:application/x-www-form-urlencoded Authorization:$ACCESS_TOKEN
Datensatz anlegen
POST
POST $YOUR_DOMAIN_URL/rest/v4/$COLLATION/resource/$IDENTIFIER/ Content-Type:application/x-www-form-urlencoded Authorization:$ACCESS_TOKEN $DATASET_VALUES
Datensatz löschen
DELETE
DELETE $YOUR_DOMAIN_URL/rest/v4/$COLLATION/resource/$IDENTIFIER/$ID/ Content-Type:application/x-www-form-urlencoded Authorization:$ACCESS_TOKEN
Datensatz updaten
PUT
PUT $YOUR_DOMAIN_URL/rest/v4/$COLLATION/resource/$IDENTIFIER/$ID/ Content-Type:application/x-www-form-urlencoded Authorization:$ACCESS_TOKEN $DATASET_VALUES
Alle verknüpften Datensätze abfragen
Eltern Datensätze
GET
GET $YOUR_DOMAIN_URL/rest/v4/$COLLATION/resource/$IDENTIFIER/$ID/parents-$PARENT_IDENTIFIER/ Content-Type:application/x-www-form-urlencoded Authorization:$ACCESS_TOKEN
Kind Datensätze
GET
GET $YOUR_DOMAIN_URL/rest/v4/$COLLATION/resource/$IDENTIFIER/$ID/children-$CHILDREN_IDENTIFIER/ Content-Type:application/x-www-form-urlencoded Authorization:$ACCESS_TOKEN
Alle Verknüpfungen zu Datensätzen einer Tabelle löschen
Kind Datensätze
DELETE
DELETE $YOUR_DOMAIN_URL/rest/v4/$COLLATION/resource/$IDENTIFIER/$ID/children-$CHILDREN_IDENTIFIER/ Content-Type:application/x-www-form-urlencoded Authorization:$ACCESS_TOKEN
Eltern Datensätze
DELETE
DELETE $YOUR_DOMAIN_URL/rest/v4/$COLLATION/resource/$IDENTIFIER/$ID/parents-$PARENT_IDENTIFIER/ Content-Type:application/x-www-form-urlencoded Authorization:$ACCESS_TOKEN
Verknüpften Datensatz abfragen
Kind Datensätze
GET
GET $YOUR_DOMAIN_URL/rest/v4/$COLLATION/resource/$IDENTIFIER/$ID/children-$CHILDREN_IDENTIFIER/$RELATION_ID/ Content-Type:application/x-www-form-urlencoded Authorization:$ACCESS_TOKEN
Eltern Datensätze
GET
GET $YOUR_DOMAIN_URL/rest/v4/$COLLATION/resource/$IDENTIFIER/$ID/parents-$PARENT_IDENTIFIER/$RELATION_ID/ Content-Type:application/x-www-form-urlencoded Authorization:$ACCESS_TOKEN
Verknüpften Datensatz anlegen
Kind Datensätze
POST
POST $YOUR_DOMAIN_URL/rest/v4/$COLLATION/resource/$IDENTIFIER/$ID/children-$CHILDREN_IDENTIFIER/$RELATION_ID/ Content-Type:application/x-www-form-urlencoded Authorization:$ACCESS_TOKEN $DATASET_VALUES
Eltern Datensätze
POST
POST $YOUR_DOMAIN_URL/rest/v4/$COLLATION/resource/$IDENTIFIER/$ID/parents-$PARENT_IDENTIFIER/$RELATION_ID/ Content-Type:application/x-www-form-urlencoded Authorization:$ACCESS_TOKEN $DATASET_VALUES
Verknüpften Datensatz löschen
Kind Datensätze
DELETE
DELETE $YOUR_DOMAIN_URL/rest/v4/$COLLATION/resource/$IDENTIFIER/$ID/children-$CHILDREN_IDENTIFIER/$RELATION_ID/ Content-Type:application/x-www-form-urlencoded Authorization:$ACCESS_TOKEN
Eltern Datensätze
DELETE
DELETE $YOUR_DOMAIN_URL/rest/v4/$COLLATION/resource/$IDENTIFIER/$ID/parents-$PARENT_IDENTIFIER/$RELATION_ID/ Content-Type:application/x-www-form-urlencoded Authorization:$ACCESS_TOKEN
Parameter
| 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 |