Type Alias AlertingTaskResponse

type AlertingTaskResponse = {
    absoluteLastScan?: string;
    absoluteLastTrigger?: string;
    accessMode?: "SOURCE_ACCESS" | "TARGET_ACCESS";
    alertingTaskErrors?: AlertingTaskError[];
    appId?: string;
    bookmarkId?: string;
    conditionId?: string;
    conditionResponse?: unknown;
    dateCreated?: string;
    description?: string;
    enabled?: boolean;
    errorStatus?: "OK" | "FATAL-ERROR" | "PARTIAL-TRIGGER";
    evaluationCount?: number;
    hasHistoryCondition?: boolean;
    hideSelections?: boolean;
    id?: string;
    lastEvaluationCountUpdate?: string;
    lastExecutionStatus?: "OK" | "FAILED";
    lastScan?: string;
    lastTrigger?: string;
    lastUpdated?: string;
    links?: Links;
    name?: string;
    ownerId?: string;
    ownerName?: string;
    recipients?: Recipients;
    recipientsChangeHistory?: RecipientsChange[];
    scheduleOptions?: ScheduleOptions;
    sheetId?: string;
    status?: "creating" | "deleting";
    subscriptionIds?: string[];
    tenantId?: string;
    throttling?: ThrottlingResource;
    triggerStats: AlertingTaskTriggerStats;
    triggerType?: "RELOAD" | "SCHEDULED" | "MANUAL";
}
Index

Properties

absoluteLastScan? absoluteLastTrigger? accessMode? alertingTaskErrors? appId? bookmarkId? conditionId? conditionResponse? dateCreated? description? enabled? errorStatus? evaluationCount? hasHistoryCondition? hideSelections? id? lastEvaluationCountUpdate? lastExecutionStatus? lastScan? lastTrigger? lastUpdated? links? name? ownerId? ownerName? recipients? recipientsChangeHistory? scheduleOptions? sheetId? status? subscriptionIds? tenantId? throttling? triggerStats triggerType?

Properties

absoluteLastScan?: string

last time a trigger was detected, but not sure if executed

absoluteLastTrigger?: string

last time an execution had been created

accessMode?: "SOURCE_ACCESS" | "TARGET_ACCESS"
alertingTaskErrors?: AlertingTaskError[]
appId?: string

appId associated to this alert definition

bookmarkId?: string

bookmarkId associated to this alert definition

conditionId?: string

the id of the condition that determines if this data alert should be triggered

conditionResponse?: unknown

Should reference ConditionResponse type in condition-manager api docs

dateCreated?: string

Timestamp for the creation of the task (rfc3339 format)

description?: string

description associated to alerting task

enabled?: boolean

true if the alerting task is enabled

errorStatus?: "OK" | "FATAL-ERROR" | "PARTIAL-TRIGGER"

error labels from the latest workflow that happened within the task

evaluationCount?: number

the number of actual evaluations with engine this task has consumed in the current month

hasHistoryCondition?: boolean

true if the alert has history condition enabled

hideSelections?: boolean

Whether the selection needs to be hidden.

id?: string

data alerting identifier (this is the alertID)

lastEvaluationCountUpdate?: string

the date when the evaluation count was updated

lastExecutionStatus?: "OK" | "FAILED"
lastScan?: string

last time a trigger was detected, but not sure if executed for requesting user

lastTrigger?: string

last time an execution had been created for requesting user

lastUpdated?: string

Timestamp of the most recent update.

links?: Links
name?: string

name associated to alerting task

ownerId?: string

the owner of this alert

ownerName?: string

the owner name of this alert

recipients?: Recipients

List of recipients. An internal recipient is represented by either their user id or group id.

recipientsChangeHistory?: RecipientsChange[]
scheduleOptions?: ScheduleOptions
sheetId?: string

sheetId associated to this alert definition

status?: "creating" | "deleting"

particular status of the alerting task

subscriptionIds?: string[]

list of subscriptions related to this alerting task

tenantId?: string

the tenant of this alert

throttling?: ThrottlingResource

The rules and setup for throttling

triggerStats: AlertingTaskTriggerStats
triggerType?: "RELOAD" | "SCHEDULED" | "MANUAL"

Type of job that triggered the task

Settings

Member Visibility

On This Page

Properties