Views

class ab.api.endpoints.views.ViewsEndpoint(client)[source]

Saved view management (ACPortal API).

Parameters:: client (HttpClient)

list()[source]

GET /views/all

Docs: https://ab-sdk.readthedocs.io/en/latest/api/views/list.html Response model: List[GridViewDetails]

Return type:: list[GridViewDetails]

get(view_id)[source]

GET /views/{viewId}

Docs: https://ab-sdk.readthedocs.io/en/latest/api/views/get.html Response model: GridViewDetails

Parameters:: view_id (str)
Return type:: GridViewDetails

create(*, data)[source]

POST /views.

Parameters:: data (GridViewCreateRequest | dict) – View creation payload with name, dataset_sp, and columns. Accepts a GridViewCreateRequest instance or a dict.
Return type:: GridViewDetails

Request model: GridViewCreateRequest

Docs: https://ab-sdk.readthedocs.io/en/latest/api/views/create.html Request model: GridViewCreateRequest Response model: GridViewDetails

delete(view_id)[source]

DELETE /views/{viewId}

Docs: https://ab-sdk.readthedocs.io/en/latest/api/views/delete.html Response model: ServiceBaseResponse

Parameters:: view_id (str)
Return type:: ServiceBaseResponse

get_access_info(view_id)[source]

GET /views/{viewId}/accessinfo

Docs: https://ab-sdk.readthedocs.io/en/latest/api/views/get_access_info.html Response model: GridViewAccess

Parameters:: view_id (str)
Return type:: GridViewAccess

update_access(view_id, *, data)[source]

PUT /views/{viewId}/access.

Parameters:

view_id (str) – View identifier.
data (GridViewAccess | dict) – Access control payload with users and roles. Accepts a GridViewAccess instance or a dict.

Return type:

None

Request model: GridViewAccess

Docs: https://ab-sdk.readthedocs.io/en/latest/api/views/update_access.html Request model: GridViewAccess

get_dataset_sps()[source]

GET /views/datasetsps

Docs: https://ab-sdk.readthedocs.io/en/latest/api/views/get_dataset_sps.html Response model: List[StoredProcedureColumn]

Return type:: list[StoredProcedureColumn]

get_dataset_sp(sp_name)[source]

GET /views/datasetsp/{spName}

Docs: https://ab-sdk.readthedocs.io/en/latest/api/views/get_dataset_sp.html Response model: List[StoredProcedureColumn]

Parameters:: sp_name (str)
Return type:: list[StoredProcedureColumn]

Per-endpoint reference

Each route-backed method has its own page rendering the HTTP route, the Python and CLI call signatures, and the request/response model field tables. This is the page help(api.views.<method>) links to via its Docs: footer. These pages are generated by scripts/generate_endpoint_docs.py and kept current by a CI freshness gate.

Methods

list

GET /views/all — List all saved views.

Returns: list[GridViewDetails]`

views = api.views.list()

get / create / delete

Standard CRUD operations for saved views.

get_access_info / update_access

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

Returns: GridViewAccess

get_dataset_sps / get_dataset_sp

GET /views/datasetsps — List or retrieve dataset stored procedures.

Returns: list[StoredProcedureColumn]`