list_query_workbooks¶
- PlaygroundApi.list_query_workbooks(role_id, sortby=None, sortorder=None, limit=None, offset=None, filter_expression=None, projection_expression=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)[source]¶
Get list of workbooks accessible to the user
Returns a paginated list of query workbooks that the user has access to
- Parameters:
role_id (str) – (required)
sortby (str) – Field to sort by (default: CreationTime)
sortorder (str) – Sort order: asc or desc (default: desc)
limit (int) – Number of items to return per page
offset (int) – Page offset for pagination (1-based)
filter_expression (str) – Filter expression for workbook titles
projection_expression (str) – Comma-separated list of fields to return
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Return type:
- Returns:
Returns the result object.