Zum Ende der Metadaten springen
Zum Anfang der Metadaten

Sie zeigen eine alte Version dieser Seite an. Zeigen Sie die aktuelle Version an.

Unterschiede anzeigen Seitenhistorie anzeigen

« Vorherige Version anzeigen Version 4 Nächste Version anzeigen »

Wählen Sie bei einer Map den Typ RESTful API: Typ Karte, um eine Liste von Datensätzen der konfigurierten Tabelle zurückzugeben.

Liste der Kind-Datensätze holen

GET

Ressource
/rest/v5/{identifier}/{id}

identifier: Identifikator der Page
parentId: ID des Eltern-Datensatzes

Parameter

ParameterBeschreibungMögliche Werteoptional
withTranslationsAuslieferung der Ergebnisse mit aktiven FremdsprachenZahlen 0 oder 1; Erklärung s.u. *ja

Response

Array von JSON-Objekten 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 i18n.

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
"1": {
  "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

POST

Ressource
/rest/v5/{identifier}

identifier: Identifikator der Page

Parameter

ParameterBeschreibungMögliche Werteoptional
{label}Feldwert pro Map-Datensatz-LabelAlle für die ETL-Map erlaubten Labelsnein

Hinweise

  • Ungültige Labels werden ignoriert
  • Werden keine gültige Labels übergeben, antwortet der Service mit einem Fehler 102 (fehlende Parameter)

Response

Array von JSON-Objekten, dabei:

  • Key: ID des Datensatzes
  • Value: Objekt aus Key-Value-Paaren (mit Key = Map-Datensatz-Label, Value = gemappter Wert) des gespeicherten Datensatzes
Beispiel
"49": {
  "shopArticleName": "Test",
  "shopArticleActive": true
}

Datensatz aktualisieren

PUT

Ressource
/rest/v5/{identifier}/{id}

identifier: Identifikator der Page
id: ID des Datensatzes

Parameter

ParameterBeschreibungMögliche Werteoptional
{label}Feldwert pro Map-Datensatz-LabelAlle für die ETL-Map erlaubten Labelsnein
collationIdDie ID der zu schreibenden Kollation. Bei fehlendem Parameter wird die Kollation 1 geschriebenID von aktiven Kollationenja

Hinweise

  • Ungültige Labels werden ignoriert
  • Werden keine gültige Labels übergeben, antwortet der Service mit einem Fehler 102 (fehlende Parameter)

Response

Array von JSON-Objekten, dabei:

  • Key: ID des Datensatzes
  • Value: Objekt aus Key-Value-Paaren (mit Key = Map-Datensatz-Label, Value = gemappter Wert) des gespeicherten Datensatzes
Beispiel
"49": {
  "shopArticleName": "Test 2",
  "shopArticleActive": false
}

Datensatz löschen

DELETE

Ressource
/rest/v5/{identifier}/{id}

identifier: Identifikator der Page
id: ID des Datensatzes

Parameter

  • keine

Response

true im Erfolgsfall, sonst leere Response

Beispiel
true
  • Keine Stichwörter