Ressourcen

Owned by Philipp Frick
Last updated: März 12, 2024 by Sebastian Schulz
2 min read

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

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:

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

Datensatz abfragen
GET

Datensatz anlegen
POST

Datensatz löschen
DELETE

Datensatz updaten
PUT

Alle verknüpften Datensätze abfragen

Eltern Datensätze
GET

Kind Datensätze
GET

Alle Verknüpfungen zu Datensätzen einer Tabelle löschen

Kind Datensätze
DELETE

Eltern Datensätze
DELETE

Verknüpften Datensatz abfragen

Kind Datensätze
GET

Eltern Datensätze
GET

Verknüpften Datensatz anlegen

Kind Datensätze
POST

Eltern Datensätze
POST

Verknüpften Datensatz löschen

Kind Datensätze
DELETE

Eltern Datensätze
DELETE



Parameter

Parameter Name

Erläuterung

Beispiel

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
shopArticleActive:1
shopArticleDescription:Beschreibung

$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