Versionen im Vergleich

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.

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

...

Liste von Datensätzen holen

Status
titleGET

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

Parameter

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

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 FiltersjawithTranslationsAuslieferung der Ergebnisse mit FremdsprachenZahlen 0 oder 1

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

Array von JSON-Objekten

...

aus Key-Value-Paaren mit Key = Map-Datensatz-Label, Value = gemappter Wert

In jedem JSON-Objekt ist ein Key meta enthalten, der folgende Informationen enthält:

  • id: ID des Datensatzes

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

...

  • userID: ID des Besitzers

  • userTable: Identifier der Benutzertabelle des Besitzeres

  • createTime: Anlagedatum als Unix Timestamp

  • changeTime: Letztes Änderungsdatum als Unix Timestamp

* 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 i18ntranslations.

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
Codeblock
true
[
       "1	{
		"shopArticleSku": {
            "shopArticleActive": true,
            "00001",
		"shopArticleName": "Visitenkarte allgemein",
		"shopArticleDescription": "",
            "shopArticleGtin		"shopArticleActive": true,
		"meta",:             "shopArticleImage1": "share\/public\/client-1\/domain-1\/shop\/article\/eraser-795768_640_0.jpg",
            "shopArticleName": "Visitenkarte",
            "shopArticleSku": "123",
            "i18n": {
                {
			"id": 1,
			"userID": 2,
			"userTable": "Administrator",
			"createTime": 1531780172,
			"changeTime": 1670232447
		},
		"translations": {
			"en_GB": {
                    "shopArticleDescription				"shopArticleName": "Business Card",
                    "shopArticleName				"shopArticleDescription": "Business Card"
                },
                "
			},
			"fr_DE": {
                    "shopArticleDescription": null,
                    				"shopArticleName": "Carte de Visitevisite",
				"shopArticleDescription":                }
            },
            null
			}
		},
		"links": [
                "\/rest\/v5\/parentsGroupArticle\			"/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"
            ]
        }
    }			"/rest/v5/shopArticleCard/1"
		]
	},
	{
		"shopArticleSku": "00002",
		"shopArticleName": "Visitenkarte Business",
		"shopArticleDescription": "",
		"shopArticleActive": false,
		"meta": {
			"id": 6,
			"userID": 8,
			"userTable": "Administrator",
			"createTime": 1531780172,
			"changeTime": 1670232437
		},
		"translations": {
			"en_GB": {
				"shopArticleName": "Business Card",
				"shopArticleDescription": null
			},
			"fr_DE": {
				"shopArticleName": null,
				"shopArticleDescription": null
			}
		},
		"links": [
			"/rest/v5/parentsGroupArticle/6",
			"/rest/v5/shopArticleCard/6"
		]
	}
]

Weitere Funktionen

Status
titlePOST
Status
titlePUT
Status
titleDELETE
sind nicht implementiert.