v1

latestOpenAPI 3.0.02026-07-14455376855.8 KB

attributeMetadata/customer/form/{formCode}

attributeMetadata/customer/form/{formCode}

Retrieve all attributes filtered by form code

get/V1/attributeMetadata/customer/form/{formCode}

Path parameters

formCodestring required

Response

200 Success.

attribute_codestring required

Code of the attribute.

backend_typestring required

Backend type.

data_modelstring required

Data model for attribute.

frontend_classstring required

Class which is used to display the attribute on frontend.

frontend_inputstring required

HTML for input element.

frontend_labelstring required

Label which supposed to be displayed on frontend.

input_filterstring required

Template used for input (e.g. "date")

is_filterable_in_gridboolean

It is filterable in customer grid

is_searchable_in_gridboolean

It is searchable in customer grid

is_used_in_gridboolean

It is used in customer grid

is_visible_in_gridboolean

It is visible in customer grid

multiline_countinteger required

Of lines of the attribute value.

notestring required

The note attribute for the element.

requiredboolean required

Attribute is required.

sort_orderinteger required

Attributes sort order.

store_labelstring required

Label of the store.

systemboolean required

This is a system attribute.

user_definedboolean required

Current attribute has been defined by a user.

visibleboolean required

Attribute is visible on frontend.