Merkmalwerte über die Restful API abrufen

Mit der Restful Schnittstelle (v5) ist es möglich, die Merkmalwerte von Entitäten bei Anfragen ausgeben zu lassen. Um diese Werte abzurufen sind Kenntnisse zur Restful Schnittstelle und dem ETL Mapping notwendig.

Abrufen von Merkmalwerten als Knoten

Die Tabelle Seiten (RestPage) wird von pim-classification-rest um ein Feld erweitert, das dazu dient, das Exportverhalten von Klassifikationen zu definieren. In diesem Feld kann das Verhalten In eigenem Knoten exportieren gewählt werden. Diese Option sorgt dafür, dass die Merkmalwerte einer Entität in dem Knoten pimClassification in der Antwort ausgegeben werden.

Transformationen

Es ist außerdem möglich auch die Inhalte des Knoten transformieren zu lassen. Dafür wird wiederum die Tabelle Seiten (RestPage) von pim-classification um ein Feld erweitert, das die Auswahl eines Mappingprofils zulässt. Anhand der Klassifikationsfelder des Mappings werden die Merkmale transformiert. Wird zu einem Merkmal in diesem Profil kein Mappingfeld gefunden, wird der Wert plain ausgegeben.

Antwort mit Merkmalen als Knoten

    {
      "shopArticleActive": true,
      "shopArticleName": "Holzschraube",
      "shopArticleSalesUnit": 1,
      "shopArticleSeoTitle": "HolzschraubeSeoTitel",
      "shopArticleSku": "hs001",
      "meta": {
        "id": 1,
        "userID": 1,
        "userTable": "Administrator",
        "createTime": 1576234206,
        "changeTime": 1675257040
      },
      "pimClassification": {
        "pimClassificationAttributeLength": "5",
        "pimClassificationAttributeScrewDiameter": "5"
      }
    }

Abrufen von Merkmalwerten als Eigenschaften

Um die Merkmalwerte als Eigenschaften von Entitäten ausgeben zu können, kann das Mapping von Datenbankfeldern genutzt werden. Dazu ist es nötig Mappings für Datenbankfelder anzulegen, welche besondere Datenbankfelder referenzieren. Diese Felder sind mit "Klassifikationsmerkmal: " gepräfixt. Die so konfigurierten Merkmale und deren Werte werden in den Antworten der Rest-Anfragen als Eigenschaften der Entitäten ausgegeben.

Antwort mit Merkmalen als Eigenschaften

    {
      "shopArticleActive": true,
      "shopArticleName": "Holzschraube",
      "Durchmesser (Merkmal)": "5",
      "meta": {
        "id": 1,
        "userID": 1,
        "userTable": "Administrator",
        "createTime": 1576234206,
        "changeTime": 1675257040
      },
	}