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 KarteKinder, um eine Liste von Datensätzen Kind-Beziehungen der konfigurierten Relations-Tabelle zurückzugebenzu verarbeiten.

Liste der Kind-Datensätze holen

...

Ressource
/rest/v5/{identifier}/{idparentId}

identifier: Identifikator der Page
parentId: ID des Eltern-Datensatzes

Parameter

Parameter

Beschreibung

Mögliche Werte

optional

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

...

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
true
collapse
Codeblock
[
	{
		"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

Status
titlePOST

Ressource
/rest/v5/{identifier}/{parentId}

identifier: Identifikator der Page
parentId: ID des Eltern-Datensatzes

Parameter

Parameter

Beschreibung

Mögliche Werte

optional

{label}Feldwert pro Map

childrenIds[]

Array aus Kind-Datensatz-

LabelAlle für die ETL-Map erlaubten Labels

IDs

Gültige IDs der in der Page referenzierten Kind-Tabelle

nein

Hinweise

  • Ungültige

  • Labels
  • IDs werden ignoriert

  • Werden keine

  • gültige Labels
  • gültigen IDs übergeben, antwortet der Service mit einem Fehler

  • 102
  • 103 (fehlende Parameter)

Response

Array von JSON-Objekten, dabei:

  • Key: ID des Datensatzes
  • Value: Objekt aus Key-Value-Paaren (mit Key = Map-Datensatz-Label, Value = gemappter Wert) des gespeicherten Datensatzes
Codeblock
titleBeispiel
collapsetrue
"49": {
  "shopArticleName": "Test",
  "shopArticleActive": true
}

Datensatz aktualisieren

...

  • Werden bereits verknüpfte IDs übergeben, antwortet der Service nicht mit einem Fehler

Response

true bei Erfolg, sonst false

Beispiel
Codeblock
true

Datensätze als Kinder neu anordnen

Status
titleput

Ressource
/rest/v5/{identifier}/{idparentId}

identifier: Identifikator der Page
idparentId: ID des Eltern-Datensatzes

Parameter

Parameter

Beschreibung

Mögliche Werte

optional

{label}Feldwert pro Map

childrenIds[]

Array aus Kind-Datensatz-

LabelAlle für die ETL-Map erlaubten Labels

IDs

Gültige IDs der in der Page referenzierten Kind-Tabelle

nein

collationId

Hinweise

  • Die

...

Hinweise

    Ungültige Labels
  • übergebenen IDs werden ent- und danach in der übergebenen Reihenfolge neu verknüpft

  • Ungültige IDs werden ignoriert

  • Werden keine

  • gültige Labels
  • gültigen IDs übergeben, antwortet der Service mit einem Fehler

  • 102
  • 103 (fehlende Parameter)

Response

Array von JSON-Objekten, dabei:

  • Key: ID des Datensatzes
  • Value: Objekt aus Key-Value-Paaren (mit Key = Map-Datensatz-Label, Value = gemappter Wert) des gespeicherten Datensatzes
Codeblock
titleBeispiel
collapsetrue
"49": {
  "shopArticleName": "Test 2",
  "shopArticleActive": false
}

Datensatz löschen

  • Werden bereits verknüpfte IDs übergeben, antwortet der Service nicht mit einem Fehler

Response

true bei Erfolg, sonst false

Beispiel
Codeblock
true

Verküpfungen zu Kind-Datensätzen entfernen

Status
titleDELETE

Ressource
/rest/v5/{identifier}/{idparentId}

identifier: Identifikator der Page
idparentId: ID des Eltern-Datensatzes

Parameter

Parameter

...

Beschreibung

Mögliche Werte

optional

childrenIds[]

Array aus Kind-Datensatz-IDs

Gültige IDs der in der Page referenzierten Kind-Tabelle

nein

Response

true

...

bei Erfolg, sonst

...

false

Beispiel
true
collapse
Codeblock
true