Versionen im Vergleich

Version Alte Version 1 Neue Version Aktuell
Änderungen wurden vorgenommen von

Philipp Frick

Sebastian Schulz

Gespeichert am

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 Karte, um eine Liste von Datensätzen einen Datensatz der konfigurierten Tabelle zurückzugebenzu verarbeiten.

Datensatz-Karte holen

Status
titleGET

Ressource
/rest/v5/{identifier}/{id}

identifier: Identifikator der Page
id: ID des Datensatzes

Parameter

Zeichenkette:

Parameter

Beschreibung

Mögliche Werte

optional

offsetDer Offset, ab der Datensätze geholt werden sollen.Positive Ganzzahlen. Standardwert ist 0jalimitDie maximale Anzahl der Datensätze.Positive Ganzzahlen. Standardwert ist 0 (alle Datensätze)jaorderMapping-Feld-Label, nach dem sortiert werden soll. Standardmäßig wird die Liste unsortiert zurückgegebenZeichenkette; Label eines validen Map-DatensatzesjaorderBySortierreihenfolgeZeichenkette: "asc" oder "desc"jaqueryEinfaches Filterkriterium. Bei invalidem Format wird nicht gefiltert.

withTranslations

Auslieferung der Ergebnisse mit aktiven Fremdsprachen

Zahlen 0 oder 1; 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 aktiven FremdsprachenZahlen 0 oder 1; Erklärung s.u. **

locale

Auslieferung der Ergebnisse in dieser Kollation

Zeichenkette; Locale einer aktiven Kollation. Standardwert ist de_DE

ja

Response

...

JSON-

...

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

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
"1": {
collapsetrue
Codeblock
{
          "shopArticleActive": true,
         
  "shopArticleDescription": "",
      
     "shopArticleGtin": "",
         
  "shopArticleImage1": "share\/public\/client-1\/domain-1\/shop\/article\/eraser-795768_640_0.jpg",
 
          "shopArticleName": "Visitenkarte",
            "shopArticleSku": "123",

           "i18n": {
    
           "en_GB": {
   
                "shopArticleDescription": "",
             
      "shopArticleName": "Business Card"
    
           },
                "fr_DE": {
                    "shopArticleDescription": null,
          
         "shopArticleName": "Carte de Visite"

               }
            },
       
    "links": [
                "\/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,
                 }

Datensatz anlegen

Status
titlePOST

Ressource
/rest/v5/{identifier}

identifier: Identifikator der Page

Parameter

Parameter

Beschreibung

Mögliche Werte

optional

{label}

Feldwert pro Map-Datensatz-Label

Alle für die ETL-Map erlaubten Labels

nein

Hinweise

  • Ungültige Labels werden ignoriert

  • Werden keine gültige Labels übergeben, antwortet der Service mit einem Fehler 102 (fehlende Parameter)

  • Bei Verletzung von Einschränkungen der zu Grunde liegenden Tabelle antwortet der Service mit einem Fehler 108 (Verletzung von Constraint)

Response

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

Beispiel
Codeblock
{
  "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"
            ]
        }
    }

Weitere Funktionen

...

"Test",
  "shopArticleActive": true
}

Datensatz aktualisieren

Status
titlePUT

Ressource
/rest/v5/{identifier}/{id}

identifier: Identifikator der Page
id: ID des Datensatzes

Parameter

Parameter

Beschreibung

Mögliche Werte

optional

{label}

Feldwert pro Map-Datensatz-Label

Alle für die ETL-Map erlaubten Labels

nein

locale

Locale der zu schreibenden Kollation

Zeichenkette; Locale einer aktiven Kollation. Standardwert ist de_DE

ja

Hinweise

  • Ungültige Labels werden ignoriert

  • Werden keine gültige Labels übergeben, antwortet der Service mit einem Fehler 103 (fehlende Parameter)

  • Bei Verletzung von Einschränkungen der zu Grunde liegenden Tabelle antwortet der Service mit einem Fehler 108 (Verletzung von Constraint)

Response

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

Beispiel
Codeblock
{
  "shopArticleName": "Test 2",
  "shopArticleActive": false
}

Datensatz löschen

Status
titleDELETE

Ressource
/rest/v5/{identifier}/{id}

identifier: Identifikator der Page
id: ID des Datensatzes

Parameter

  • keine

Response

true im Erfolgsfall, sonst leere Response

Beispiel
Codeblock
true