IAutomationsQuery

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

IAutomationsQuery interface

Service to query automations.

Signature:

export interface IAutomationsQuery 

Methods

Method	Description
query()	Starts the automations query.
queryAll()	Starts the automations query.
withAuthor(author, filterType)	Sets author of the automation for the query.
withDashboard(dashboard, filterType)	Sets dashboard id for the query.
withExternalRecipient(externalRecipient)	Sets external recipient of the automation for the query.
withFilter(filter)	Sets filter for the query.
withPage(page)	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, filterType)	Sets recipient of the automation for the query.
withSize(size)	Sets number of automations to return per page. Default size: 100
withSorting(sort)	Sets sorting for the query.
withStatus(status, filterType)	Sets status of automation results for the query.
withType(type)	Sets type of the automation for the query.
withUser(user)	This filter gets automations if either author or recipient of the automation is the provided user.