Versionen im Vergleich

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.

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-MethodeBeschreibung

Status
colourGrey
titleGET

Fordert die angegebene Ressource vom Server an.

Status
colourGrey
titlePOST

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.

Status
colourGrey
titlePUT

Die angegebene Ressource wird geändert.

Status
colourGrey
titleDELETE

Löscht die angegebene Ressource.

Jede Ressourcen Anfrage braucht folgende Header:

...

Parameter NameErläuterungBeispiel
$COLLATIONDie Kollation setzt sich aus dem ISO 639-1 Sprachcode sowie dem ISO_3166-1 Ländercode zusammende_DE
$IDENTIFIERDer Tabellen Identifier aus dem angefragtem brandbox Zielsystem. Verfügbare Identifier abfragenshopArticle
$ACCESS_TOKENAuthentifizierung
$QUERYDoctrine Simple Conditions als JSON Objekt.

{"shopArticleName":"%Sony%"}

oder

{"id": ["2","4"]}

$DATASET_VALUESFormular Body der Anfrage mit den Werten die auf den Datensatz gemapped werden

shopArticleName:Neuer Artikel
shopArticleActive:1
shopArticleDescription:Beschreibung

$IDID des Datensatzes15

$PARENT_IDENTIFIER

Der Tabellen Identifier der Eltern TabelleshopGroup
$CHILD_IDENTIFIERDer Tabellen Identifier der Kind TabelleshopGroup
$RELATION_IDID des verknüpften Datensatzes33

...