...
| Parameter | Beschreibung | Mögliche Werte | optional |
|---|---|---|---|
| offset | Der Offset, ab der Datensätze geholt werden sollen. | Positive Ganzzahlen. Standardwert ist 0 | ja |
| limit | Die maximale Anzahl der Datensätze. | Positive Ganzzahlen. Standardwert ist 0 (alle Datensätze) | ja |
| order | Mapping-Feld-Label, nach dem sortiert werden soll. Standardmäßig wird die Liste unsortiert zurückgegeben | Zeichenkette; Label eines validen Map-Datensatzes | ja |
| orderBy | Sortierreihenfolge | Zeichenkette: "asc" oder "desc" | ja |
| query | Einfaches Filterkriterium. Bei invalidem Format wird nicht gefiltert. | Zeichenkette: Erklärung s.u. * | ja |
| filterId | Filter-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 Filters | ja |
| withTranslations | Auslieferung der Ergebnisse mit aktiven Fremdsprachen | Zahlen 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
...
** Auslieferung des Ergebnisses mit Fremdsprachen
...