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 25 Aktuelle »

Wählen Sie bei einer Map den Typ Liste, um Datensätze der konfigurierten Tabelle zu verarbeiten.

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
withTranslationsAuslieferung der Ergebnisse mit aktiven FremdsprachenZahlen 0 oder 1; Erklärung s.u. **ja
localeAuslieferung der Ergebnisse in dieser KollationZeichenkette; Locale einer aktiven Kollation. Standardwert ist de_DEja

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
  • 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 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
[
	{
		"shopArticleSku": "00001",
		"shopArticleName": "Visitenkarte allgemein",
		"shopArticleDescription": "",
		"shopArticleActive": true,
		"meta": {
			"id": 1,
			"userID": 2,
			"userTable": "Administrator",
			"createTime": 1531780172,
			"changeTime": 1670232447
		},
		"translations": {
			"en_GB": {
				"shopArticleName": "Business Card",
				"shopArticleDescription": ""
			},
			"fr_DE": {
				"shopArticleName": "Carte de visite",
				"shopArticleDescription": null
			}
		},
		"links": [
			"/rest/v5/parentsGroupArticle/1",
			"/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

POST PUT DELETE sind nicht implementiert.

  • Keine Stichwörter