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

colourGrey

title	GET

Fordert die angegebene Ressource vom Server an.

Status

colourGrey

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

colourGrey

title	PUT

Die angegebene Ressource wird geändert.

Status

colourGrey

title	DELETE

Löscht die angegebene Ressource.

Jede Ressourcen Anfrage braucht folgende Header:

Codeblock

theme

language	bash		RDark

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

colour

Status

Grey	title	GET

Codeblock

language	bash
theme	RDark

GET $YOUR_DOMAIN_URL/rest/v3v4/$ISO_6391$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

...

title GET

Codeblock

theme

language	bash		RDark

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

Anker
Tabelle leeren
Tabelle leeren
Tabelle leeren
Status

...

title DELETE

Codeblock

theme

language	bash		RDark

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

Anker
Datensatz abfragen
Datensatz abfragen
Datensatz abfragen
Status

...

title GET

Codeblock

language	bash
theme	RDark

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

Anker
Datensatz anlegen
Datensatz anlegen
Datensatz anlegen
Status

...

title POST

Codeblock

language	bash
theme	RDark

POST $YOUR_DOMAIN_URL/rest/v3v4/$ISO_6391$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

...

title DELETE

Codeblock

language	bash
theme	RDark

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

Anker
Datensatz updaten
Datensatz updaten
Datensatz updaten
Status

...

title PUT

Codeblock

language	bash	theme	RDark

PUT $YOUR_DOMAIN_URL/rest/v3v4/$ISO_6391$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

...

title GET

Codeblock

language	bash
theme	RDark

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

Kind Datensätze
Status

...

title GET

Codeblock

language	bash
theme	RDark

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

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

...

title DELETE

Codeblock

language	bash
theme	RDark

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

Eltern Datensätze
Status

...

title DELETE

Codeblock

language	bash	theme	RDark

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

Verknüpften Datensatz abfragen

Kind Datensätze
Status

...

title GET

Codeblock

language	bash	theme	RDark

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

Eltern Datensätze
Status

...

title GET

Codeblock

language	bash
theme	RDark

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

Verknüpften Datensatz anlegen

Kind Datensätze
Status

...

title POST

Codeblock

theme

language	bash		RDark

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

Eltern Datensätze
Status

...

title POST

Codeblock

language	bash	theme	RDark

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

Verknüpften Datensatz löschen

Kind Datensätze
Status

...

title DELETE

Codeblock

language	bash
theme	RDark

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

Eltern Datensätze
Status

...

title DELETE

Codeblock

language	bash	theme	RDark

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

de

Parameter Name	Erläuterung	Beispiel

$ISO_6391Der ISO 639-1 Ländercode der angeforderten eingepflegten brandbox Sprache

$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

Seitenvergleich

Versionen im Vergleich

Alte Version 5

Neue Version Aktuell

Schlüssel

Folgende Möglichkeiten können abgefragt werden:

Alle Datensätze einer Tabelle abfragen

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

titleGET

AnkerTabelle leerenTabelle leerenTabelle leeren Status

titleDELETE

AnkerDatensatz abfragenDatensatz abfragenDatensatz abfragen Status

titleGET

AnkerDatensatz anlegenDatensatz anlegenDatensatz anlegen Status

titlePOST

AnkerDatensatz löschenDatensatz löschenDatensatz löschen Status

titleDELETE

AnkerDatensatz updatenDatensatz updatenDatensatz updaten Status

titlePUT

Alle verknüpften Datensätze abfragen

Eltern Datensätze Status

titleGET

Kind Datensätze Status

titleGET

Alle

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

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

Kind Datensätze Status

titleDELETE

Eltern Datensätze Status

titleDELETE

Verknüpften Datensatz abfragen

Kind Datensätze Status

titleGET

Eltern Datensätze Status

titleGET

Verknüpften Datensatz anlegen

Kind Datensätze Status

titlePOST

Eltern Datensätze Status

titlePOST

Verknüpften Datensatz löschen

Kind Datensätze Status

titleDELETE

Eltern Datensätze Status

titleDELETE

Parameter

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

title GET

Anker
Tabelle leeren
Tabelle leeren
Tabelle leeren
Status

title DELETE

Anker
Datensatz abfragen
Datensatz abfragen
Datensatz abfragen
Status

title GET

Anker
Datensatz anlegen
Datensatz anlegen
Datensatz anlegen
Status

title POST

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

title DELETE

Anker
Datensatz updaten
Datensatz updaten
Datensatz updaten
Status

title PUT

Eltern Datensätze
Status

title GET

Kind Datensätze
Status

title GET

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

title DELETE

Eltern Datensätze
Status

title DELETE

Kind Datensätze
Status

title GET

Eltern Datensätze
Status

title GET

Kind Datensätze
Status

title POST

Eltern Datensätze
Status

title POST

Kind Datensätze
Status

title DELETE

Eltern Datensätze
Status

title DELETE