IOrganizationAutomationsQuery

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

IOrganizationAutomationsQuery interface

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Service to query automations across the organization for centralized automation management.

Signature:

export interface IOrganizationAutomationsQuery

Methods

MethodDescription
query()(ALPHA) Starts the organization automations query.
queryAll()(ALPHA) Starts the organization automations query.
withAuthor(author, multiValue)(ALPHA) Sets author of the automation for the query.
withDashboard(dashboard, multiValue)(ALPHA) Sets dashboard id for the query.
withExternalRecipient(externalRecipient)(ALPHA) Sets external recipient of the automation for the query.
withFilter(filter)(ALPHA) Sets filter for the query.
withPage(page)(ALPHA) Sets starting page for the query. Backend WILL return no data if the page is greater than total number of pages. Default page: 0
withRecipient(recipient, multiValue)(ALPHA) Sets recipient of the automation for the query.
withSize(size)(ALPHA) Sets number of automations to return per page. Default size: 100
withSorting(sort)(ALPHA) Sets sorting for the query.
withStatus(status, multiValue)(ALPHA) Sets status of automation results for the query.
withType(type)(ALPHA) Sets type of the automation for the query.
withUser(user)(ALPHA) This filter gets automations if either author or recipient of the automation is the provided user.
withWorkspace(workspace, multiValue)(ALPHA) Filter automations by workspace IDs for centralized management.
← IOrganizationAutomationServiceIOrganizationAutomationsQueryResult →