@qlik/api 2.3.0 → 2.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/analytics/change-stores.d.ts +40 -76
- package/analytics/change-stores.js +9 -10
- package/analytics.d.ts +1 -2
- package/analytics.js +5 -6
- package/api-keys.d.ts +46 -100
- package/api-keys.js +3 -4
- package/apps.d.ts +334 -461
- package/apps.js +74 -6
- package/assistants.d.ts +172 -337
- package/assistants.js +3 -4
- package/audits.d.ts +41 -85
- package/audits.js +3 -4
- package/auth-types.d.ts +110 -1
- package/auth-types.js +22 -1
- package/auth.d.ts +1 -2
- package/auth.js +1 -1
- package/automation-connections.d.ts +44 -95
- package/automation-connections.js +3 -4
- package/automation-connectors.d.ts +10 -20
- package/automation-connectors.js +3 -4
- package/automations.d.ts +54 -112
- package/automations.js +3 -4
- package/automl-deployments.d.ts +17 -36
- package/automl-deployments.js +3 -4
- package/automl-predictions.d.ts +12 -24
- package/automl-predictions.js +3 -4
- package/banners.d.ts +8 -14
- package/banners.js +3 -4
- package/brands.d.ts +19 -39
- package/brands.js +3 -4
- package/chunks/auth-B8lJw7rm.js +31 -0
- package/chunks/{interceptors-DipDBQQ5.js → boot-interceptors-DqRxTczb.js} +296 -248
- package/chunks/{chunk-D3vHIbds.js → chunk-BdHzlgOL.js} +3 -3
- package/chunks/{invoke-fetch-B7lGscuQ.js → invoke-fetch-DMAi6Fg3.js} +3 -3
- package/chunks/{invoke-fetch-DhdyFZ0F.js → invoke-fetch-pMN6iqup.js} +2 -3
- package/chunks/platform-types-CECrZkOF.d.ts +29 -0
- package/chunks/{public-runtime-modules-QhLPeQr5.js → public-runtime-modules-2KfyI2qM.js} +5 -5
- package/chunks/{qix-RCUslia8.js → qix-BdNrIA4s.js} +19 -20
- package/chunks/{qix-chunk-entrypoint-WAS4NVTf.js → qix-chunk-entrypoint-L9RpWwLK.js} +52 -58
- package/chunks/{qix-CrqXv44x.d.ts → qix-types-y_di0roE.d.ts} +33 -115
- package/collections.d.ts +67 -144
- package/collections.js +3 -4
- package/conditions.d.ts +87 -190
- package/conditions.js +3 -4
- package/consumption.d.ts +35 -72
- package/consumption.js +3 -4
- package/core/ip-policies.d.ts +43 -93
- package/core/ip-policies.js +5 -6
- package/core.d.ts +1 -2
- package/core.js +5 -6
- package/csp-origins.d.ts +42 -85
- package/csp-origins.js +3 -4
- package/csrf-token.d.ts +6 -11
- package/csrf-token.js +3 -4
- package/data-alerts.d.ts +152 -325
- package/data-alerts.js +3 -4
- package/data-assets.d.ts +16 -31
- package/data-assets.js +3 -4
- package/data-connections.d.ts +123 -257
- package/data-connections.js +3 -4
- package/data-credentials.d.ts +36 -76
- package/data-credentials.js +3 -4
- package/data-files.d.ts +60 -121
- package/data-files.js +3 -4
- package/data-governance/data-products.d.ts +429 -0
- package/data-governance/data-products.js +212 -0
- package/data-governance.d.ts +13 -0
- package/data-governance.js +12 -0
- package/data-qualities.d.ts +11 -25
- package/data-qualities.js +3 -4
- package/data-sets.d.ts +28 -57
- package/data-sets.js +3 -4
- package/data-sources.d.ts +45 -97
- package/data-sources.js +3 -4
- package/data-stores.d.ts +53 -107
- package/data-stores.js +3 -4
- package/dcaas.d.ts +32 -67
- package/dcaas.js +3 -4
- package/di-projects.d.ts +111 -136
- package/di-projects.js +25 -4
- package/direct-access-agents.d.ts +29 -63
- package/direct-access-agents.js +3 -4
- package/encryption.d.ts +28 -59
- package/encryption.js +3 -4
- package/extensions.d.ts +35 -73
- package/extensions.js +3 -4
- package/global-types.d.ts +139 -1
- package/glossaries.d.ts +75 -158
- package/glossaries.js +3 -4
- package/groups.d.ts +58 -125
- package/groups.js +3 -4
- package/identity-providers.d.ts +148 -324
- package/identity-providers.js +3 -4
- package/index.d.ts +18 -4
- package/index.js +64 -19
- package/interceptors.d.ts +2 -3
- package/interceptors.js +104 -2
- package/invoke-fetch-types.d.ts +97 -1
- package/items.d.ts +85 -181
- package/items.js +3 -4
- package/knowledgebases.d.ts +137 -270
- package/knowledgebases.js +3 -4
- package/licenses.d.ts +71 -153
- package/licenses.js +3 -4
- package/lineage-graphs.d.ts +39 -85
- package/lineage-graphs.js +3 -4
- package/ml.d.ts +290 -621
- package/ml.js +3 -4
- package/notes.d.ts +9 -18
- package/notes.js +3 -4
- package/notifications.d.ts +14 -30
- package/notifications.js +3 -4
- package/oauth-clients.d.ts +98 -159
- package/oauth-clients.js +4 -5
- package/oauth-tokens.d.ts +16 -33
- package/oauth-tokens.js +3 -4
- package/package.json +6 -4
- package/qix.d.ts +46 -2
- package/qix.js +2 -3
- package/questions.d.ts +53 -110
- package/questions.js +3 -4
- package/quotas.d.ts +13 -26
- package/quotas.js +3 -4
- package/reload-tasks.d.ts +23 -46
- package/reload-tasks.js +3 -4
- package/reloads.d.ts +26 -52
- package/reloads.js +3 -4
- package/report-templates.d.ts +30 -63
- package/report-templates.js +3 -4
- package/reports.d.ts +111 -238
- package/reports.js +3 -4
- package/roles.d.ts +36 -77
- package/roles.js +3 -4
- package/sharing-tasks.d.ts +201 -427
- package/sharing-tasks.js +3 -4
- package/spaces.d.ts +71 -157
- package/spaces.js +3 -4
- package/tasks.d.ts +76 -164
- package/tasks.js +3 -4
- package/temp-contents.d.ts +17 -35
- package/temp-contents.js +3 -4
- package/tenant-settings.d.ts +298 -0
- package/tenant-settings.js +107 -0
- package/tenants.d.ts +31 -67
- package/tenants.js +3 -4
- package/themes.d.ts +27 -55
- package/themes.js +3 -4
- package/transports.d.ts +46 -106
- package/transports.js +3 -4
- package/ui-config.d.ts +8 -17
- package/ui-config.js +3 -4
- package/users.d.ts +80 -170
- package/users.js +3 -4
- package/web-integrations.d.ts +38 -83
- package/web-integrations.js +3 -4
- package/web-notifications.d.ts +14 -29
- package/web-notifications.js +3 -4
- package/webhooks.d.ts +77 -162
- package/webhooks.js +3 -4
- package/chunks/auth-BowS4SUR.js +0 -28
- package/chunks/auth-types-YrlH_R9f.d.ts +0 -416
- package/chunks/auth-types-h43TVDpB.js +0 -24
- package/chunks/global-types-CEVAJebk.js +0 -1
- /package/chunks/{dist-n3iOVn1W.js → dist-DR758NU5.js} +0 -0
- /package/chunks/{invoke-fetch-C1Z0RJYU.d.ts → invoke-fetch-DFc3yzaj.d.ts} +0 -0
- /package/chunks/{utils-vv-xFm06.js → utils-jkpLuYZR.js} +0 -0
- /package/chunks/{websocket-errors-CRTDTtBL.js → websocket-errors-C5U1tba-.js} +0 -0
package/data-alerts.d.ts
CHANGED
|
@@ -1,61 +1,44 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import "./chunks/invoke-fetch-
|
|
1
|
+
import { ApiCallOptions } from "./invoke-fetch-types.js";
|
|
2
|
+
import "./chunks/invoke-fetch-DFc3yzaj.js";
|
|
3
3
|
|
|
4
4
|
//#region src/public/rest/data-alerts.d.ts
|
|
5
5
|
type AlertingActionsTriggerCreateRequest = {
|
|
6
6
|
alertingTaskID: string;
|
|
7
7
|
};
|
|
8
8
|
type AlertingActionsTriggerCreateResponse = {
|
|
9
|
-
/** the workflow id created for the manual triggering of alert */
|
|
10
|
-
workflowID?: string;
|
|
9
|
+
/** the workflow id created for the manual triggering of alert */workflowID?: string;
|
|
11
10
|
};
|
|
12
11
|
type AlertingConditionResponse = {
|
|
13
|
-
/** Should reference ConditionResponse type in condition-manager api docs */
|
|
14
|
-
conditionResponse?: unknown;
|
|
12
|
+
/** Should reference ConditionResponse type in condition-manager api docs */conditionResponse?: unknown;
|
|
15
13
|
hideSelections?: boolean;
|
|
16
14
|
};
|
|
17
15
|
type AlertingExecutionError = {
|
|
18
|
-
/** Error code specific to sharing service. */
|
|
19
|
-
readonly
|
|
20
|
-
/** Error cause. */
|
|
21
|
-
readonly detail?: string;
|
|
22
|
-
/** Error title. */
|
|
16
|
+
/** Error code specific to sharing service. */readonly code?: string; /** Error cause. */
|
|
17
|
+
readonly detail?: string; /** Error title. */
|
|
23
18
|
readonly title?: string;
|
|
24
19
|
};
|
|
25
20
|
type AlertingExecutionErrors = AlertingExecutionError[];
|
|
26
21
|
type AlertingExecutionListResponse = StandardListResponseProps & {
|
|
27
|
-
/** Gets a list of alerting-executions. */
|
|
28
|
-
executions?: AlertingExecutionResponse[];
|
|
22
|
+
/** Gets a list of alerting-executions. */executions?: AlertingExecutionResponse[];
|
|
29
23
|
links?: ListLinks;
|
|
30
24
|
};
|
|
31
25
|
type AlertingExecutionPersist = {
|
|
32
|
-
accessMode?: "SOURCE_ACCESS" | "TARGET_ACCESS";
|
|
33
|
-
/**
|
|
34
|
-
|
|
35
|
-
/** Id of the bookmark associated with an alert */
|
|
36
|
-
bookmarkId?: string;
|
|
37
|
-
/** Id of the condition the alert is associated with */
|
|
26
|
+
accessMode?: "SOURCE_ACCESS" | "TARGET_ACCESS"; /** ID for the alerting task that this execution references */
|
|
27
|
+
alertId?: string; /** Id of the bookmark associated with an alert */
|
|
28
|
+
bookmarkId?: string; /** Id of the condition the alert is associated with */
|
|
38
29
|
conditionId?: string;
|
|
39
|
-
conditionStatus?: "FINISHED" | "FAILED";
|
|
40
|
-
/** Dimensions applied in the condition */
|
|
30
|
+
conditionStatus?: "FINISHED" | "FAILED"; /** Dimensions applied in the condition */
|
|
41
31
|
dimensions?: string[];
|
|
42
|
-
errors?: AlertingExecutionErrors;
|
|
43
|
-
/** Id of the evaluation for the condition */
|
|
32
|
+
errors?: AlertingExecutionErrors; /** Id of the evaluation for the condition */
|
|
44
33
|
evaluationId?: string;
|
|
45
34
|
executionEvaluationStatus?: "CONDITION_MET" | "CONDITION_NOT_MET" | "FAILED";
|
|
46
|
-
executionType?: "INDIVIDUAL" | "SHARED";
|
|
47
|
-
/**
|
|
48
|
-
|
|
49
|
-
/** Measures applied in the condition */
|
|
50
|
-
measures?: string[];
|
|
51
|
-
/** The owner that this execution belongs to */
|
|
35
|
+
executionType?: "INDIVIDUAL" | "SHARED"; /** Gets the execution identifier. */
|
|
36
|
+
id?: string; /** Measures applied in the condition */
|
|
37
|
+
measures?: string[]; /** The owner that this execution belongs to */
|
|
52
38
|
ownerId?: string;
|
|
53
|
-
result?: AlertingExecutionResult;
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
/** Timestamp of execution start */
|
|
57
|
-
triggerTime?: string;
|
|
58
|
-
/** ID for the workflow, coming from eventing service */
|
|
39
|
+
result?: AlertingExecutionResult; /** The tenant that this execution belongs to */
|
|
40
|
+
tenantId?: string; /** Timestamp of execution start */
|
|
41
|
+
triggerTime?: string; /** ID for the workflow, coming from eventing service */
|
|
59
42
|
workflowId?: string;
|
|
60
43
|
};
|
|
61
44
|
type AlertingExecutionResponse = AlertingExecutionPersist & {
|
|
@@ -67,27 +50,19 @@ type AlertingExecutionResult = {
|
|
|
67
50
|
throttlerTokensLeft?: number;
|
|
68
51
|
};
|
|
69
52
|
type AlertingRecipientStats = {
|
|
70
|
-
conditionStatus?: "OK" | "FAILED";
|
|
71
|
-
/** Whether the recipient is enabled. */
|
|
53
|
+
conditionStatus?: "OK" | "FAILED"; /** Whether the recipient is enabled. */
|
|
72
54
|
enabled: boolean;
|
|
73
|
-
errors?: AlertingRecipientStatsErrors;
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
lastScan?: string;
|
|
78
|
-
/** last time an execution had been created */
|
|
79
|
-
lastTrigger?: string;
|
|
80
|
-
/** Whether the recipient is subscribed. */
|
|
55
|
+
errors?: AlertingRecipientStatsErrors; /** A list of associated groups. If a user is added individually the "addedIndividually" pseudo group is included */
|
|
56
|
+
groups?: string[]; /** last time a trigger was detected, but not sure if executed */
|
|
57
|
+
lastScan?: string; /** last time an execution had been created */
|
|
58
|
+
lastTrigger?: string; /** Whether the recipient is subscribed. */
|
|
81
59
|
subscribed?: boolean;
|
|
82
60
|
type?: "userid";
|
|
83
61
|
value?: string;
|
|
84
62
|
};
|
|
85
63
|
type AlertingRecipientStatsError = {
|
|
86
|
-
/** Error code specific to sharing service. */
|
|
87
|
-
readonly
|
|
88
|
-
/** Error cause. */
|
|
89
|
-
readonly detail?: string;
|
|
90
|
-
/** Error title. */
|
|
64
|
+
/** Error code specific to sharing service. */readonly code?: string; /** Error cause. */
|
|
65
|
+
readonly detail?: string; /** Error title. */
|
|
91
66
|
readonly title?: string;
|
|
92
67
|
};
|
|
93
68
|
type AlertingRecipientStatsErrors = AlertingRecipientStatsError[];
|
|
@@ -95,57 +70,36 @@ type AlertingRecipientStatsResponse = {
|
|
|
95
70
|
recipientStats?: AlertingRecipientStats[];
|
|
96
71
|
};
|
|
97
72
|
type AlertingSettings = {
|
|
98
|
-
/** This indicates that there is an ongoing operation to either disable or enable the data alerting feature. none means that no such operation is ongoing. enabling/disabling means that system is currently enabling/disabling the feature */
|
|
99
|
-
readonly "data-alerting-feature-operation-status"?:
|
|
100
|
-
|
|
101
|
-
readonly
|
|
102
|
-
/**
|
|
103
|
-
"data-alerting
|
|
104
|
-
|
|
105
|
-
readonly dataAlertsConsumed?: number;
|
|
106
|
-
/** Represents the number of data alerts limit to be consumed by the user either as an owner or recipient */
|
|
107
|
-
readonly dataAlertsLimits?: number;
|
|
108
|
-
/** true if data-alerting feature is enabled for this tenant. Enabling this feature also requires that the license has this feature enabled. */
|
|
109
|
-
"enable-data-alerting": boolean;
|
|
110
|
-
/** The maximum number of recipients that can be present in an alerting task in TARGET_ACCESS mode. New recipients cannot be added when this limit is exceeded */
|
|
111
|
-
readonly "max-recipients-in-target-access"?: number;
|
|
112
|
-
/** These persisted alerting settings are only available for this tenant. Extracted from request JWT. */
|
|
73
|
+
/** This indicates that there is an ongoing operation to either disable or enable the data alerting feature. none means that no such operation is ongoing. enabling/disabling means that system is currently enabling/disabling the feature */readonly "data-alerting-feature-operation-status"?: "none" | "enabling" | "disabling"; /** UTC timestamp of the most recent change of data-alerting-feature-operation-status. If there has not been any such change, this is the timestamp of the initial creation of the record. */
|
|
74
|
+
readonly "data-alerting-feature-operation-status-change"?: string; /** Whether the license for the tenant has the data alerting feature enabled. */
|
|
75
|
+
"data-alerting-license-status"?: "enabled" | "disabled"; /** Represents the number of data alerts consumed by the user either as an owner or recipient */
|
|
76
|
+
readonly dataAlertsConsumed?: number; /** Represents the number of data alerts limit to be consumed by the user either as an owner or recipient */
|
|
77
|
+
readonly dataAlertsLimits?: number; /** true if data-alerting feature is enabled for this tenant. Enabling this feature also requires that the license has this feature enabled. */
|
|
78
|
+
"enable-data-alerting": boolean; /** The maximum number of recipients that can be present in an alerting task in TARGET_ACCESS mode. New recipients cannot be added when this limit is exceeded */
|
|
79
|
+
readonly "max-recipients-in-target-access"?: number; /** These persisted alerting settings are only available for this tenant. Extracted from request JWT. */
|
|
113
80
|
readonly tenantId?: string;
|
|
114
81
|
};
|
|
115
82
|
type AlertingSettingsUpload = {
|
|
116
|
-
/** true if data-alerting feature is enabled. A status change could potentially result in a considerable amount of API operations to enable/disable triggers. Enabling this feature also requires that the license has this feature enabled. */
|
|
117
|
-
"enable-data-alerting": boolean;
|
|
83
|
+
/** true if data-alerting feature is enabled. A status change could potentially result in a considerable amount of API operations to enable/disable triggers. Enabling this feature also requires that the license has this feature enabled. */"enable-data-alerting": boolean;
|
|
118
84
|
};
|
|
119
85
|
/**
|
|
120
86
|
* a alerting task (a definition on an alert)
|
|
121
87
|
*/
|
|
122
88
|
type AlertingTaskCreateRequest = {
|
|
123
|
-
/** appId associated to this alert definition */
|
|
124
|
-
|
|
125
|
-
/**
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
/** description associated to alerting task */
|
|
130
|
-
description?: string;
|
|
131
|
-
/** if the alerting task is enabled */
|
|
132
|
-
enabled?: boolean;
|
|
133
|
-
/** name associated to alerting task */
|
|
134
|
-
name: string;
|
|
135
|
-
/** List of recipients. An internal recipient is represented by either their user id or group id. */
|
|
89
|
+
/** appId associated to this alert definition */appId: string; /** bookmarkId associated to this alert definition */
|
|
90
|
+
bookmarkId?: string; /** the id of the condition that determines if this data alert should be triggered */
|
|
91
|
+
conditionId: string; /** description associated to alerting task */
|
|
92
|
+
description?: string; /** if the alerting task is enabled */
|
|
93
|
+
enabled?: boolean; /** name associated to alerting task */
|
|
94
|
+
name: string; /** List of recipients. An internal recipient is represented by either their user id or group id. */
|
|
136
95
|
recipients: Recipients;
|
|
137
|
-
scheduleOptions?: ScheduleOptions;
|
|
138
|
-
/**
|
|
139
|
-
|
|
140
|
-
/** The rules and setup for throttling */
|
|
141
|
-
throttling?: ThrottlingResource;
|
|
142
|
-
/** Type of job that triggered the task */
|
|
96
|
+
scheduleOptions?: ScheduleOptions; /** sheetId associated to this alert definition */
|
|
97
|
+
sheetId?: string; /** The rules and setup for throttling */
|
|
98
|
+
throttling?: ThrottlingResource; /** Type of job that triggered the task */
|
|
143
99
|
triggerType: "RELOAD" | "SCHEDULED";
|
|
144
100
|
};
|
|
145
101
|
type AlertingTaskError = {
|
|
146
|
-
/** Timestamp for the creation of the error */
|
|
147
|
-
added?: string;
|
|
148
|
-
/** Identifier for type of error occurring on alerting task */
|
|
102
|
+
/** Timestamp for the creation of the error */added?: string; /** Identifier for type of error occurring on alerting task */
|
|
149
103
|
value?: "OWNER_DISABLED" | "OWNER_ACCESS" | "OWNER_LICENSE" | "APP_DELETED" | "NO_RECIPIENTS" | "PARTIAL_ACCESS" | "EVAL_ERROR" | "ORPHAN" | "CONVERSION_DENIED" | "EXPIRED" | "PARTIAL_SENT" | "QUOTA_REACHED" | "OWNER_HAS_NO_VALID_USER_ENTITLEMENT";
|
|
150
104
|
};
|
|
151
105
|
/**
|
|
@@ -156,29 +110,21 @@ type AlertingTaskExecutionStats = StandardListResponseProps & {
|
|
|
156
110
|
links?: ListLinks;
|
|
157
111
|
};
|
|
158
112
|
type AlertingTaskGroupRecipientError = {
|
|
159
|
-
/** Timestamp for the creation of the error */
|
|
160
|
-
added?: string;
|
|
161
|
-
/** Identifier for type of error occurring on alerting task */
|
|
113
|
+
/** Timestamp for the creation of the error */added?: string; /** Identifier for type of error occurring on alerting task */
|
|
162
114
|
value?: "GROUP_IS_DISABLED" | "MAX_ALERTS_LIMIT_REACHED" | "GROUP_WITH_NO_APP_ACCESS" | "GROUP_IS_DELETED";
|
|
163
115
|
};
|
|
164
116
|
type AlertingTaskListResponse = StandardListResponseProps & {
|
|
165
|
-
links?: ListLinks;
|
|
166
|
-
/** Gets a list of alerting tasks. */
|
|
117
|
+
links?: ListLinks; /** Gets a list of alerting tasks. */
|
|
167
118
|
tasks?: AlertingTaskResponse[];
|
|
168
119
|
};
|
|
169
120
|
type AlertingTaskPatchRequestCompliant = {
|
|
170
|
-
/** The operation to be performed */
|
|
171
|
-
|
|
172
|
-
/** A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902 */
|
|
173
|
-
path: "/ownerName" | "/ownerId" | "/conditionId" | "/enabledAction" | "/bookmarkId" | "/name" | "/description" | "/throttling" | "/triggerType" | "/scheduleOptions";
|
|
174
|
-
/** The value to be used for this operation. */
|
|
121
|
+
/** The operation to be performed */op: "replace"; /** A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902 */
|
|
122
|
+
path: "/ownerName" | "/ownerId" | "/conditionId" | "/enabledAction" | "/bookmarkId" | "/name" | "/description" | "/throttling" | "/triggerType" | "/scheduleOptions"; /** The value to be used for this operation. */
|
|
175
123
|
value?: unknown;
|
|
176
124
|
};
|
|
177
125
|
type AlertingTaskPatchRequestCompliantList = AlertingTaskPatchRequestCompliant[];
|
|
178
126
|
type AlertingTaskRecipientError = {
|
|
179
|
-
/** Timestamp for the creation of the error */
|
|
180
|
-
added?: string;
|
|
181
|
-
/** Identifier for type of error occurring on alerting task */
|
|
127
|
+
/** Timestamp for the creation of the error */added?: string; /** Identifier for type of error occurring on alerting task */
|
|
182
128
|
value?: "USER_IS_DELETED" | "USER_DISABLED_IN_QCS" | "NO_ACCESS_TO_APP" | "UNSUBSCRIBED_FROM_ALERT" | "CONDITION_EVAL_ERROR" | "USER_DISABLED_IN_ALERT_BY_OWNER" | "MAX_ALERTS_LIMIT_REACHED";
|
|
183
129
|
};
|
|
184
130
|
/**
|
|
@@ -223,95 +169,58 @@ type AlertingTaskRecipientError = {
|
|
|
223
169
|
*/
|
|
224
170
|
type AlertingTaskRecipientPatch = AlertingTaskRecipientPatchInner[];
|
|
225
171
|
type AlertingTaskRecipientPatchInner = {
|
|
226
|
-
/** The operation to be performed. */
|
|
227
|
-
|
|
228
|
-
/** Defines the path for the given resource field to patch. */
|
|
229
|
-
recipientType: "userid" | "groupid";
|
|
230
|
-
/** The value to be used for this operation. */
|
|
172
|
+
/** The operation to be performed. */op: "remove" | "add" | "replace" | "enable" | "disable" | "subscribe" | "unsubscribe"; /** Defines the path for the given resource field to patch. */
|
|
173
|
+
recipientType: "userid" | "groupid"; /** The value to be used for this operation. */
|
|
231
174
|
value: unknown;
|
|
232
175
|
};
|
|
233
176
|
type AlertingTaskResponse = {
|
|
234
|
-
/** last time a trigger was detected, but not sure if executed */
|
|
235
|
-
absoluteLastScan?: string;
|
|
236
|
-
/** last time an execution had been created */
|
|
177
|
+
/** last time a trigger was detected, but not sure if executed */absoluteLastScan?: string; /** last time an execution had been created */
|
|
237
178
|
absoluteLastTrigger?: string;
|
|
238
179
|
accessMode?: "SOURCE_ACCESS" | "TARGET_ACCESS";
|
|
239
|
-
alertingTaskErrors?: AlertingTaskError[];
|
|
240
|
-
/**
|
|
241
|
-
|
|
242
|
-
/**
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
/**
|
|
247
|
-
|
|
248
|
-
/**
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
/** true if the alerting task is enabled */
|
|
253
|
-
enabled?: boolean;
|
|
254
|
-
/** error labels from the latest workflow that happened within the task */
|
|
255
|
-
errorStatus?: "OK" | "FATAL-ERROR" | "PARTIAL-TRIGGER";
|
|
256
|
-
/** the number of actual evaluations with engine this task has consumed in the current month */
|
|
257
|
-
evaluationCount?: number;
|
|
258
|
-
/** true if the alert has history condition enabled */
|
|
259
|
-
hasHistoryCondition?: boolean;
|
|
260
|
-
/** Whether the selection needs to be hidden. */
|
|
261
|
-
hideSelections?: boolean;
|
|
262
|
-
/** data alerting identifier (this is the alertID) */
|
|
263
|
-
id?: string;
|
|
264
|
-
/** the date when the evaluation count was updated */
|
|
180
|
+
alertingTaskErrors?: AlertingTaskError[]; /** appId associated to this alert definition */
|
|
181
|
+
appId?: string; /** bookmarkId associated to this alert definition */
|
|
182
|
+
bookmarkId?: string; /** the id of the condition that determines if this data alert should be triggered */
|
|
183
|
+
conditionId?: string; /** Should reference ConditionResponse type in condition-manager api docs */
|
|
184
|
+
conditionResponse?: unknown; /** Timestamp for the creation of the task (rfc3339 format) */
|
|
185
|
+
dateCreated?: string; /** description associated to alerting task */
|
|
186
|
+
description?: string; /** true if the alerting task is enabled */
|
|
187
|
+
enabled?: boolean; /** error labels from the latest workflow that happened within the task */
|
|
188
|
+
errorStatus?: "OK" | "FATAL-ERROR" | "PARTIAL-TRIGGER"; /** the number of actual evaluations with engine this task has consumed in the current month */
|
|
189
|
+
evaluationCount?: number; /** true if the alert has history condition enabled */
|
|
190
|
+
hasHistoryCondition?: boolean; /** Whether the selection needs to be hidden. */
|
|
191
|
+
hideSelections?: boolean; /** data alerting identifier (this is the alertID) */
|
|
192
|
+
id?: string; /** the date when the evaluation count was updated */
|
|
265
193
|
lastEvaluationCountUpdate?: string;
|
|
266
|
-
lastExecutionStatus?: "OK" | "FAILED";
|
|
267
|
-
/** last time
|
|
268
|
-
|
|
269
|
-
/** last time an execution had been created for requesting user */
|
|
270
|
-
lastTrigger?: string;
|
|
271
|
-
/** Timestamp of the most recent update. */
|
|
194
|
+
lastExecutionStatus?: "OK" | "FAILED"; /** last time a trigger was detected, but not sure if executed for requesting user */
|
|
195
|
+
lastScan?: string; /** last time an execution had been created for requesting user */
|
|
196
|
+
lastTrigger?: string; /** Timestamp of the most recent update. */
|
|
272
197
|
lastUpdated?: string;
|
|
273
|
-
links?: Links;
|
|
274
|
-
/**
|
|
275
|
-
|
|
276
|
-
/**
|
|
277
|
-
ownerId?: string;
|
|
278
|
-
/** the owner name of this alert */
|
|
279
|
-
ownerName?: string;
|
|
280
|
-
/** List of recipients. An internal recipient is represented by either their user id or group id. */
|
|
198
|
+
links?: Links; /** name associated to alerting task */
|
|
199
|
+
name?: string; /** the owner of this alert */
|
|
200
|
+
ownerId?: string; /** the owner name of this alert */
|
|
201
|
+
ownerName?: string; /** List of recipients. An internal recipient is represented by either their user id or group id. */
|
|
281
202
|
recipients?: Recipients;
|
|
282
203
|
recipientsChangeHistory?: RecipientsChange[];
|
|
283
|
-
scheduleOptions?: ScheduleOptions;
|
|
284
|
-
/**
|
|
285
|
-
|
|
286
|
-
/**
|
|
287
|
-
|
|
288
|
-
/** list of subscriptions related to this alerting task */
|
|
289
|
-
subscriptionIds?: string[];
|
|
290
|
-
/** the tenant of this alert */
|
|
291
|
-
tenantId?: string;
|
|
292
|
-
/** The rules and setup for throttling */
|
|
204
|
+
scheduleOptions?: ScheduleOptions; /** sheetId associated to this alert definition */
|
|
205
|
+
sheetId?: string; /** particular status of the alerting task */
|
|
206
|
+
status?: "creating" | "deleting"; /** list of subscriptions related to this alerting task */
|
|
207
|
+
subscriptionIds?: string[]; /** the tenant of this alert */
|
|
208
|
+
tenantId?: string; /** The rules and setup for throttling */
|
|
293
209
|
throttling?: ThrottlingResource;
|
|
294
|
-
triggerStats: AlertingTaskTriggerStats;
|
|
295
|
-
/** Type of job that triggered the task */
|
|
210
|
+
triggerStats: AlertingTaskTriggerStats; /** Type of job that triggered the task */
|
|
296
211
|
triggerType?: "RELOAD" | "SCHEDULED" | "MANUAL";
|
|
297
212
|
};
|
|
298
213
|
type AlertingTaskTriggerStats = {
|
|
299
|
-
/** The number of triggers out of the last 100 scans for the current condition. */
|
|
300
|
-
|
|
301
|
-
/** The number of triggers out of the last 10 scans for the current condition. */
|
|
302
|
-
last10Scans: number;
|
|
303
|
-
/** The number of scans for the current condition. */
|
|
214
|
+
/** The number of triggers out of the last 100 scans for the current condition. */last100Scans: number; /** The number of triggers out of the last 10 scans for the current condition. */
|
|
215
|
+
last10Scans: number; /** The number of scans for the current condition. */
|
|
304
216
|
totalScans: number;
|
|
305
217
|
};
|
|
306
218
|
type AlertingTaskValidation = {
|
|
307
|
-
/** Description of the error */
|
|
308
|
-
description?: string;
|
|
219
|
+
/** Description of the error */description?: string;
|
|
309
220
|
/** @deprecated
|
|
310
221
|
* Identifier for a validation error occurring on alerting task */
|
|
311
|
-
error?: "NO_ACCESS" | "USER_IS_DISABLED" | "INVALID_CONDITION" | "GROUP_IS_DISABLED" | "GROUP_SIZE_EXCEEDED";
|
|
312
|
-
/**
|
|
313
|
-
id?: string;
|
|
314
|
-
/** Identifier for type of a validation error occurring on alerting task */
|
|
222
|
+
error?: "NO_ACCESS" | "USER_IS_DISABLED" | "INVALID_CONDITION" | "GROUP_IS_DISABLED" | "GROUP_SIZE_EXCEEDED"; /** Identifies for user id or condition id */
|
|
223
|
+
id?: string; /** Identifier for type of a validation error occurring on alerting task */
|
|
315
224
|
type?: "RECIPIENT" | "CONDITION" | "RECIPIENT_GROUP";
|
|
316
225
|
validationErrors?: ("NO_ACCESS" | "USER_IS_DISABLED" | "INVALID_CONDITION" | "MAX_ALERTS_LIMIT_REACHED" | "MAX_ALERT_RECIPIENTS_LIMIT_REACHED" | "GROUP_IS_DISABLED" | "GROUP_SIZE_EXCEEDED")[];
|
|
317
226
|
};
|
|
@@ -320,17 +229,13 @@ type AlertingTaskValidationResponse = {
|
|
|
320
229
|
validations?: AlertingTaskValidation[];
|
|
321
230
|
};
|
|
322
231
|
type Error = {
|
|
323
|
-
/** Error code specific to sharing service. */
|
|
324
|
-
readonly code?: string;
|
|
325
|
-
/** Error cause. */
|
|
232
|
+
/** Error code specific to sharing service. */readonly code?: string; /** Error cause. */
|
|
326
233
|
readonly detail?: string;
|
|
327
|
-
meta?: ErrorMeta;
|
|
328
|
-
/** Error title. */
|
|
234
|
+
meta?: ErrorMeta; /** Error title. */
|
|
329
235
|
readonly title?: string;
|
|
330
236
|
};
|
|
331
237
|
type ErrorMeta = {
|
|
332
|
-
/** HTTP error code. */
|
|
333
|
-
readonly httpCode?: number;
|
|
238
|
+
/** HTTP error code. */readonly httpCode?: number;
|
|
334
239
|
};
|
|
335
240
|
/**
|
|
336
241
|
* @example
|
|
@@ -349,29 +254,17 @@ type Errors = {
|
|
|
349
254
|
traceId?: string;
|
|
350
255
|
};
|
|
351
256
|
type Evaluation = {
|
|
352
|
-
/** Representation of the event that caused the condition to be evaluated if one was included on when the evaluation was triggered */
|
|
353
|
-
|
|
354
|
-
/** The unique id
|
|
355
|
-
readonly
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
/** The
|
|
359
|
-
readonly
|
|
360
|
-
/** The time the evaluation
|
|
361
|
-
readonly
|
|
362
|
-
/** The
|
|
363
|
-
readonly id?: string;
|
|
364
|
-
/** userId of user being impersonated to evaluate the condition */
|
|
365
|
-
readonly ownerId?: string;
|
|
366
|
-
/** The final result of the evalution */
|
|
367
|
-
readonly result?: "success" | "failure" | "error";
|
|
368
|
-
/** Condition type specific result, one of dataResult or compoundResult */
|
|
369
|
-
resultData?: unknown;
|
|
370
|
-
/** The time the evaluation started */
|
|
371
|
-
readonly startTime?: string;
|
|
372
|
-
/** The status of the evaluation execution */
|
|
373
|
-
readonly status?: "RUNNING" | "FAILED" | "FINISHED";
|
|
374
|
-
/** The tenant id */
|
|
257
|
+
/** Representation of the event that caused the condition to be evaluated if one was included on when the evaluation was triggered */causalEvent?: unknown; /** The unique id of the associated condition */
|
|
258
|
+
readonly conditionId?: string; /** Extra context information to carry through to the result if one was included on when the evaluation was triggered */
|
|
259
|
+
contextId?: string; /** The unique id for the resource given from Data Condition Evaluator */
|
|
260
|
+
readonly dataConditionEvaluatorId?: string; /** The time the evaluation ended */
|
|
261
|
+
readonly endTime?: string; /** The unique id for the resource */
|
|
262
|
+
readonly id?: string; /** userId of user being impersonated to evaluate the condition */
|
|
263
|
+
readonly ownerId?: string; /** The final result of the evalution */
|
|
264
|
+
readonly result?: "success" | "failure" | "error"; /** Condition type specific result, one of dataResult or compoundResult */
|
|
265
|
+
resultData?: unknown; /** The time the evaluation started */
|
|
266
|
+
readonly startTime?: string; /** The status of the evaluation execution */
|
|
267
|
+
readonly status?: "RUNNING" | "FAILED" | "FINISHED"; /** The tenant id */
|
|
375
268
|
readonly tenantId?: string;
|
|
376
269
|
};
|
|
377
270
|
type EvaluationGetResponse = {
|
|
@@ -390,29 +283,22 @@ type ExecutionStats = {
|
|
|
390
283
|
* an internal recipient based on its group id.
|
|
391
284
|
*/
|
|
392
285
|
type GroupIDRecipient = {
|
|
393
|
-
alertingTaskGroupRecipientErrors?: AlertingTaskGroupRecipientError[];
|
|
394
|
-
/** Whether this recipient can receive alerts. */
|
|
286
|
+
alertingTaskGroupRecipientErrors?: AlertingTaskGroupRecipientError[]; /** Whether this recipient can receive alerts. */
|
|
395
287
|
enabled?: boolean;
|
|
396
|
-
taskGroupRecipientErrors?: TaskGroupRecipientError[];
|
|
397
|
-
/** Group ID of recipient. */
|
|
288
|
+
taskGroupRecipientErrors?: TaskGroupRecipientError[]; /** Group ID of recipient. */
|
|
398
289
|
value?: string;
|
|
399
290
|
};
|
|
400
291
|
type Links = {
|
|
401
|
-
/** Object with Href to a particular element or set of elements */
|
|
402
|
-
self?: Self;
|
|
292
|
+
/** Object with Href to a particular element or set of elements */self?: Self;
|
|
403
293
|
};
|
|
404
294
|
type ListLinks = {
|
|
405
295
|
next?: Page;
|
|
406
|
-
prev?: Page;
|
|
407
|
-
/** Object with Href to a particular element or set of elements */
|
|
296
|
+
prev?: Page; /** Object with Href to a particular element or set of elements */
|
|
408
297
|
self?: Self;
|
|
409
298
|
};
|
|
410
299
|
type Page = {
|
|
411
|
-
/** URL to particular set of elements */
|
|
412
|
-
|
|
413
|
-
/** Page unique token */
|
|
414
|
-
token?: string;
|
|
415
|
-
/** Page type, can be next or prev */
|
|
300
|
+
/** URL to particular set of elements */href?: string; /** Page unique token */
|
|
301
|
+
token?: string; /** Page type, can be next or prev */
|
|
416
302
|
type?: "prev" | "next";
|
|
417
303
|
};
|
|
418
304
|
/**
|
|
@@ -429,25 +315,16 @@ type Recipients = {
|
|
|
429
315
|
* Change in a recipient for an alerting task
|
|
430
316
|
*/
|
|
431
317
|
type RecipientsChange = {
|
|
432
|
-
/** time of recipient state change */
|
|
433
|
-
dateTime?: string;
|
|
434
|
-
/** A custom custom JSON Patch document, as an array of objects with operation, recipient type and value. Original defined in https://datatracker.ietf.org/doc/html/rfc6902. */
|
|
318
|
+
/** time of recipient state change */dateTime?: string; /** A custom custom JSON Patch document, as an array of objects with operation, recipient type and value. Original defined in https://datatracker.ietf.org/doc/html/rfc6902. */
|
|
435
319
|
patchAction?: AlertingTaskRecipientPatch;
|
|
436
320
|
};
|
|
437
321
|
type ScheduleOptions = {
|
|
438
|
-
/** The chronos job identifier. It is set once the related chronos job is created. */
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
/**
|
|
443
|
-
|
|
444
|
-
/** nextExecutionTime is the time of the chronos job next execution in RFC3339 format (a time with a fixed UTC offset). Could be empty if the job is completed. */
|
|
445
|
-
readonly nextExecutionTime?: string;
|
|
446
|
-
/** List of RRULEs for SCHEDULED triggers, as specified in RFC5545. Note that DTSTART and DTEND, UNTIL lines are not allowed in this field; start and end times are specified in the start and end fields. RDATE and EXDATE lines are not currently supported. EXRULE is not supported since it is deprecated by RFC5545. It is mandatory if the trigger type is SCHEDULED. At least 1 rule must be set and maximum 5 rules are allowed. */
|
|
447
|
-
recurrence?: string[];
|
|
448
|
-
/** StartDateTime is a local date time with respect to the above timezone parameter. If the timezone parameter is missing, then the timezone used is the one retrieved from user infos. Therefore ISO8601 time offsets are not allowed (e.g. "2026-01-02T16:04:05Z" or "2026-01-02T16:04:05+01"), if passed an error will be returned. StartDateTime should not be older than 1 year from current date. StartDateTime is an optional parameter, when not set or when it's an empty string, its value is set to the current local date time. */
|
|
449
|
-
startDateTime?: string;
|
|
450
|
-
/** The timezone for time calculations in SCHEDULED triggers, optional. */
|
|
322
|
+
/** The chronos job identifier. It is set once the related chronos job is created. */readonly chronosJobID?: string; /** EndDateTime is a local date time with respect to the above timezone parameter. If the timezone parameter is missing, then the timezone used is the one retrieved from user infos. Therefore ISO8601 time offsets are not allowed (e.g. "2026-01-02T16:04:05Z" or "2026-01-02T16:04:05+01"), if passed an error will be returned. EndDateTime is an optional parameter, when not set or when it's an empty string, the recurrence is intended to be never ending. */
|
|
323
|
+
endDateTime?: string; /** lastExecutionTime is the time of the chronos job last execution in RFC3339 format (a time with a fixed UTC offset). Could be empty if job has not run yet. */
|
|
324
|
+
readonly lastExecutionTime?: string; /** nextExecutionTime is the time of the chronos job next execution in RFC3339 format (a time with a fixed UTC offset). Could be empty if the job is completed. */
|
|
325
|
+
readonly nextExecutionTime?: string; /** List of RRULEs for SCHEDULED triggers, as specified in RFC5545. Note that DTSTART and DTEND, UNTIL lines are not allowed in this field; start and end times are specified in the start and end fields. RDATE and EXDATE lines are not currently supported. EXRULE is not supported since it is deprecated by RFC5545. It is mandatory if the trigger type is SCHEDULED. At least 1 rule must be set and maximum 5 rules are allowed. */
|
|
326
|
+
recurrence?: string[]; /** StartDateTime is a local date time with respect to the above timezone parameter. If the timezone parameter is missing, then the timezone used is the one retrieved from user infos. Therefore ISO8601 time offsets are not allowed (e.g. "2026-01-02T16:04:05Z" or "2026-01-02T16:04:05+01"), if passed an error will be returned. StartDateTime should not be older than 1 year from current date. StartDateTime is an optional parameter, when not set or when it's an empty string, its value is set to the current local date time. */
|
|
327
|
+
startDateTime?: string; /** The timezone for time calculations in SCHEDULED triggers, optional. */
|
|
451
328
|
timezone?: string;
|
|
452
329
|
};
|
|
453
330
|
/**
|
|
@@ -460,53 +337,37 @@ type Self = {
|
|
|
460
337
|
* properties that should be added to every list response
|
|
461
338
|
*/
|
|
462
339
|
type StandardListResponseProps = {
|
|
463
|
-
/** count of entries on the currently shown page */
|
|
464
|
-
currentPageCount: number;
|
|
465
|
-
/** total count of entries in the collection as a whole */
|
|
340
|
+
/** count of entries on the currently shown page */currentPageCount: number; /** total count of entries in the collection as a whole */
|
|
466
341
|
totalCount: number;
|
|
467
342
|
};
|
|
468
343
|
type TaskGroupRecipientError = {
|
|
469
|
-
/** Timestamp for the creation of the error */
|
|
470
|
-
timestamp?: string;
|
|
471
|
-
/** Identifier for type of error occurring on sharing task specific for group recipient */
|
|
344
|
+
/** Timestamp for the creation of the error */timestamp?: string; /** Identifier for type of error occurring on sharing task specific for group recipient */
|
|
472
345
|
value?: "GROUP_IS_DISABLED" | "MAX_ALERTS_LIMIT_REACHED" | "GROUP_WITH_NO_APP_ACCESS" | "GROUP_IS_DELETED" | "GROUP_NOT_FOUND_DL" | "GROUP_DISABLED_IN_DL";
|
|
473
346
|
};
|
|
474
347
|
type TaskRecipientError = {
|
|
475
|
-
/** Timestamp for the creation of the error */
|
|
476
|
-
timestamp?: string;
|
|
477
|
-
/** Identifier for type of error occurring on sharing task specific for recipient */
|
|
348
|
+
/** Timestamp for the creation of the error */timestamp?: string; /** Identifier for type of error occurring on sharing task specific for recipient */
|
|
478
349
|
value?: "USER_IS_DELETED" | "USER_DISABLED_IN_QCS" | "NO_ACCESS_TO_APP" | "UNSUBSCRIBED_FROM_SHARING" | "USER_DISABLED_IN_SHARING_BY_OWNER" | "CHART_NOT_FOUND" | "APP_NOT_FOUND" | "SHEET_NOT_FOUND" | "ENGINE_POD_NOT_AVAILABLE" | "CHART_TYPE_NOT_ALLOWED" | "GENERIC_EXECUTION_FAILURE" | "USER_NOT_FOUND_DL" | "USER_DISABLED_IN_DL" | "FILTER_NOT_FOUND" | "BOOKMARK_NOT_FOUND";
|
|
479
350
|
};
|
|
480
351
|
/**
|
|
481
352
|
* The rules and setup for throttling
|
|
482
353
|
*/
|
|
483
354
|
type ThrottlingResource = {
|
|
484
|
-
/** the maximum number of tokens that the bucket can contain */
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
/**
|
|
489
|
-
recurrenceRule?: string;
|
|
490
|
-
/** a date and time reference specified in RFC3339 format */
|
|
491
|
-
referenceTimestamp?: string;
|
|
492
|
-
/** the amount of tokens to insert into the bucket on the specified interval. (tokens exceeding capacity are discarded) */
|
|
493
|
-
replenishRate?: number;
|
|
494
|
-
/** the timezone for time calculations in this throttlingresource, for current time and time reference. */
|
|
355
|
+
/** the maximum number of tokens that the bucket can contain */capacity?: number; /** the initial amount of tokens in the bucket upon creation. cannot exceed capacity. */
|
|
356
|
+
initialTokenCount?: number; /** A string that supports a subset of RFC5545 recurrence rule directives. */
|
|
357
|
+
recurrenceRule?: string; /** a date and time reference specified in RFC3339 format */
|
|
358
|
+
referenceTimestamp?: string; /** the amount of tokens to insert into the bucket on the specified interval. (tokens exceeding capacity are discarded) */
|
|
359
|
+
replenishRate?: number; /** the timezone for time calculations in this throttlingresource, for current time and time reference. */
|
|
495
360
|
timezone?: string;
|
|
496
361
|
};
|
|
497
362
|
/**
|
|
498
363
|
* an internal recipient based on its user id.
|
|
499
364
|
*/
|
|
500
365
|
type UserIDRecipient = {
|
|
501
|
-
alertingTaskRecipientErrors?: AlertingTaskRecipientError[];
|
|
502
|
-
/**
|
|
503
|
-
|
|
504
|
-
/** A list of associated groups. If a user is added individually the "addedIndividually" pseudo group is included */
|
|
505
|
-
groups?: string[];
|
|
506
|
-
/** Whether this recipient is subscribed to alerts of a task */
|
|
366
|
+
alertingTaskRecipientErrors?: AlertingTaskRecipientError[]; /** Whether this recipient can receive alerts. */
|
|
367
|
+
enabled?: boolean; /** A list of associated groups. If a user is added individually the "addedIndividually" pseudo group is included */
|
|
368
|
+
groups?: string[]; /** Whether this recipient is subscribed to alerts of a task */
|
|
507
369
|
subscribed?: boolean;
|
|
508
|
-
taskRecipientErrors?: TaskRecipientError[];
|
|
509
|
-
/** User ID of recipient (internal user). */
|
|
370
|
+
taskRecipientErrors?: TaskRecipientError[]; /** User ID of recipient (internal user). */
|
|
510
371
|
value?: string;
|
|
511
372
|
};
|
|
512
373
|
/**
|
|
@@ -516,27 +377,16 @@ type UserIDRecipient = {
|
|
|
516
377
|
* @throws GetDataAlertsHttpError
|
|
517
378
|
*/
|
|
518
379
|
declare function getDataAlerts(query: {
|
|
519
|
-
/** The app ID you would like to filter by */
|
|
520
|
-
|
|
521
|
-
/** The
|
|
522
|
-
|
|
523
|
-
/**
|
|
524
|
-
|
|
525
|
-
/** The cursor to the
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
/** The id of the owner you would like to filter by */
|
|
530
|
-
ownerId?: string;
|
|
531
|
-
/** The name of the owner you would like to filter by */
|
|
532
|
-
ownerName?: string;
|
|
533
|
-
/** The cursor to the previous page of data. Only one of next or previous may be specified. */
|
|
534
|
-
prev?: string;
|
|
535
|
-
/** The role you would like to filter by */
|
|
536
|
-
role?: ("owner" | "recipient" | "notowner")[];
|
|
537
|
-
/** Sort the returned result set by the specified field */
|
|
538
|
-
sort?: ("-datecreated" | "datecreated" | "+datecreated" | "-ownername" | "ownername" | "+ownername" | "lasttrigger" | "-lasttrigger" | "+lasttrigger" | "lastscan" | "-lastscan" | "+lastscan" | "name" | "-name" | "+name" | "enabled" | "-enabled" | "+enabled" | "status" | "-status" | "+status" | "nextexecutiontime" | "-nextexecutiontime" | "+nextexecutiontime")[];
|
|
539
|
-
/** The status you would like to filter by */
|
|
380
|
+
/** The app ID you would like to filter by */appID?: string; /** The conditionId you would like to filter by */
|
|
381
|
+
conditionId?: string; /** Limit the returned result set */
|
|
382
|
+
limit?: number; /** The cursor to the next page of data. Only one of next or previous may be specified. */
|
|
383
|
+
next?: string; /** Offset for finding a list of entities - used for pagination */
|
|
384
|
+
offset?: number; /** The id of the owner you would like to filter by */
|
|
385
|
+
ownerId?: string; /** The name of the owner you would like to filter by */
|
|
386
|
+
ownerName?: string; /** The cursor to the previous page of data. Only one of next or previous may be specified. */
|
|
387
|
+
prev?: string; /** The role you would like to filter by */
|
|
388
|
+
role?: ("owner" | "recipient" | "notowner")[]; /** Sort the returned result set by the specified field */
|
|
389
|
+
sort?: ("-datecreated" | "datecreated" | "+datecreated" | "-ownername" | "ownername" | "+ownername" | "lasttrigger" | "-lasttrigger" | "+lasttrigger" | "lastscan" | "-lastscan" | "+lastscan" | "name" | "-name" | "+name" | "enabled" | "-enabled" | "+enabled" | "status" | "-status" | "+status" | "nextexecutiontime" | "-nextexecutiontime" | "+nextexecutiontime")[]; /** The status you would like to filter by */
|
|
540
390
|
status?: ("INVALID_RECIPIENT" | "INVALID_OWNER" | "DISABLED" | "VALID")[];
|
|
541
391
|
}, options?: ApiCallOptions): Promise<GetDataAlertsHttpResponse>;
|
|
542
392
|
type GetDataAlertsHttpResponse = {
|
|
@@ -748,13 +598,9 @@ type GetDataAlertExecutionHttpError = {
|
|
|
748
598
|
* @throws GetDataAlertRecipientStatsHttpError
|
|
749
599
|
*/
|
|
750
600
|
declare function getDataAlertRecipientStats(alertId: string, query: {
|
|
751
|
-
/** The name of the groups you would like to filter by */
|
|
752
|
-
|
|
753
|
-
/**
|
|
754
|
-
sort?: ("+userID" | "-userID" | "subscribed" | "+subscribed")[];
|
|
755
|
-
/** Subscribed property you would like to filter by */
|
|
756
|
-
subscribed?: boolean;
|
|
757
|
-
/** The recipients ID you would like to filter by */
|
|
601
|
+
/** The name of the groups you would like to filter by */groups?: string[]; /** Sort the returned result set by the specified field */
|
|
602
|
+
sort?: ("+userID" | "-userID" | "subscribed" | "+subscribed")[]; /** Subscribed property you would like to filter by */
|
|
603
|
+
subscribed?: boolean; /** The recipients ID you would like to filter by */
|
|
758
604
|
userID?: string;
|
|
759
605
|
}, options?: ApiCallOptions): Promise<GetDataAlertRecipientStatsHttpResponse>;
|
|
760
606
|
type GetDataAlertRecipientStatsHttpResponse = {
|
|
@@ -775,41 +621,23 @@ type GetDataAlertRecipientStatsHttpError = {
|
|
|
775
621
|
* @throws GetDataAlertExecutionsHttpError
|
|
776
622
|
*/
|
|
777
623
|
declare function getDataAlertExecutions(taskId: string, query: {
|
|
778
|
-
/** Filter by condition id related to the executions. */
|
|
779
|
-
|
|
780
|
-
/**
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
|
|
784
|
-
|
|
785
|
-
|
|
786
|
-
/**
|
|
787
|
-
|
|
788
|
-
/**
|
|
789
|
-
|
|
790
|
-
/** Specifies
|
|
791
|
-
|
|
792
|
-
/**
|
|
793
|
-
|
|
794
|
-
/** Specifies
|
|
795
|
-
minimumGapDays?: number;
|
|
796
|
-
/** The cursor to the next page of data. Only one of next or previous may be specified. */
|
|
797
|
-
next?: string;
|
|
798
|
-
/** Offset for pagination - how many elements to skip */
|
|
799
|
-
offset?: number;
|
|
800
|
-
/** The cursor to the previous page of data. Only one of next or previous may be specified. */
|
|
801
|
-
prev?: string;
|
|
802
|
-
/** Specifies a limit number for the search query, affects total count and is not related to pagination */
|
|
803
|
-
searchResultsLimit?: number;
|
|
804
|
-
/** Specifies a date that executions should have been created after. Date in RFC3339Nano format, such as 2020-01-01T00:00:00.000Z */
|
|
805
|
-
since?: string;
|
|
806
|
-
/** Sort the returned result set by the specified field */
|
|
807
|
-
sort?: ("triggertime" | "-triggertime" | "+triggertime")[];
|
|
808
|
-
/** Specifies a timezone the other time-based filters in this query should consider. Expecting a momentjs format, such as America/Los_Angeles */
|
|
809
|
-
timezone?: string;
|
|
810
|
-
/** Filter by whether the alerting task is triggered. */
|
|
811
|
-
triggered?: boolean;
|
|
812
|
-
/** Specifies a date that executions should have been created before. Date in RFC3339Nano format, such as 2020-01-01T00:00:00.000Z */
|
|
624
|
+
/** Filter by condition id related to the executions. */conditionId?: string; /** Filter by whether the alerting task execution status is FINISHED or FAILED. */
|
|
625
|
+
conditionStatus?: "FINISHED" | "FAILED" | "ALL"; /** Specifies required days of the month that the execution was created in */
|
|
626
|
+
daysOfMonth?: number[]; /** Specifies a filter for custom handled periods of time in which the executions were handled */
|
|
627
|
+
daysOfWeek?: ("MONDAY" | "TUESDAY" | "WEDNESDAY" | "THURSDAY" | "FRIDAY" | "SATURDAY" | "SUNDAY")[]; /** Specifies specific properties to be populated */
|
|
628
|
+
fields?: ("evaluationId" | "triggerTime" | "conditionStatus" | "executionEvaluationStatus" | "evaluation" | "evaluation.endTime" | "evaluation.resultData" | "evaluation.resultData.count" | "evaluation.resultData.headers" | "evaluation.resultData.positive" | "evaluation.resultData.negative" | "evaluation.resultData.dimensions" | "evaluation.resultData.measures")[]; /** Specifies whether to include evaluation details */
|
|
629
|
+
includeEvaluation?: boolean; /** Specifies whether to only show the last execution in each day */
|
|
630
|
+
lastEachDay?: boolean; /** Limit the returned result set */
|
|
631
|
+
limit?: number; /** Specifies the number of days required between each entry. This should require a sort by triggertime */
|
|
632
|
+
minimumGapDays?: number; /** The cursor to the next page of data. Only one of next or previous may be specified. */
|
|
633
|
+
next?: string; /** Offset for pagination - how many elements to skip */
|
|
634
|
+
offset?: number; /** The cursor to the previous page of data. Only one of next or previous may be specified. */
|
|
635
|
+
prev?: string; /** Specifies a limit number for the search query, affects total count and is not related to pagination */
|
|
636
|
+
searchResultsLimit?: number; /** Specifies a date that executions should have been created after. Date in RFC3339Nano format, such as 2020-01-01T00:00:00.000Z */
|
|
637
|
+
since?: string; /** Sort the returned result set by the specified field */
|
|
638
|
+
sort?: ("triggertime" | "-triggertime" | "+triggertime")[]; /** Specifies a timezone the other time-based filters in this query should consider. Expecting a momentjs format, such as America/Los_Angeles */
|
|
639
|
+
timezone?: string; /** Filter by whether the alerting task is triggered. */
|
|
640
|
+
triggered?: boolean; /** Specifies a date that executions should have been created before. Date in RFC3339Nano format, such as 2020-01-01T00:00:00.000Z */
|
|
813
641
|
until?: string;
|
|
814
642
|
}, options?: ApiCallOptions): Promise<GetDataAlertExecutionsHttpResponse>;
|
|
815
643
|
type GetDataAlertExecutionsHttpResponse = {
|
|
@@ -834,8 +662,7 @@ type GetDataAlertExecutionsHttpError = {
|
|
|
834
662
|
* @throws GetDataAlertExecutionsStatsHttpError
|
|
835
663
|
*/
|
|
836
664
|
declare function getDataAlertExecutionsStats(taskId: string, query: {
|
|
837
|
-
/** The period by which the stats aggregation needs to be performed. */
|
|
838
|
-
period: "month";
|
|
665
|
+
/** The period by which the stats aggregation needs to be performed. */period: "month";
|
|
839
666
|
}, options?: ApiCallOptions): Promise<GetDataAlertExecutionsStatsHttpResponse>;
|
|
840
667
|
type GetDataAlertExecutionsStatsHttpResponse = {
|
|
841
668
|
data: AlertingTaskExecutionStats;
|