flexmeasures.api.ui.session

Endpoints that store a user’s choices in the FlexMeasures UI in their session.

Classes

class flexmeasures.api.ui.session.DefaultAssetViewSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: Literal['exclude', 'include', 'raise'] | None = None)

class flexmeasures.api.ui.session.IncludeChildAssetsSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: Literal['exclude', 'include', 'raise'] | None = None)

class flexmeasures.api.ui.session.KeepLegendsBelowGraphsSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: Literal['exclude', 'include', 'raise'] | None = None)

class flexmeasures.api.ui.session.LegacyDefaultAssetViewSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: Literal['exclude', 'include', 'raise'] | None = None)

The request body POST /api/v3_0/assets/default_asset_view has taken since before it moved to SessionAPI.

class flexmeasures.api.ui.session.LegacyKeepLegendsBelowGraphsSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: Literal['exclude', 'include', 'raise'] | None = None)

The request body POST /api/v3_0/assets/keep_legends_below_graphs has taken since before it moved to SessionAPI.

class flexmeasures.api.ui.session.LegacyV3SessionAPI

The two session endpoints that were released as part of v3 of the official API, before they moved to SessionAPI.

They are no longer documented, but keep working, with the request bodies they always took, until v4 of the official API, as v3 does not break its endpoints. They are registered under /api/v3_0/assets, where they always were (see flexmeasures.api.ui.register_at).

update_default_asset_view(default_asset_view: str, use_as_default: bool = True)

Set which asset view the current user sees first, as SessionAPI.update_default_asset_view does.

update_keep_legends_below_graphs(keep_legends_below_graphs: bool = True)

Set whether the current user’s charts keep their legends below the graphs, as SessionAPI.update_keep_legends_below_graphs does.

class flexmeasures.api.ui.session.SessionAPI

These endpoints store the current user’s choices in the FlexMeasures UI in their session, such as which asset view to open, so that the UI keeps to them on the user’s next visit.

Like the other endpoints of this blueprint, they are not part of the official API. They exist to support the FlexMeasures UI, and may change or disappear in any FlexMeasures version.

update_automations_page_child_assets(include_child_assets: bool = True)

Remember whether the current user wants the asset automations page to list the automations of the assets below it, too.

update_default_asset_view(use_as_default: bool = True, default_asset_view: str | None = None)

Set which asset view the current user sees first when opening an asset, or go back to the system default.

update_keep_legends_below_graphs(keep_legends_below_graphs: bool = True)

Set whether the current user’s charts keep their legends below the graphs, even for many sensors.

update_status_page_child_jobs(include_child_assets: bool = True)

Remember whether the current user wants the asset status page to list the jobs of the assets below it, too.

update_status_page_tab(status_page_tab: str)

Remember which tab of the asset status page the current user last opened.

class flexmeasures.api.ui.session.StatusPageTabSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: Literal['exclude', 'include', 'raise'] | None = None)