api.dashboard.get_grid_views

GET /dashboard/gridviews — ACPortal

Python

api.dashboard.get_grid_views() -> list[GridViewInfo]

CLI

ab dashboard get_grid_views

List the grid views available to the caller.

Each row carries the id you pass to :meth:get as view_id, plus name, dataKey, and isActive.

Query parameters — DashboardCompanyParams

Field

Type

Required

Description

companyId

Optional[str]

no

Company UUID filter

Response

Returns a list of List[GridViewInfo].

Field

Type

Required

Description

id

Optional[int]

no

View ID — feeds DashboardParams.view_id

name

Optional[str]

no

View name

dataKey

Optional[str]

no

Data key

isActive

Optional[bool]

no

Whether the view is active

storedProcedure

Optional[str]

no

Backing stored procedure

columnsSpecification

Optional[str]

no

Column specification (raw)

spColumns

Optional[list[dict]]

no

Stored procedure column metadata


← Back to api.dashboard