Documentation

On this page, you will find some explanations for working with certain parts of the system.

JSON Files

This CLI mainly works with JSON files, which are the saved JSON responses of the OCAPI.

Attribute Definition

The official documentation can be found here: Info Center

These files are stored within your project at <project root>/data/meta/system-objecttype-extensions/

Fields

Property	Type	Description
description	Localizable	The localized description
display_name	Localizable	The localized name.
externally_defined	Boolean	Flag indicating if this attribute is externally defined.
externally_managed	Boolean	Flag indicating if this attribute is externally managed.
field_height	Integer	The height of the field for this attribute in the editor.
field_length	Integer	The length of the field for this attribute in the editor.
id	String	The user-supplied ID of the attribute.
key	Boolean	Flag indicating if this is a key attribute.
localizable	Boolean	Flag indicating if this attribute can be localized.
mandatory	Boolean	Flag indicating if a value is mandatory for the attribute.
max_value	Double	The maximum possible value for this attribute.
min_length	Integer	The minimum length of the field for this attribute.
min_value	Double	The minimum possible value for this attribute.
multi_value_type	Boolean	True if the attribute can have multiple values.
order_required	Boolean	Flag indicating if this attribute is required for order.
scale	Integer	The minimum number of fraction digits for a value of this attribute.
searchable	Boolean	Flag indicating if this attribute is searchable.
site_specific	Boolean	Flag indicating if this attribute is site-specific.
unit	Localized	The unit of measure for this attribute.
value_type	Enum*	The type of this attribute.
visible	Boolean	Flag indicating if this attribute is visible.

*Valid types: string, int, double, text, html, date, image, boolean, money, quantity, datetime, email, password, set_of_string, set_of_int, set_of_double, enum_of_string, enum_of_int, unknown

JSON Example

{
    "description": {
        "default": "A new attribute description."
    },
    "display_name": {
        "default": "A new attribute"
    },
    "externally_defined": false,
    "externally_managed": false,
    "field_length": 1000,
    "id": "changeMe",
    "key": false,
    "localizable": false,
    "mandatory": false,
    "min_length": 0,
    "multi_value_type": false,
    "order_required": false,
    "searchable": false,
    "site_specific": false,
    "value_type": "string",
    "visible": false
}