@qlik/api reference
Embed
Extend
Manage
APIs
Toolkits
Embed
Extend
Manage
APIs
Toolkits
Preparing search index...
data-alerts
AlertingTaskCreateRequest
Type Alias AlertingTaskCreateRequest
a alerting task (a definition on an alert)
type
AlertingTaskCreateRequest
=
{
appId
:
string
;
bookmarkId
?:
string
;
conditionId
:
string
;
description
?:
string
;
enabled
?:
boolean
;
name
:
string
;
recipients
:
Recipients
;
scheduleOptions
?:
ScheduleOptions
;
sheetId
?:
string
;
throttling
?:
ThrottlingResource
;
triggerType
:
"RELOAD"
|
"SCHEDULED"
;
}
Index
Properties
app
Id
bookmark
Id?
condition
Id
description?
enabled?
name
recipients
schedule
Options?
sheet
Id?
throttling?
trigger
Type
Properties
app
Id
appId
:
string
appId associated to this alert definition
Optional
bookmark
Id
bookmarkId
?:
string
condition
Id
conditionId
:
string
Optional
description
description
?:
string
Optional
enabled
enabled
?:
boolean
name
name
:
string
recipients
recipients
:
Recipients
Optional
schedule
Options
scheduleOptions
?:
ScheduleOptions
Optional
sheet
Id
sheetId
?:
string
Optional
throttling
throttling
?:
ThrottlingResource
trigger
Type
triggerType
:
"RELOAD"
|
"SCHEDULED"
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
app
Id
bookmark
Id
condition
Id
description
enabled
name
recipients
schedule
Options
sheet
Id
throttling
trigger
Type
Embed
Extend
Manage
APIs
Toolkits
@qlik/api reference
Loading...
a alerting task (a definition on an alert)