Documentation
Documentation
    • English (United States)
Space View
Close API Documentation
Space View

A space view provides a view on the space. The view allows to associate certain properties with it. The concept of a space view allows to divide the space into different "portions" which may act differently. If you have just one database and you created just one space, you may want to create different space views to have different settings for different situations.

It is mainly used to provide a different look and feel to the end user e.g. different payment form layout depending on the store front-end selected by the customer.

When no view is explicitly specified the properties associated with the space are used (default properties).

States
  • Create
    The create state indicates that the Space View is in creation.
  • Active
    The active state indicates that the Space View is active and may be used.
  • Inactive
    The inactive state indicates that the Space View is inactive and may not be used.
  • Deleting
    The deleting state indicates that the Space View is in the process to be deleted.
  • Deleted
    The deleted state marks the entity for purging from the database.
Properties
  • ID
    A unique identifier for the object.
  • Linked Space ID
    The ID of the space this object belongs to.
  • Name
    The name used to identify the space view.
  • Planned Purge Date
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • Space
    The space that the space view belongs to.
  • State
    The object's current state.

    A space view can have the following states:

    Active

    When the state is set to Active you are able to access and use the space view.

    Inactive

    When the state is set to Inactive all the corresponding configurations in this space view are ignored. However, all the information is not deleted and you can reactivate the space view at any moment.

    Deleting

    The space view is in the process of deletion. This may take some time until the space view is marked as Deleting before being marked as Deleted.

    Deleted

    The space view is deleted. Since the space view is linked with data which cannot be deleted immediately, we need to keep the space view until all the data can be removed.

  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.