IAutomationMetadataObjectBase
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
export interface IAutomationMetadataObjectBase
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(ALPHA) (Optional) Alerting configuration of the automation. | |||
{ id?: Identifier; title?: string; } | (ALPHA) (Optional) Dashboard that automation is related to. | ||
(ALPHA) (Optional) Details of the automation. | |||
(ALPHA) (Optional) Evaluation mode for the automation. | |||
(ALPHA) (Optional) Export definitions of the automation (attachments). | |||
{ status?: IAutomationLastRunStatus; executedAt?: string; traceId?: string; errorMessage?: string; } | (ALPHA) (Optional) Last run of the automation. | ||
{ widget?: string; targetTabIdentifier?: string; filters?: string[]; visibleFilters?: IAutomationVisibleFilter[]; visibleFiltersByTab?: Record<string, IAutomationVisibleFilter[]>; originalSchedule?: IAutomationSchedule; } | (ALPHA) (Optional) Additional metadata of the automation. | ||
string | (ALPHA) (Optional) Target notificationChannel that automation will trigger. String with webhook (notificationChannel) id. | ||
string | (ALPHA) (Optional) Title of the notification channel. | ||
(ALPHA) (Optional) Recipients of the automation. | |||
(ALPHA) (Optional) Schedule of the automation. Object with cron expression, timezone and first run timestamp. | |||
(ALPHA) (Optional) State of the automation. | |||
{ id?: Identifier; title?: string; } | (ALPHA) (Optional) Workspace that automation is related to. |
Property details
IAutomationMetadataObjectBase.alertpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Alerting configuration of the automation.
alert?: IAutomationAlert;
IAutomationMetadataObjectBase.dashboardpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Dashboard that automation is related to.
dashboard?: {
id?: Identifier;
title?: string;
};
IAutomationMetadataObjectBase.detailspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Details of the automation.
details?: IAutomationDetails;
IAutomationMetadataObjectBase.evaluationModepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Evaluation mode for the automation.
evaluationMode?: AutomationEvaluationMode;
IAutomationMetadataObjectBase.exportDefinitionspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Export definitions of the automation (attachments).
exportDefinitions?: IExportDefinitionMetadataObject[];
IAutomationMetadataObjectBase.lastRunpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Last run of the automation.
lastRun?: {
status?: IAutomationLastRunStatus;
executedAt?: string;
traceId?: string;
errorMessage?: string;
};
IAutomationMetadataObjectBase.metadatapropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Additional metadata of the automation.
metadata?: {
widget?: string;
targetTabIdentifier?: string;
filters?: string[];
visibleFilters?: IAutomationVisibleFilter[];
visibleFiltersByTab?: Record<string, IAutomationVisibleFilter[]>;
originalSchedule?: IAutomationSchedule;
};
IAutomationMetadataObjectBase.notificationChannelpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Target notificationChannel that automation will trigger. String with webhook (notificationChannel) id.
notificationChannel?: string;
IAutomationMetadataObjectBase.notificationChannelTitlepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Title of the notification channel.
notificationChannelTitle?: string;
IAutomationMetadataObjectBase.recipientspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Recipients of the automation.
recipients?: IAutomationRecipient[];
IAutomationMetadataObjectBase.schedulepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Schedule of the automation. Object with cron expression, timezone and first run timestamp.
schedule?: IAutomationSchedule;
IAutomationMetadataObjectBase.statepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
State of the automation.
state?: IAutomationState;
IAutomationMetadataObjectBase.workspacepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Workspace that automation is related to.
workspace?: {
id?: Identifier;
title?: string;
};