Strukturen

Die REST-API bietet die Möglichkeit Informationen über die Datenbankstruktur des Systems oder einer bestimmten Tabelle anzufragen.

Folgende Informationen können abgefragt werden:

Identifier der Tabellen
Identifier der Tabellenspalten
Eltern und Kind Tabellen

GET

Strukturanfrage aller exitsierenden Tabellen

GET $YOUR_DOMAIN_URL/rest/v4/$COLLATION/structure/
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN

GET

Strukturanfrage einer bestimmten Tabelle

GET $YOUR_DOMAIN_URL/rest/v4/$COLLATION/structure/$IDENTIFIER/
Content-Type:application/x-www-form-urlencoded
Authorization:$ACCESS_TOKEN

Beispiel Response

{
    "code": 0,
    "message": "Success",
    "body": {
        "resource": {},
        "result": {
            "identifier": "shopArticle",
            "columns": [
                "shopArticleActive",
                "shopArticleVisibilityHome",
                "shopArticleVisibilityMenu",
                "shopArticleSku",
                "shopArticleGtin",
                "shopArticleClassifications",
                "shopArticleVariantProfileID",
                "shopArticleName",
                "shopArticleNewFrom",
                "shopArticleNewTo",
                "shopArticleDescription",
                "shopArticleSeoDescription",
                "shopArticleImage1",
                "shopArticleImage2",
                "shopArticleImage3",
                "shopArticleImage4",
                "shopArticleImage5",
                "shopArticleImage6",
                "shopArticleImage7",
                "shopArticleImage8",
                "shopArticleImage9",
                "shopArticleImage10",
                "shopArticleDownload1",
                "shopArticleDownload2",
                "shopArticleDownload3",
                "shopArticleDownload4",
                "shopArticleDownload5",
                "shopArticlePrice",
                "shopArticleSpecialPrice",
                "shopArticleVatRateID",
                "shopArticleSalesUnit",
                "shopArticlePackageUnitID",
                "shopArticleAllowedOrderQuantities",
                "shopArticleMinimumOrderQuantity",
                "shopArticleWeight",
                "shopArticleDeliveryTime",
                "shopArticleWorkflowID",
                "shopArticleMetaTitle",
                "shopArticleMetaKeywords",
                "shopArticleMetaDescription",
                "shopArticleMetaRobots",
                "shopArticleDetailLayout",
                "baseJson",
                "shopArticleSupplierID",
                "changeTime",
                "clientID",
                "createTime",
                "domainID",
                "id",
                "userID",
                "userTable"
            ],
            "links": [
                "/rest/v2/join/serverRest.structure/shopArticle/"
            ],
            "parents": [
                "shopGroup"
            ],
            "children": [
                "shopArticleTemplate",
                "price",
                "shopArticleVariant"
            ]
        }
    }
}

$Collation (Pflicht)

Die Kollation setzt sich aus dem ISO 639-1 Sprachcode sowie dem ISO_3166-1 Ländercode zusammen, z.B. de_DE

$IDENTIFIER

Hier muss der Tabellen Identifier angegeben werden. Entweder ist dieser bekannt oder man kann diesen auslesen wenn man sich die Struktur aller Tabellen ausgeben lässt.