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 11 Nächste Version anzeigen »

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

Liste von Datensätzen holen

GET

Ressource
/rest/v5/{identifier}
identifier: Identifikator der Page

Parameter

ParameterBeschreibungMögliche Werteoptional
offsetDer Offset, ab der Datensätze geholt werden sollen.Positive Ganzzahlen. Standardwert ist 0ja
limitDie maximale Anzahl der Datensätze.Positive Ganzzahlen. Standardwert ist 0 (alle Datensätze)ja
orderMapping-Feld-Label, nach dem sortiert werden soll. Standardmäßig wird die Liste unsortiert zurückgegebenZeichenkette; Label eines validen Map-Datensatzesja
orderBySortierreihenfolgeZeichenkette: "asc" oder "desc"ja
queryEinfaches Filterkriterium. Bei invalidem Format wird nicht gefiltert.Zeichenkette: Erklärung s.u. *ja
filterIdFilter-ID aus Component/Filter, nach der die Ergebnisse zusätzlich gefiltert werden. Bei invalider Filter-ID wird nicht gefiltert.Positive Ganzzahlen; Gültige Id eines geteilten Filtersja
withTranslationsAuslieferung der Ergebnisse mit aktiven FremdsprachenZahlen 0 oder 1; Erklärung s.u. **ja




Response

Array von JSON-Objekten, dabei:

  • Key: ID des Datensatzes
  • Value: Objekt aus Key-Value-Paaren mit Key = Map-Datensatz-Label, Value = gemappter Wert

* Einfaches Filterkriterium

Ein einfaches Filterkriterium besteht aus einer Zeichenkette, bei der mehrere Filter-Anweisungen in Form von Key=Value durch das Trennzeichen & getrennt, definiert werden können.

  • Es sind keine ODER-Verknüpfungen möglich
  • Wildcards sind mit dem Zeichen % möglich
  • Die Keys der einzelnen Filter-Anweisungen müssen gültige Map-Datensatz-Labels sein

Beispiel:
shopArticleName=%Visitenkarte%%26shopArticleActive=1

Achtung: es ist wichtig, das Trennzeichen & innerhalb der Zeichenkette zu urlencoden.

** 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"
            ]
        },
        "2": {
            "shopArticleActive": true,
            "shopArticleDescription": "",
            "shopArticleGtin": "",
            "shopArticleImage1": "share\/public\/client-1\/domain-1\/shop\/article\/muster-flyer-individuell.png",
            "shopArticleName": "Flyer individuell",
            "shopArticleSku": "fly001",
            "i18n": {
                "en_GB": {
                    "shopArticleDescription": null,
                    "shopArticleName": null
                },
                "fr_DE": {
                    "shopArticleDescription": null,
                    "shopArticleName": null
                }
            },
            "links": [
                "\/rest\/v5\/parentsGroupArticle\/2",
                "\/rest\/v5\/shopArticleCard\/2"
            ]
        },
        "6": {
            "shopArticleActive": true,
            "shopArticleDescription": "",
            "shopArticleGtin": "",
            "shopArticleImage1": "share\/public\/client-1\/domain-1\/shop\/article\/muster-business-card_0.png",
            "shopArticleName": "Visitenkarte1",
            "shopArticleSku": "EDIT-STRICT-0011",
            "i18n": {
                "en_GB": {
                    "shopArticleDescription": null,
                    "shopArticleName": null
                },
                "fr_DE": {
                    "shopArticleDescription": null,
                    "shopArticleName": null
                }
            },
            "links": [
                "\/rest\/v5\/parentsGroupArticle\/6",
                "\/rest\/v5\/shopArticleCard\/6"
            ]
        }
    }

Weitere Funktionen

POST PUT DELETE sind nicht implementiert.

  • Keine Stichwörter