Release Notes

10.5

Back Next

Meta API

The Meta API for entities has been adjusted to always include the

identifier

and

shortIdentifier

for Entities, Fields, and Qualifications from now on. Additionally,

supportsListApi

and

supportsObjectApi

is now part of the Entity and Field objects. Here is an example of the HTML output:

For technical integrations, we strongly recommend not using the HTML output but the JSON or XML which can be fetched by providing

application/json or application/xml as accept header

Here is an example of a field definition in JSON:

{
    "averageLength": "0",
    "category": "Ordering information",
    "clonable": "true",
    "dataType": "ENTITY_ITEM",
    "description": "Unit for the item within an order unit\r\n\r\nExample: Case of mineral water with 6 bottles, \r\nContent unit: Bottle",
    "editable": "true",
    "enumeration": {
        "name": "Order units",
        "identifier": "Enum.OrderUnits"
    },
    "identifier": "Article.ContentUnit",
    "lowerBound": "0",
    "maxLength": "0",
    "mergeable": "true",
    "minLength": "0",
    "multiline": "false",
    "name": "Content unit",
    "pictureClause": "",
    "qualifiedName": "Content unit",
    "richtext": "false",
    "scale": "0",
    "searchable": "true",
    "supportsDQ": "true",
    "upperBound": "1",
    "value": "",
    "visible": "true",
    "shortIdentifier": "contentUnit",
    "supportsListApi": "true",
    "supportsObjectApi": "true"
}

Service API

Download Guide

Watch

Comments

Communities

Knowledge Base

Success Portal