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 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 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"
		]
	}
]

Datensätze als Kinder verknüpfen

POST

Ressource
/rest/v5/{identifier}

identifier: Identifikator der Page

Parameter

ParameterBeschreibungMögliche Werteoptional
childrenIds[]Array aus Kind-Datensatz-IDsGültige IDs der in der Page referenzierten Kind-Tabellenein

Hinweise

  • Ungültige IDs werden ignoriert
  • Werden keine gültigen IDs übergeben, antwortet der Service mit einem Fehler 103 (fehlende Parameter)
  • Werden bereits verknüpfte IDs übergeben, antwortet der Service nicht mit einem Fehler

Response

true bei Erfolg, false bei Fehler

Beispiel
true

Datensätze als Kinder neu anordnen

POST

Ressource
/rest/v5/{identifier}

identifier: Identifikator der Page

Parameter

ParameterBeschreibungMögliche Werteoptional
childrenIds[]Array aus Kind-Datensatz-IDsGültige IDs der in der Page referenzierten Kind-Tabellenein

Hinweise

  • Die übergebenen IDs werden ent- und danach in der übergebenen Reihenfolge neu verknüpft
  • Ungültige IDs werden ignoriert
  • Werden keine gültigen IDs übergeben, antwortet der Service mit einem Fehler 103 (fehlende Parameter)
  • Werden bereits verknüpfte IDs übergeben, antwortet der Service nicht mit einem Fehler

Response

true bei Erfolg, false bei Fehler

Beispiel
true

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