...
Ressource
/rest/v5/{identifier}/{id}
identifier: Identifikator der Page
id: ID des Datensatzes
Parameter
Parameter | Beschreibung | Mögliche Werte | optional |
|---|---|---|---|
withTranslations | Auslieferung der Ergebnisse mit aktiven Fremdsprachen | Zahlen 0 oder 1; Erklärung s.u. * | ja |
locale | Auslieferung der Ergebnisse in dieser Kollation | Zeichenkette; Locale einer aktiven Kollation. Standardwert ist de_DE | ja |
Response
JSON-Objekt aus Key-Value-Paaren mit Key = Map-Datensatz-Label, Value = gemappter Wert
** Auslieferung des Ergebnisses mit Fremdsprachen
Wird der Parameter withTranslations gesetzt, enthält jedes Objekt einen zusätzlichen Key translations.
Dieser enthält wiederum eine Liste von Objekten mit
Key = Collation-Name (z.B. de_DE)
Value: Objekt aus Key-Value-Paaren mit Key = Map-Datensatz-Label, Value = gemappter Sprach-Wert
...
Beispiel
| collapse | true
|---|
| Codeblock |
{
"shopArticleActive": true,
"shopArticleDescription": "",
"shopArticleGtin": "",
"shopArticleImage1": "share\/public\/client-1\/domain-1\/shop\/article\/eraser-795768_640_0.jpg",
"shopArticleName": "Visitenkarte",
"shopArticleSku": "123",
"i18n": {
"en_GB": {
"shopArticleDescription": "",
"shopArticleName": "Business Card"
},
"fr_DE": {
"shopArticleDescription": null,
"shopArticleName": "Carte de Visite"
}
},
"links": [
"\/rest\/v5\/parentsGroupArticle\/1",
"\/rest\/v5\/shopArticleCard\/1"
]
} |
Datensatz anlegen
| Status | ||
|---|---|---|
|
Ressource
/rest/v5/{identifier}
identifier: Identifikator der Page
Parameter
Parameter | Beschreibung | Mögliche Werte | optional |
|---|---|---|---|
{label} | Feldwert pro Map-Datensatz-Label | Alle für die ETL-Map erlaubten Labels | nein |
Hinweise
Ungültige Labels werden ignoriert
Werden keine gültige Labels übergeben, antwortet der Service mit einem Fehler 102 (fehlende Parameter)
Bei Verletzung von Einschränkungen der zu Grunde liegenden Tabelle antwortet der Service mit einem Fehler 108 (Verletzung von Constraint)
Response
JSON-Objekt aus Key-Value-Paaren mit Key = Map-Datensatz-Label, Value = gemappter Wert
...
Beispiel
| collapse | true
|---|
| Codeblock |
{
"shopArticleName": "Test",
"shopArticleActive": true
} |
Datensatz aktualisieren
| Status | ||
|---|---|---|
|
Ressource
/rest/v5/{identifier}/{id}
identifier: Identifikator der Page
id: ID des Datensatzes
Parameter
Parameter | Beschreibung | Mögliche Werte | optional |
|---|---|---|---|
{label} | Feldwert pro Map-Datensatz-Label | Alle für die ETL-Map erlaubten Labels | nein |
locale | Locale der zu schreibenden Kollation | Zeichenkette; Locale einer aktiven Kollation. Standardwert ist de_DE | ja |
Hinweise
Ungültige Labels werden ignoriert
Werden keine gültige Labels übergeben, antwortet der Service mit einem Fehler 103 (fehlende Parameter)
Bei Verletzung von Einschränkungen der zu Grunde liegenden Tabelle antwortet der Service mit einem Fehler 108 (Verletzung von Constraint)
Response
JSON-Objekt aus Key-Value-Paaren mit Key = Map-Datensatz-Label, Value = gemappter Wert
...
Beispiel
| collapse | true
|---|
| Codeblock |
{
"shopArticleName": "Test 2",
"shopArticleActive": false
} |
Datensatz löschen
| Status | ||
|---|---|---|
|
Ressource
/rest/v5/{identifier}/{id}
identifier: Identifikator der Page
id: ID des Datensatzes
Parameter
keine
Response
true im Erfolgsfall, sonst leere Response
...
Beispiel
| collapse | true
|---|
| Codeblock |
true |