IOrganizationAutomationsQuery
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Service to query automations across the organization for centralized automation management.
export interface IOrganizationAutomationsQuery
Methods
Method | Description |
|---|---|
(ALPHA) Starts the organization automations query. | |
(ALPHA) Starts the organization automations query. | |
(ALPHA) Sets author of the automation for the query. | |
(ALPHA) Sets dashboard id for the query. | |
(ALPHA) Sets external recipient of the automation for the query. | |
(ALPHA) Sets filter for the query. | |
(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 | |
(ALPHA) Sets recipient of the automation for the query. | |
(ALPHA) Sets number of automations to return per page. Default size: 100 | |
(ALPHA) Sets sorting for the query. | |
(ALPHA) Sets status of automation results for the query. | |
(ALPHA) Sets type of the automation for the query. | |
(ALPHA) This filter gets automations if either author or recipient of the automation is the provided user. | |
(ALPHA) Filter automations by workspace IDs for centralized management. |
Method details
IOrganizationAutomationsQuery.query()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Starts the organization automations query.
query(): Promise<IOrganizationAutomationsQueryResult>;
Returns
Promise<IOrganizationAutomationsQueryResult>
promise of first page of the results
IOrganizationAutomationsQuery.queryAll()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Starts the organization automations query.
queryAll(): Promise<IAutomationMetadataObject[]>;
Returns
Promise<IAutomationMetadataObject[]>
promise with a list of all automations matching the specified options
IOrganizationAutomationsQuery.withAuthor()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Sets author of the automation for the query.
withAuthor(author: string | undefined, filterType?: AutomationFilterType): IOrganizationAutomationsQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
author | string | undefined | author of the automation |
filterType | (Optional) type of filter behavior (“exact”, “include”, “exclude”) |
Returns
organization automations query
IOrganizationAutomationsQuery.withDashboard()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Sets dashboard id for the query.
withDashboard(dashboard: string, filterType?: AutomationFilterType): IOrganizationAutomationsQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
dashboard | string | dashboard id |
filterType | (Optional) type of filter behavior (“exact”, “include”, “exclude”) |
Returns
organization automations query
IOrganizationAutomationsQuery.withExternalRecipient()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Sets external recipient of the automation for the query.
withExternalRecipient(externalRecipient: string | undefined): IOrganizationAutomationsQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
externalRecipient | string | undefined | external recipient of the automation |
Returns
organization automations query
IOrganizationAutomationsQuery.withFilter()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Sets filter for the query.
withFilter(filter: {
title?: string;
}): IOrganizationAutomationsQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
filter | { title?: string; } | filter to apply |
Returns
organization automations query
IOrganizationAutomationsQuery.withPage()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Sets starting page for the query. Backend WILL return no data if the page is greater than total number of pages. Default page: 0
withPage(page: number | undefined): IOrganizationAutomationsQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
page | number | undefined | zero indexed, must be non-negative |
Returns
organization automations query
IOrganizationAutomationsQuery.withRecipient()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Sets recipient of the automation for the query.
withRecipient(recipient: string | undefined, filterType?: AutomationFilterType): IOrganizationAutomationsQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
recipient | string | undefined | recipient of the automation |
filterType | (Optional) type of filter behavior (“exact”, “include”, “exclude”) |
Returns
organization automations query
IOrganizationAutomationsQuery.withSize()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Sets number of automations to return per page. Default size: 100
withSize(size: number | undefined): IOrganizationAutomationsQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
size | number | undefined | desired max number of automations per page must be a positive number |
Returns
organization automations query
IOrganizationAutomationsQuery.withSorting()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Sets sorting for the query.
withSorting(sort: string[]): IOrganizationAutomationsQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
sort | string[] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
Returns
organization automations query
IOrganizationAutomationsQuery.withStatus()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Sets status of automation results for the query.
withStatus(status: string | undefined, filterType?: AutomationFilterType): IOrganizationAutomationsQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
status | string | undefined | status of the automation result (“SUCCESS” or “FAILED”) |
filterType | (Optional) type of filter behavior (“exact”, “include”, “exclude”) |
Returns
organization automations query
IOrganizationAutomationsQuery.withType()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Sets type of the automation for the query.
withType(type: AutomationType | undefined): IOrganizationAutomationsQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
type | AutomationType | undefined | type of the automation, e.g. “schedule” or “trigger” |
Returns
organization automations query
IOrganizationAutomationsQuery.withUser()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
This filter gets automations if either author or recipient of the automation is the provided user.
withUser(user: string): IOrganizationAutomationsQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
user | string | author or recipient of the automation |
Returns
organization automations query
IOrganizationAutomationsQuery.withWorkspace()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Filter automations by workspace IDs for centralized management.
withWorkspace(workspace: string | undefined, filterType?: AutomationFilterType): IOrganizationAutomationsQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
workspace | string | undefined | workspace ID to filter by |
filterType | (Optional) type of filter behavior (“exact”, “include”, “exclude”) |
Returns
organization automations query