IWorkspaceAutomationService

IWorkspaceAutomationService.createAutomation()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.

Create new automation

createAutomation(automation: IAutomationMetadataObjectDefinition, options?: IGetAutomationOptions, widgetExecution?: IExecutionDefinition, overrides?: IRawExportCustomOverrides): Promise<IAutomationMetadataObject>;

Parameters

Returns

Promise<IAutomationMetadataObject>

Promise resolved with created automation.

IWorkspaceAutomationService.deleteAutomation()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.

Delete automation

deleteAutomation(id: string): Promise<void>;

Parameters

Returns

Promise<void>

Promise resolved when the automation is deleted.

IWorkspaceAutomationService.deleteAutomations()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.

Delete automations

Deletes multiple automations identified by their IDs.

deleteAutomations(ids: string[]): Promise<void>;

Parameters

Returns

Promise<void>

Promise resolved when the automations are deleted.

IWorkspaceAutomationService.getAutomation()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.

Get atuomation by id

getAutomation(id: string, options?: IGetAutomationOptions): Promise<IAutomationMetadataObject>;

Parameters

Returns

Promise<IAutomationMetadataObject>

Promise resolved with automation definition

IWorkspaceAutomationService.getAutomations()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.

Get all automations

getAutomations(options?: IGetAutomationsOptions): Promise<IAutomationMetadataObject[]>;

Parameters

Returns

Promise<IAutomationMetadataObject[]>

Promise resolved with array of automations.

Exceptions

In case of error.

IWorkspaceAutomationService.getAutomationsQuery()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.

List automations

getAutomationsQuery(options?: IGetAutomationsQueryOptions): IAutomationsQuery;

Parameters

Returns

IAutomationsQuery

methods for querying automations

IWorkspaceAutomationService.pauseAutomation()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.

Pause automation

pauseAutomation(id: string): Promise<void>;

Parameters

Returns

Promise<void>

Promise resolved when the automation is paused.

IWorkspaceAutomationService.pauseAutomations()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.

Pause automations

Pauses multiple automations identified by their IDs.

pauseAutomations(ids: string[]): Promise<void>;

Parameters

Returns

Promise<void>

Promise resolved when the automations are paused.

IWorkspaceAutomationService.resumeAutomation()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.

Resume automation

resumeAutomation(id: string): Promise<void>;

Parameters

Returns

Promise<void>

Promise resolved when the automation is resumed.

IWorkspaceAutomationService.resumeAutomations()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.

Resume automations

Resumes multiple automations identified by their IDs.

resumeAutomations(ids: string[]): Promise<void>;

Parameters

Returns

Promise<void>

Promise resolved when the automations are resumed.

IWorkspaceAutomationService.triggerAutomation()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.

Trigger existing automation

Triggers the existing automation to execute immediately.

triggerAutomation(id: string): Promise<void>;

Parameters

Returns

Promise<void>

Promise resolved when the automation is triggered.

IWorkspaceAutomationService.unsubscribeAutomation()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.

Unsubscribe automation

unsubscribeAutomation(id: string): Promise<void>;

Parameters

Returns

Promise<void>

Promise resolved when the automation is unsubscribed.

IWorkspaceAutomationService.unsubscribeAutomations()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.

Unsubscribe from automations

Unsubscribes current user from multiple automations identified by their IDs. If no IDs are provided, the backend may unsubscribe from all automations in the workspace.

unsubscribeAutomations(ids: string[]): Promise<void>;

Parameters

Returns

Promise<void>

Promise resolved when the user is unsubscribed.

IWorkspaceAutomationService.updateAutomation()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.

Update existing automation

updateAutomation(automation: IAutomationMetadataObject, options?: IGetAutomationOptions, widgetExecution?: IExecutionDefinition, overrides?: IRawExportCustomOverrides): Promise<IAutomationMetadataObject>;

Parameters

Returns

Promise<IAutomationMetadataObject>

Promise resolved when the automation is updated.