Seitenvergleich

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

colour	Grey
title	GET

Fordert die angegebene Ressource vom Server an.

Status

colour	Grey
title	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.

Status

colour	Grey
title	PUT

Die angegebene Ressource wird geändert.

Status

colour	Grey
title	DELETE

Löscht die angegebene Ressource.

Jede Ressourcen Anfrage braucht folgende Header:

Codeblock

language	bash	theme	RDark

Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN

...

Status

colour	Grey
title	GET

Codeblock

theme

language	bash		RDark

GET $YOUR_DOMAIN_URL/rest/v3/$ISO_6391/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
colour Grey
title GET

Codeblock

language	bash	theme	RDark

GET $YOUR_DOMAIN_URL/rest/v3/$ISO_6391/resource/$IDENTIFIER/?query=$QUERY
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN

Anker
Tabelle leeren
Tabelle leeren
Tabelle leeren
Status
colour Grey
title DELETE

Codeblock

language	bash	theme	RDark

DELETE $YOUR_DOMAIN_URL/rest/v3/$ISO_6391/resource/$IDENTIFIER/
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN

Anker
Datensatz abfragen
Datensatz abfragen
Datensatz abfragen
Status
colour Grey
title GET

Codeblock

language	bash	theme	RDark

GET $YOUR_DOMAIN_URL/rest/v3/$ISO_6391/resource/$IDENTIFIER/$ID/
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN

Anker
Datensatz anlegen
Datensatz anlegen
Datensatz anlegen
Status
colour Grey
title POST

Codeblock

language	bash	theme	RDark

POST $YOUR_DOMAIN_URL/rest/v3/$ISO_6391/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
colour Grey
title DELETE

Codeblock

theme

language	bash		RDark

DELETE $YOUR_DOMAIN_URL/rest/v3/$ISO_6391/resource/$IDENTIFIER/$ID/
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN

Anker
Datensatz updaten
Datensatz updaten
Datensatz updaten
Status
colour Grey
title PUT

Codeblock

language	bash	theme	RDark

PUT $YOUR_DOMAIN_URL/rest/v3/$ISO_6391/resource/$IDENTIFIER/$ID/
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN


$DATASET_VALUES

...

Eltern Datensätze
Status
colour Grey
title GET

Codeblock

theme

language	bash		RDark

GET $YOUR_DOMAIN_URL/rest/v3/$ISO_6391/resource/$IDENTIFIER/$ID/parents-$PARENT_IDENTIFIER/
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN

Kind Datensätze
Status
colour Grey
title GET

Codeblock

language	bash	theme	RDark

GET $YOUR_DOMAIN_URL/rest/v3/$ISO_6391/resource/$IDENTIFIER/$ID/children-$CHILDREN_IDENTIFIER/
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN

...

Kind Datensätze
Status
colour Grey
title DELETE

Codeblock

language	bash	theme	RDark

DELETE $YOUR_DOMAIN_URL/rest/v3/$ISO_6391/resource/$IDENTIFIER/$ID/children-$CHILDREN_IDENTIFIER/
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN

Eltern Datensätze
Status
colour Grey
title DELETE

Codeblock

language	bash	theme	RDark

DELETE $YOUR_DOMAIN_URL/rest/v3/$ISO_6391/resource/$IDENTIFIER/$ID/parents-$PARENT_IDENTIFIER/
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN

...

Kind Datensätze
Status
colour Grey
title GET

Codeblock

language	bash	theme	RDark

GET $YOUR_DOMAIN_URL/rest/v3/$ISO_6391/resource/$IDENTIFIER/$ID/children-$CHILDREN_IDENTIFIER/$RELATION_ID/
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN

Eltern Datensätze
Status
colour Grey
title GET

Codeblock

theme

language	bash		RDark

GET $YOUR_DOMAIN_URL/rest/v3/$ISO_6391/resource/$IDENTIFIER/$ID/parents-$PARENT_IDENTIFIER/$RELATION_ID/
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN

...

Kind Datensätze
Status
colour Grey
title POST

Codeblock

language	bash	theme	RDark

POST $YOUR_DOMAIN_URL/rest/v3/$ISO_6391/resource/$IDENTIFIER/$ID/children-$CHILDREN_IDENTIFIER/$RELATION_ID/
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN


$DATASET_VALUES

Eltern Datensätze
Status
colour Grey
title POST

Codeblock

theme

language	bash		RDark

POST $YOUR_DOMAIN_URL/rest/v3/$ISO_6391/resource/$IDENTIFIER/$ID/parents-$PARENT_IDENTIFIER/$RELATION_ID/
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN


$DATASET_VALUES

...

Kind Datensätze
Status
colour Grey
title DELETE

Codeblock

language	bash	theme	RDark

DELETE $YOUR_DOMAIN_URL/rest/v3/$ISO_6391/resource/$IDENTIFIER/$ID/children-$CHILDREN_IDENTIFIER/$RELATION_ID/
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN

Eltern Datensätze
Status
colour Grey
title DELETE

Codeblock

language	bash	theme	RDark

DELETE $YOUR_DOMAIN_URL/rest/v3/$ISO_6391/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
$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

...

Versionen im Vergleich

Alte Version 5

Neue Version 6

Schlüssel

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
colour Grey
title GET

Anker
Tabelle leeren
Tabelle leeren
Tabelle leeren
Status
colour Grey
title DELETE

Anker
Datensatz abfragen
Datensatz abfragen
Datensatz abfragen
Status
colour Grey
title GET

Anker
Datensatz anlegen
Datensatz anlegen
Datensatz anlegen
Status
colour Grey
title POST

Anker
Datensatz löschen
Datensatz löschen
Datensatz löschen
Status
colour Grey
title DELETE

Anker
Datensatz updaten
Datensatz updaten
Datensatz updaten
Status
colour Grey
title PUT

Eltern Datensätze
Status
colour Grey
title GET

Kind Datensätze
Status
colour Grey
title GET

Kind Datensätze
Status
colour Grey
title DELETE

Eltern Datensätze
Status
colour Grey
title DELETE

Kind Datensätze
Status
colour Grey
title GET

Eltern Datensätze
Status
colour Grey
title GET

Kind Datensätze
Status
colour Grey
title POST

Eltern Datensätze
Status
colour Grey
title POST

Kind Datensätze
Status
colour Grey
title DELETE

Eltern Datensätze
Status
colour Grey
title DELETE

Seitenvergleich

Versionen im Vergleich

Alte Version 5

Neue Version 6

Schlüssel

AnkerDatensätze in einer Tabelle abfragen anhand KriterienDatensätze in einer Tabelle abfragen anhand KriterienDatensätze in einer Tabelle abfragen anhand Kriterien StatuscolourGreytitleGET

AnkerTabelle leerenTabelle leerenTabelle leeren StatuscolourGreytitleDELETE

AnkerDatensatz abfragenDatensatz abfragenDatensatz abfragen StatuscolourGreytitleGET

AnkerDatensatz anlegenDatensatz anlegenDatensatz anlegen StatuscolourGreytitlePOST

AnkerDatensatz löschenDatensatz löschenDatensatz löschen StatuscolourGreytitleDELETE

AnkerDatensatz updatenDatensatz updatenDatensatz updaten StatuscolourGreytitlePUT

Eltern Datensätze StatuscolourGreytitleGET

Kind Datensätze StatuscolourGreytitleGET

Kind Datensätze StatuscolourGreytitleDELETE

Eltern Datensätze StatuscolourGreytitleDELETE

Kind Datensätze StatuscolourGreytitleGET

Eltern Datensätze StatuscolourGreytitleGET

Kind Datensätze StatuscolourGreytitlePOST

Eltern Datensätze StatuscolourGreytitlePOST

Kind Datensätze StatuscolourGreytitleDELETE

Eltern Datensätze StatuscolourGreytitleDELETE

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
colour Grey
title GET

Anker
Tabelle leeren
Tabelle leeren
Tabelle leeren
Status
colour Grey
title DELETE

Anker
Datensatz abfragen
Datensatz abfragen
Datensatz abfragen
Status
colour Grey
title GET

Anker
Datensatz anlegen
Datensatz anlegen
Datensatz anlegen
Status
colour Grey
title POST

Anker
Datensatz löschen
Datensatz löschen
Datensatz löschen
Status
colour Grey
title DELETE

Anker
Datensatz updaten
Datensatz updaten
Datensatz updaten
Status
colour Grey
title PUT

Eltern Datensätze
Status
colour Grey
title GET

Kind Datensätze
Status
colour Grey
title GET

Kind Datensätze
Status
colour Grey
title DELETE

Eltern Datensätze
Status
colour Grey
title DELETE

Kind Datensätze
Status
colour Grey
title GET

Eltern Datensätze
Status
colour Grey
title GET

Kind Datensätze
Status
colour Grey
title POST

Eltern Datensätze
Status
colour Grey
title POST

Kind Datensätze
Status
colour Grey
title DELETE

Eltern Datensätze
Status
colour Grey
title DELETE