IWorkspacesQuery

Home > @gooddata/sdk-backend-spi > IWorkspacesQuery

IWorkspacesQuery interface

Query to retrieve available workspaces.

Signature:

export interface IWorkspacesQuery

Methods

MethodDescription
query()Executes the query and returns the result asynchronously.
withFilter(filter)(ALPHA) Sets filter of workspaces by given attributes
withLimit(limit)Sets a limit on how many items to retrieve at once.
withOffset(offset)Sets a number of items to skip.
withOptions(options)(ALPHA) Sets additional options for the query.
withParent(workspaceId)Sets a identifier of the parent workspace to get its children, otherwise the root workspace.
withSearch(search)Sets a text to search.
← IWorkspaceSettingsServiceIWorkspacesQueryFactory →