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

Beschreibung

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:

...

Folgende Möglichkeiten können abgefragt werden:

Lesen Sie hier mehr zu den Parametern.

Alle Datensätze einer Tabelle abfragen

Status
colourGrey
titleGET

Codeblock
languagebash
GET $YOUR_DOMAIN_URL/rest/v4/$COLLATION/resource/$IDENTIFIER/
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN

Anker
Datensätze in einer Tabelle abfragen anhand Kriterien
Datensätze in einer Tabelle abfragen anhand Kriterien
Datensätze in einer Tabelle abfragen anhand Kriterien
Status

...

titleGET

Codeblock
languagebash
GET $YOUR_DOMAIN_URL/rest/v4/$COLLATION/resource/$IDENTIFIER/?query=$QUERY
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN

Anker
Tabelle leeren
Tabelle leeren
Tabelle leeren
Status

...

titleDELETE

Codeblock
languagebash
DELETE $YOUR_DOMAIN_URL/rest/v4/$COLLATION/resource/$IDENTIFIER/
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN

Anker
Datensatz abfragen
Datensatz abfragen
Datensatz abfragen
Status

...

titleGET

Codeblock
languagebash
GET $YOUR_DOMAIN_URL/rest/v4/$COLLATION/resource/$IDENTIFIER/$ID/
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN

Anker
Datensatz anlegen
Datensatz anlegen
Datensatz anlegen
Status

...

titlePOST

Codeblock
languagebash
POST $YOUR_DOMAIN_URL/rest/v4/$COLLATION/resource/$IDENTIFIER/
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN

$DATASET_VALUES

Anker
Datensatz löschen
Datensatz löschen
Datensatz löschen
Status

...

titleDELETE

Codeblock
languagebash
DELETE $YOUR_DOMAIN_URL/rest/v4/$COLLATION/resource/$IDENTIFIER/$ID/
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN

Anker
Datensatz updaten
Datensatz updaten
Datensatz updaten
Status

...

titlePUT

Codeblock
languagebash
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
Status

...

titleGET

Codeblock
languagebash
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
Status

...

titleGET

Codeblock
languagebash
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

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

Kind Datensätze
Status

...

titleDELETE

Codeblock
languagebash
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
Status

...

titleDELETE

Codeblock
languagebash
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
Status

...

titleGET

Codeblock
languagebash
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
Status

...

titleGET

Codeblock
languagebash
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
Status

...

titlePOST

Codeblock
languagebash
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
Status

...

titlePOST

Codeblock
languagebash
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
Status

...

titleDELETE

Codeblock
languagebash
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
Status

...

titleDELETE

Codeblock
languagebash
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
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