Views Models

Views/Grids models for the ACPortal API.

class ab.api.models.views.GridViewDetails(*, viewId=None, name=None, datasetSp=None, columns=None, filters=None, access=None, **extra_data)[source]

Bases: ResponseModel

Full view configuration — GET /views/{viewId} and GET /views/all.

Parameters:

viewId (str | None)
name (str | None)
datasetSp (str | None)
columns (List[dict] | None)
filters (List[dict] | None)
access (dict | None)
extra_data (Any)

view_id: str | None

name: str | None

dataset_sp: str | None

columns: List[dict] | None

filters: List[dict] | None

access: dict | None

model_config = {'alias_generator': <function _to_camel>, 'extra': 'allow', 'populate_by_name': True, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_by_alias': True, 'validate_by_name': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class ab.api.models.views.GridViewAccess(*, viewId=None, users=None, roles=None, **extra_data)[source]

Bases: ResponseModel

View access control — GET /views/{viewId}/accessinfo.

Parameters:

viewId (str | None)
users (List[dict] | None)
roles (List[dict] | None)
extra_data (Any)

view_id: str | None

users: List[dict] | None

roles: List[dict] | None

model_config = {'alias_generator': <function _to_camel>, 'extra': 'allow', 'populate_by_name': True, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_by_alias': True, 'validate_by_name': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class ab.api.models.views.StoredProcedureColumn(*, name=None, dataType=None, isSortable=None, **extra_data)[source]

Bases: ResponseModel

Dataset stored procedure column — GET /views/datasetsps and /views/datasetsp/{spName}.

Parameters:

name (str | None)
dataType (str | None)
isSortable (bool | None)
extra_data (Any)

name: str | None

data_type: str | None

is_sortable: bool | None

model_config = {'alias_generator': <function _to_camel>, 'extra': 'allow', 'populate_by_name': True, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_by_alias': True, 'validate_by_name': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class ab.api.models.views.GridViewCreateRequest(*, name=None, datasetSp=None, columns=None)[source]

Bases: RequestModel

Body for POST /views.

Parameters:

name (str | None)
datasetSp (str | None)
columns (List[dict] | None)

name: str | None

dataset_sp: str | None

columns: List[dict] | None

model_config = {'alias_generator': <function _to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_by_alias': True, 'validate_by_name': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].