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 |
|---|---|---|---|
|
|
no |
Company UUID filter |
Response
Returns a list of List[GridViewInfo].
Field |
Type |
Required |
Description |
|---|---|---|---|
|
|
no |
View ID — feeds DashboardParams.view_id |
|
|
no |
View name |
|
|
no |
Data key |
|
|
no |
Whether the view is active |
|
|
no |
Backing stored procedure |
|
|
no |
Column specification (raw) |
|
|
no |
Stored procedure column metadata |