Sign in

v1

latestOpenAPI 3.0.42026-07-26195173268.4 KB
Blocks field definition

Gets the block field definition.

get/Litium/api/admin/blocks/fieldDefinitions/{systemId}

Path parameters

systemIdstring uuid required

The field definitions system identifier.

Response

OK

areaTypestring

Gets the type of the area.

canBeGridColumnboolean

Gets or sets a value indicating whether this instance can be grid column.

canBeGridFilterboolean

Gets or sets a value indicating whether this instance can be grid filter.

editableboolean

Gets or sets a value indicating whether this instance is editable.

hiddenboolean

Gets or sets a value indicating whether this Litium.FieldFramework.FieldDefinition is hidden.

multiCultureboolean

Gets or sets a value indicating whether [multi culture].

systemDefinedboolean

Gets or sets a value indicating whether [system defined].

systemIdstring uuid

Gets the system identifier.

fieldTypestring nullable

Gets or sets the type of the field.

idstring nullable

Gets or sets the identifier.

useInStorefrontboolean

Gets or sets a value indicating whether this field can be used in Storefront.

useInSearchEngineboolean

Gets or sets a value indicating whether this field can be used in search engine.

includeInSalesReportboolean

Gets or sets a value indicating whether this field is marked as included in sales reports.