Skip to main content

Get page area

Gets a specific page area.

Path Parameters
name string REQUIRED

The name of the page area to get.

Responses
200

The page area with the given name.

Schema OPTIONAL
Resource object OPTIONAL

The API-version of the PageArea class

Index int32 OPTIONAL

The primary id of this page are family collection

Name string OPTIONAL

A descriptive, user-defined name for this page area family collection

FamilyId int32 OPTIONAL

The family this area belongs to.

Settings string OPTIONAL

The settings that determine how containers can be added to this area.

Containers object[] OPTIONAL

The containers in this area

Id int32 OPTIONAL

The primary ID of this container

Name string OPTIONAL

The descriptive user defined name of this container, which is used to distinguish this container in a container library

ClassNames string[] OPTIONAL

The CSS class names this container should use.

Active boolean OPTIONAL
Layout string OPTIONAL
ResponsiveMode string OPTIONAL
Visibility string OPTIONAL
Design string OPTIONAL
Widgets object[] OPTIONAL

The configured widgets held by this container

Id uuid OPTIONAL

The IDs of widgets are immutable.

Name string OPTIONAL

The static name of this widget. Used to translate into icons, or to append to css-classes.

Type string OPTIONAL

The name of the widget-type.

Active boolean OPTIONAL

Decides if this page widget is active or not.

ClassNames string[] OPTIONAL

Holds all CSS Class names that this widget should render.

Size string OPTIONAL

The fractional size for this widget in it's container.

Configuration string OPTIONAL

The configuration for this page widget.

Message string OPTIONAL

A status message for the action taken.

Details string[] OPTIONAL

Any validation messages for the data on the current action.

404

Not found.

Schema OPTIONAL
Message string OPTIONAL

A status message for the action taken.

Details string[] OPTIONAL

Any validation messages for the data on the current action.