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:
...
| Codeblock |
|---|
|
GET $YOUR_DOMAIN_URL/rest/v3v4/$ISO_6391$COLLATION/resource/$IDENTIFIER/
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN |
...
| Codeblock |
|---|
|
GET $YOUR_DOMAIN_URL/rest/v3v4/$ISO_6391$COLLATION/resource/$IDENTIFIER/?query=$QUERY
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN |
...
| Codeblock |
|---|
|
DELETE $YOUR_DOMAIN_URL/rest/v3v4/$ISO_6391$COLLATION/resource/$IDENTIFIER/
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN |
...
| Codeblock |
|---|
|
GET $YOUR_DOMAIN_URL/rest/v3v4/$ISO_6391$COLLATION/resource/$IDENTIFIER/$ID/
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN |
...
| Codeblock |
|---|
|
POST $YOUR_DOMAIN_URL/rest/v3v4/$ISO_6391$COLLATION/resource/$IDENTIFIER/
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN
$DATASET_VALUES |
...
| Codeblock |
|---|
|
DELETE $YOUR_DOMAIN_URL/rest/v3v4/$ISO_6391$COLLATION/resource/$IDENTIFIER/$ID/
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN |
...
| Codeblock |
|---|
|
PUT $YOUR_DOMAIN_URL/rest/v3v4/$ISO_6391$COLLATION/resource/$IDENTIFIER/$ID/
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN
$DATASET_VALUES |
...
| Codeblock |
|---|
|
GET $YOUR_DOMAIN_URL/rest/v3v4/$ISO_6391$COLLATION/resource/$IDENTIFIER/$ID/parents-$PARENT_IDENTIFIER/
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN |
...
| Codeblock |
|---|
|
GET $YOUR_DOMAIN_URL/rest/v3v4/$ISO_6391$COLLATION/resource/$IDENTIFIER/$ID/children-$CHILDREN_IDENTIFIER/
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN |
...
| Codeblock |
|---|
|
DELETE $YOUR_DOMAIN_URL/rest/v3v4/$ISO_6391$COLLATION/resource/$IDENTIFIER/$ID/children-$CHILDREN_IDENTIFIER/
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN |
...
| Codeblock |
|---|
|
DELETE $YOUR_DOMAIN_URL/rest/v3v4/$ISO_6391$COLLATION/resource/$IDENTIFIER/$ID/parents-$PARENT_IDENTIFIER/
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN |
...
| Codeblock |
|---|
|
GET $YOUR_DOMAIN_URL/rest/v3v4/$ISO_6391$COLLATION/resource/$IDENTIFIER/$ID/children-$CHILDREN_IDENTIFIER/$RELATION_ID/
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN |
...
| Codeblock |
|---|
|
GET $YOUR_DOMAIN_URL/rest/v3v4/$ISO_6391$COLLATION/resource/$IDENTIFIER/$ID/parents-$PARENT_IDENTIFIER/$RELATION_ID/
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN |
...
| Codeblock |
|---|
|
POST $YOUR_DOMAIN_URL/rest/v3v4/$ISO_6391$COLLATION/resource/$IDENTIFIER/$ID/children-$CHILDREN_IDENTIFIER/$RELATION_ID/
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN
$DATASET_VALUES |
...
| Codeblock |
|---|
|
POST $YOUR_DOMAIN_URL/rest/v3v4/$ISO_6391$COLLATION/resource/$IDENTIFIER/$ID/parents-$PARENT_IDENTIFIER/$RELATION_ID/
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN
$DATASET_VALUES |
...
| Codeblock |
|---|
|
DELETE $YOUR_DOMAIN_URL/rest/v3v4/$ISO_6391$COLLATION/resource/$IDENTIFIER/$ID/children-$CHILDREN_IDENTIFIER/$RELATION_ID/
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN |
...
| Codeblock |
|---|
|
DELETE $YOUR_DOMAIN_URL/rest/v3v4/$ISO_6391$COLLATION/resource/$IDENTIFIER/$ID/parents-$PARENT_IDENTIFIER/$RELATION_ID/
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN |
...
| Parameter Name | Erläuterung | Beispiel |
|---|
| $ISO_6391 | Der ISO 639-1 Ländercode der angeforderten eingepflegten brandbox Sprache | de$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 |
...