@gooddata/api-client-tiger 11.50.0-alpha.3 → 11.50.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/esm/__version.d.ts +1 -1
- package/esm/__version.d.ts.map +1 -1
- package/esm/__version.js +1 -1
- package/esm/api-client-tiger.d.ts +8005 -4512
- package/esm/generated/afm-rest-api/api.d.ts +731 -673
- package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
- package/esm/generated/ai-json-api/api.d.ts +432 -380
- package/esm/generated/ai-json-api/api.d.ts.map +1 -1
- package/esm/generated/ai-json-api/api.js +29 -24
- package/esm/generated/auth-json-api/api.d.ts +22 -22
- package/esm/generated/auth-json-api/api.d.ts.map +1 -1
- package/esm/generated/automation-json-api/api.d.ts +339 -300
- package/esm/generated/automation-json-api/api.d.ts.map +1 -1
- package/esm/generated/export-json-api/api.d.ts +266 -207
- package/esm/generated/export-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.d.ts +6107 -2913
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js +570 -68
- package/esm/generated/result-json-api/api.d.ts +87 -87
- package/esm/generated/result-json-api/api.d.ts.map +1 -1
- package/esm/generated/scan-json-api/api.d.ts +109 -109
- package/esm/generated/scan-json-api/api.d.ts.map +1 -1
- package/esm/index.d.ts +4 -4
- package/esm/index.d.ts.map +1 -1
- package/package.json +4 -4
|
@@ -20,26 +20,26 @@ export interface AutomationAFM {
|
|
|
20
20
|
* Attributes to be used in the computation.
|
|
21
21
|
*/
|
|
22
22
|
'attributes': Array<AutomationAttributeItem>;
|
|
23
|
+
/**
|
|
24
|
+
* Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.
|
|
25
|
+
*/
|
|
26
|
+
'auxMeasures'?: Array<AutomationMeasureItem>;
|
|
23
27
|
/**
|
|
24
28
|
* Various filter types to filter the execution result.
|
|
25
29
|
*/
|
|
26
30
|
'filters': Array<AutomationAFMFiltersInner>;
|
|
27
31
|
/**
|
|
28
|
-
*
|
|
32
|
+
* (EXPERIMENTAL) Override definitions of catalog metrics for this request. Allows substituting a catalog metric\'s MAQL definition without modifying the stored definition.
|
|
29
33
|
*/
|
|
30
|
-
'
|
|
34
|
+
'measureDefinitionOverrides'?: Array<AutomationMetricDefinitionOverride>;
|
|
31
35
|
/**
|
|
32
|
-
* Metrics to be
|
|
36
|
+
* Metrics to be computed.
|
|
33
37
|
*/
|
|
34
|
-
'
|
|
38
|
+
'measures': Array<AutomationMeasureItem>;
|
|
35
39
|
/**
|
|
36
40
|
* (EXPERIMENTAL) Parameter values to use for this execution.
|
|
37
41
|
*/
|
|
38
42
|
'parameters'?: Array<AutomationParameterItem>;
|
|
39
|
-
/**
|
|
40
|
-
* (EXPERIMENTAL) Override definitions of catalog metrics for this request. Allows substituting a catalog metric\'s MAQL definition without modifying the stored definition.
|
|
41
|
-
*/
|
|
42
|
-
'measureDefinitionOverrides'?: Array<AutomationMetricDefinitionOverride>;
|
|
43
43
|
}
|
|
44
44
|
/**
|
|
45
45
|
* @type AutomationAFMFiltersInner
|
|
@@ -52,49 +52,78 @@ export interface AutomationAbsoluteDateFilter {
|
|
|
52
52
|
'absoluteDateFilter': AutomationAbsoluteDateFilterAbsoluteDateFilter;
|
|
53
53
|
}
|
|
54
54
|
export interface AutomationAbsoluteDateFilterAbsoluteDateFilter {
|
|
55
|
-
'from': string;
|
|
56
|
-
'to': string;
|
|
57
|
-
'localIdentifier'?: string;
|
|
58
55
|
'applyOnResult'?: boolean;
|
|
56
|
+
'dataset': AutomationAfmObjectIdentifierDataset;
|
|
59
57
|
/**
|
|
60
58
|
* Specifies how rows with empty (null/missing) date values should be handled. INCLUDE includes empty dates in addition to the date range restriction, EXCLUDE removes rows with empty dates (default), ONLY keeps only rows with empty dates.
|
|
61
59
|
*/
|
|
62
60
|
'emptyValueHandling'?: AutomationAbsoluteDateFilterAbsoluteDateFilterEmptyValueHandlingEnum;
|
|
63
|
-
'
|
|
61
|
+
'from': string;
|
|
62
|
+
'localIdentifier'?: string;
|
|
63
|
+
'to': string;
|
|
64
64
|
}
|
|
65
65
|
export type AutomationAbsoluteDateFilterAbsoluteDateFilterEmptyValueHandlingEnum = 'INCLUDE' | 'EXCLUDE' | 'ONLY';
|
|
66
|
+
/**
|
|
67
|
+
* An absolute date range filter defined at a specific granularity. The \'from\'/\'to\' literals must match the format of the chosen granularity (e.g. \'2020\' for YEAR, \'2012-05\' for MONTH, \'2012-3\' for QUARTER, \'1996-01\' for WEEK, \'2010-10-30\' for DAY, or a plain ordinal like \'6\' for periodical granularities such as MONTH_OF_YEAR). At least one of \'from\'/\'to\' must be provided; specifying only one yields an open-ended range.
|
|
68
|
+
*/
|
|
69
|
+
export interface AutomationAbsoluteGranularityDateFilter {
|
|
70
|
+
'absoluteGranularityDateFilter': AutomationAbsoluteGranularityDateFilterAbsoluteGranularityDateFilter;
|
|
71
|
+
}
|
|
72
|
+
export interface AutomationAbsoluteGranularityDateFilterAbsoluteGranularityDateFilter {
|
|
73
|
+
'applyOnResult'?: boolean;
|
|
74
|
+
'dataset': AutomationAfmObjectIdentifierDataset;
|
|
75
|
+
/**
|
|
76
|
+
* Specifies how rows with empty (null/missing) date values should be handled. INCLUDE includes empty dates in addition to the date range restriction, EXCLUDE removes rows with empty dates (default), ONLY keeps only rows with empty dates.
|
|
77
|
+
*/
|
|
78
|
+
'emptyValueHandling'?: AutomationAbsoluteGranularityDateFilterAbsoluteGranularityDateFilterEmptyValueHandlingEnum;
|
|
79
|
+
/**
|
|
80
|
+
* Start of the range (including), in the format matching \'granularity\'. If omitted, the range is unbounded at the start.
|
|
81
|
+
*/
|
|
82
|
+
'from'?: string | null;
|
|
83
|
+
/**
|
|
84
|
+
* Granularity determining the filtered date attribute and the expected \'from\'/\'to\' format.
|
|
85
|
+
*/
|
|
86
|
+
'granularity': AutomationAbsoluteGranularityDateFilterAbsoluteGranularityDateFilterGranularityEnum;
|
|
87
|
+
'localIdentifier'?: string;
|
|
88
|
+
/**
|
|
89
|
+
* End of the range (including), in the format matching \'granularity\'. If omitted, the range is unbounded at the end.
|
|
90
|
+
*/
|
|
91
|
+
'to'?: string | null;
|
|
92
|
+
}
|
|
93
|
+
export type AutomationAbsoluteGranularityDateFilterAbsoluteGranularityDateFilterEmptyValueHandlingEnum = 'INCLUDE' | 'EXCLUDE' | 'ONLY';
|
|
94
|
+
export type AutomationAbsoluteGranularityDateFilterAbsoluteGranularityDateFilterGranularityEnum = 'SECOND' | 'SECOND_OF_MINUTE' | 'SECOND_OF_DAY' | 'MINUTE' | 'MINUTE_OF_HOUR' | 'MINUTE_OF_DAY' | 'HOUR' | 'HOUR_OF_DAY' | 'DAY' | 'DAY_OF_WEEK' | 'DAY_OF_MONTH' | 'DAY_OF_QUARTER' | 'DAY_OF_YEAR' | 'WEEK' | 'WEEK_OF_YEAR' | 'MONTH' | 'MONTH_OF_YEAR' | 'QUARTER' | 'QUARTER_OF_YEAR' | 'YEAR' | 'FISCAL_DAY_OF_FISCAL_WEEK' | 'FISCAL_DAY_OF_FISCAL_MONTH' | 'FISCAL_DAY_OF_FISCAL_QUARTER' | 'FISCAL_DAY_OF_FISCAL_SEMESTER' | 'FISCAL_DAY_OF_FISCAL_YEAR' | 'FISCAL_WEEK' | 'FISCAL_WEEK_OF_FISCAL_MONTH' | 'FISCAL_WEEK_OF_FISCAL_QUARTER' | 'FISCAL_WEEK_OF_FISCAL_SEMESTER' | 'FISCAL_WEEK_OF_FISCAL_YEAR' | 'FISCAL_MONTH' | 'FISCAL_MONTH_OF_FISCAL_QUARTER' | 'FISCAL_MONTH_OF_FISCAL_SEMESTER' | 'FISCAL_MONTH_OF_FISCAL_YEAR' | 'FISCAL_QUARTER' | 'FISCAL_QUARTER_OF_FISCAL_SEMESTER' | 'FISCAL_QUARTER_OF_FISCAL_YEAR' | 'FISCAL_SEMESTER' | 'FISCAL_SEMESTER_OF_FISCAL_YEAR' | 'FISCAL_YEAR';
|
|
66
95
|
/**
|
|
67
96
|
* @type AutomationAbstractMeasureValueFilter
|
|
68
97
|
*/
|
|
69
98
|
export type AutomationAbstractMeasureValueFilter = AutomationComparisonMeasureValueFilter | AutomationCompoundMeasureValueFilter | AutomationRangeMeasureValueFilter | AutomationRankingFilter;
|
|
70
99
|
export interface AutomationAdHocAutomation {
|
|
71
|
-
'
|
|
100
|
+
'alert'?: AutomationAutomationAlert;
|
|
101
|
+
'analyticalDashboard'?: AutomationDeclarativeAnalyticalDashboardIdentifier;
|
|
102
|
+
'dashboardTabularExports'?: Array<AutomationAutomationDashboardTabularExport>;
|
|
72
103
|
'description'?: string;
|
|
73
|
-
/**
|
|
74
|
-
* A list of tags.
|
|
75
|
-
*/
|
|
76
|
-
'tags'?: Array<string>;
|
|
77
104
|
/**
|
|
78
105
|
* Additional details to be included in the automated message.
|
|
79
106
|
*/
|
|
80
107
|
'details'?: {
|
|
81
108
|
[key: string]: string;
|
|
82
109
|
};
|
|
83
|
-
'metadata'?: AutomationAutomationMetadata | null;
|
|
84
|
-
'alert'?: AutomationAutomationAlert;
|
|
85
|
-
'tabularExports'?: Array<AutomationAutomationTabularExport>;
|
|
86
|
-
'visualExports'?: Array<AutomationAutomationVisualExport>;
|
|
87
|
-
'imageExports'?: Array<AutomationAutomationImageExport>;
|
|
88
|
-
'rawExports'?: Array<AutomationAutomationRawExport>;
|
|
89
|
-
'slidesExports'?: Array<AutomationAutomationSlidesExport>;
|
|
90
|
-
'dashboardTabularExports'?: Array<AutomationAutomationDashboardTabularExport>;
|
|
91
110
|
/**
|
|
92
111
|
* External recipients of the automation action results.
|
|
93
112
|
*/
|
|
94
113
|
'externalRecipients'?: Array<AutomationAutomationExternalRecipient>;
|
|
114
|
+
'imageExports'?: Array<AutomationAutomationImageExport>;
|
|
115
|
+
'metadata'?: AutomationAutomationMetadata | null;
|
|
95
116
|
'notificationChannel'?: AutomationDeclarativeNotificationChannelIdentifier;
|
|
117
|
+
'rawExports'?: Array<AutomationAutomationRawExport>;
|
|
96
118
|
'recipients'?: Array<AutomationDeclarativeUserIdentifier>;
|
|
97
|
-
'
|
|
119
|
+
'slidesExports'?: Array<AutomationAutomationSlidesExport>;
|
|
120
|
+
'tabularExports'?: Array<AutomationAutomationTabularExport>;
|
|
121
|
+
/**
|
|
122
|
+
* A list of tags.
|
|
123
|
+
*/
|
|
124
|
+
'tags'?: Array<string>;
|
|
125
|
+
'title'?: string;
|
|
126
|
+
'visualExports'?: Array<AutomationAutomationVisualExport>;
|
|
98
127
|
}
|
|
99
128
|
/**
|
|
100
129
|
* @type AutomationAfmIdentifier
|
|
@@ -144,16 +173,16 @@ export interface AutomationAfmObjectIdentifierDatasetIdentifier {
|
|
|
144
173
|
}
|
|
145
174
|
export type AutomationAfmObjectIdentifierDatasetIdentifierTypeEnum = 'dataset';
|
|
146
175
|
export interface AutomationAfmObjectIdentifierIdentifier {
|
|
147
|
-
'type': AutomationAfmObjectIdentifierIdentifierTypeEnum;
|
|
148
176
|
'id': string;
|
|
177
|
+
'type': AutomationAfmObjectIdentifierIdentifierTypeEnum;
|
|
149
178
|
}
|
|
150
179
|
export type AutomationAfmObjectIdentifierIdentifierTypeEnum = 'analyticalDashboard' | 'attribute' | 'dashboardPlugin' | 'dataset' | 'fact' | 'label' | 'metric' | 'prompt' | 'visualizationObject' | 'filterContext';
|
|
151
180
|
export interface AutomationAfmObjectIdentifierLabel {
|
|
152
181
|
'identifier': AutomationAfmObjectIdentifierLabelIdentifier;
|
|
153
182
|
}
|
|
154
183
|
export interface AutomationAfmObjectIdentifierLabelIdentifier {
|
|
155
|
-
'type': AutomationAfmObjectIdentifierLabelIdentifierTypeEnum;
|
|
156
184
|
'id': string;
|
|
185
|
+
'type': AutomationAfmObjectIdentifierLabelIdentifierTypeEnum;
|
|
157
186
|
}
|
|
158
187
|
export type AutomationAfmObjectIdentifierLabelIdentifierTypeEnum = 'label';
|
|
159
188
|
/**
|
|
@@ -172,6 +201,10 @@ export interface AutomationAlertAfm {
|
|
|
172
201
|
* Attributes to be used in the computation.
|
|
173
202
|
*/
|
|
174
203
|
'attributes'?: Array<AutomationAttributeItem>;
|
|
204
|
+
/**
|
|
205
|
+
* Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.
|
|
206
|
+
*/
|
|
207
|
+
'auxMeasures'?: Array<AutomationMeasureItem>;
|
|
175
208
|
/**
|
|
176
209
|
* Various filter types to filter execution result. For anomaly detection, exactly one dataset is specified in the condition. The AFM may contain multiple date filters for different datasets, but only the date filter matching the dataset from the condition is used for anomaly detection.
|
|
177
210
|
*/
|
|
@@ -180,10 +213,6 @@ export interface AutomationAlertAfm {
|
|
|
180
213
|
* Metrics to be computed. One metric if the alert condition is evaluated to a scalar. Two metrics when they should be evaluated to each other.
|
|
181
214
|
*/
|
|
182
215
|
'measures': Array<AutomationMeasureItem>;
|
|
183
|
-
/**
|
|
184
|
-
* Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.
|
|
185
|
-
*/
|
|
186
|
-
'auxMeasures'?: Array<AutomationMeasureItem>;
|
|
187
216
|
/**
|
|
188
217
|
* Parameters to be used in the computation.
|
|
189
218
|
*/
|
|
@@ -200,28 +229,28 @@ export type AutomationAlertCondition = AutomationAnomalyDetectionWrapper | Autom
|
|
|
200
229
|
*/
|
|
201
230
|
export type AutomationAlertConditionOperand = AutomationLocalIdentifier | AutomationValue;
|
|
202
231
|
export interface AutomationAlertDescription {
|
|
203
|
-
'
|
|
232
|
+
'attribute'?: string;
|
|
204
233
|
'condition': string;
|
|
205
234
|
'currentValues'?: Array<AutomationAlertEvaluationRow>;
|
|
206
|
-
'
|
|
207
|
-
'totalValueCount'?: number;
|
|
208
|
-
'triggeredCount'?: number;
|
|
209
|
-
'triggeredAt'?: string;
|
|
210
|
-
'threshold'?: number;
|
|
235
|
+
'errorMessage'?: string;
|
|
211
236
|
'formattedThreshold'?: string;
|
|
212
237
|
'lowerThreshold'?: number;
|
|
213
|
-
'
|
|
238
|
+
'metric': string;
|
|
214
239
|
'remainingAlertEvaluationCount'?: number;
|
|
215
240
|
'status'?: AutomationAlertDescriptionStatusEnum;
|
|
216
|
-
'
|
|
241
|
+
'threshold'?: number;
|
|
242
|
+
'totalValueCount'?: number;
|
|
217
243
|
'traceId'?: string;
|
|
244
|
+
'triggeredAt'?: string;
|
|
245
|
+
'triggeredCount'?: number;
|
|
246
|
+
'upperThreshold'?: number;
|
|
218
247
|
}
|
|
219
248
|
export type AutomationAlertDescriptionStatusEnum = 'SUCCESS' | 'ERROR' | 'INTERNAL_ERROR' | 'TIMEOUT';
|
|
220
249
|
export interface AutomationAlertEvaluationRow {
|
|
221
|
-
'primaryMetric'?: AutomationMetricRecord;
|
|
222
|
-
'secondaryMetric'?: AutomationMetricRecord;
|
|
223
250
|
'computedMetric'?: AutomationMetricRecord;
|
|
224
251
|
'labelValue'?: string;
|
|
252
|
+
'primaryMetric'?: AutomationMetricRecord;
|
|
253
|
+
'secondaryMetric'?: AutomationMetricRecord;
|
|
225
254
|
}
|
|
226
255
|
/**
|
|
227
256
|
* An all-time date filter that does not restrict by date range. Controls how rows with empty (null/missing) date values are handled.
|
|
@@ -230,6 +259,8 @@ export interface AutomationAllTimeDateFilter {
|
|
|
230
259
|
'allTimeDateFilter': AutomationAllTimeDateFilterAllTimeDateFilter;
|
|
231
260
|
}
|
|
232
261
|
export interface AutomationAllTimeDateFilterAllTimeDateFilter {
|
|
262
|
+
'applyOnResult'?: boolean;
|
|
263
|
+
'dataset': AutomationAfmObjectIdentifierDataset;
|
|
233
264
|
/**
|
|
234
265
|
* Specifies how rows with empty (null/missing) date values should be handled. INCLUDE means no filtering effect (default), EXCLUDE removes rows with null dates, ONLY keeps only rows with null dates.
|
|
235
266
|
*/
|
|
@@ -239,34 +270,32 @@ export interface AutomationAllTimeDateFilterAllTimeDateFilter {
|
|
|
239
270
|
*/
|
|
240
271
|
'granularity'?: AutomationAllTimeDateFilterAllTimeDateFilterGranularityEnum;
|
|
241
272
|
'localIdentifier'?: string;
|
|
242
|
-
'applyOnResult'?: boolean;
|
|
243
|
-
'dataset': AutomationAfmObjectIdentifierDataset;
|
|
244
273
|
}
|
|
245
274
|
export type AutomationAllTimeDateFilterAllTimeDateFilterEmptyValueHandlingEnum = 'INCLUDE' | 'EXCLUDE' | 'ONLY';
|
|
246
|
-
export type AutomationAllTimeDateFilterAllTimeDateFilterGranularityEnum = '
|
|
275
|
+
export type AutomationAllTimeDateFilterAllTimeDateFilterGranularityEnum = 'SECOND' | 'SECOND_OF_MINUTE' | 'SECOND_OF_DAY' | 'MINUTE' | 'MINUTE_OF_HOUR' | 'MINUTE_OF_DAY' | 'HOUR' | 'HOUR_OF_DAY' | 'DAY' | 'DAY_OF_WEEK' | 'DAY_OF_MONTH' | 'DAY_OF_QUARTER' | 'DAY_OF_YEAR' | 'WEEK' | 'WEEK_OF_YEAR' | 'MONTH' | 'MONTH_OF_YEAR' | 'QUARTER' | 'QUARTER_OF_YEAR' | 'YEAR' | 'FISCAL_DAY_OF_FISCAL_WEEK' | 'FISCAL_DAY_OF_FISCAL_MONTH' | 'FISCAL_DAY_OF_FISCAL_QUARTER' | 'FISCAL_DAY_OF_FISCAL_SEMESTER' | 'FISCAL_DAY_OF_FISCAL_YEAR' | 'FISCAL_WEEK' | 'FISCAL_WEEK_OF_FISCAL_MONTH' | 'FISCAL_WEEK_OF_FISCAL_QUARTER' | 'FISCAL_WEEK_OF_FISCAL_SEMESTER' | 'FISCAL_WEEK_OF_FISCAL_YEAR' | 'FISCAL_MONTH' | 'FISCAL_MONTH_OF_FISCAL_QUARTER' | 'FISCAL_MONTH_OF_FISCAL_SEMESTER' | 'FISCAL_MONTH_OF_FISCAL_YEAR' | 'FISCAL_QUARTER' | 'FISCAL_QUARTER_OF_FISCAL_SEMESTER' | 'FISCAL_QUARTER_OF_FISCAL_YEAR' | 'FISCAL_SEMESTER' | 'FISCAL_SEMESTER_OF_FISCAL_YEAR' | 'FISCAL_YEAR';
|
|
247
276
|
export interface AutomationAnomalyDetection {
|
|
277
|
+
'dataset': AutomationAfmObjectIdentifierDataset;
|
|
278
|
+
/**
|
|
279
|
+
* Date granularity for anomaly detection. Only time-based granularities are supported (HOUR, DAY, WEEK, MONTH, QUARTER, YEAR).
|
|
280
|
+
*/
|
|
281
|
+
'granularity': AutomationAnomalyDetectionGranularityEnum;
|
|
248
282
|
'measure': AutomationLocalIdentifier;
|
|
249
283
|
/**
|
|
250
284
|
* Sensitivity level for anomaly detection
|
|
251
285
|
*/
|
|
252
286
|
'sensitivity': AutomationAnomalyDetectionSensitivityEnum;
|
|
253
|
-
/**
|
|
254
|
-
* Date granularity for anomaly detection. Only time-based granularities are supported (HOUR, DAY, WEEK, MONTH, QUARTER, YEAR).
|
|
255
|
-
*/
|
|
256
|
-
'granularity': AutomationAnomalyDetectionGranularityEnum;
|
|
257
|
-
'dataset': AutomationAfmObjectIdentifierDataset;
|
|
258
287
|
}
|
|
259
|
-
export type AutomationAnomalyDetectionSensitivityEnum = 'LOW' | 'MEDIUM' | 'HIGH';
|
|
260
288
|
export type AutomationAnomalyDetectionGranularityEnum = 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR';
|
|
289
|
+
export type AutomationAnomalyDetectionSensitivityEnum = 'LOW' | 'MEDIUM' | 'HIGH';
|
|
261
290
|
export interface AutomationAnomalyDetectionWrapper {
|
|
262
291
|
'anomaly': AutomationAnomalyDetection;
|
|
263
292
|
}
|
|
264
293
|
export interface AutomationArithmeticMeasure {
|
|
294
|
+
'left': AutomationLocalIdentifier;
|
|
265
295
|
/**
|
|
266
296
|
* Arithmetic operator. DIFFERENCE - m₁−m₂ - the difference between two metrics. CHANGE - (m₁−m₂)÷m₂ - the relative difference between two metrics.
|
|
267
297
|
*/
|
|
268
298
|
'operator': AutomationArithmeticMeasureOperatorEnum;
|
|
269
|
-
'left': AutomationLocalIdentifier;
|
|
270
299
|
'right': AutomationLocalIdentifier;
|
|
271
300
|
}
|
|
272
301
|
export type AutomationArithmeticMeasureOperatorEnum = 'DIFFERENCE' | 'CHANGE';
|
|
@@ -326,30 +355,30 @@ export interface AutomationAttributeFilterParent {
|
|
|
326
355
|
'over': AutomationOver;
|
|
327
356
|
}
|
|
328
357
|
export interface AutomationAttributeItem {
|
|
358
|
+
'label': AutomationAfmObjectIdentifierLabel;
|
|
329
359
|
/**
|
|
330
360
|
* Local identifier of the attribute. This can be used to reference the attribute in other parts of the execution definition.
|
|
331
361
|
*/
|
|
332
362
|
'localIdentifier': string;
|
|
333
|
-
'label': AutomationAfmObjectIdentifierLabel;
|
|
334
363
|
/**
|
|
335
364
|
* Indicates whether to show all values of given attribute even if the data bound to those values is not available.
|
|
336
365
|
*/
|
|
337
366
|
'showAllValues'?: boolean;
|
|
338
367
|
}
|
|
339
368
|
export interface AutomationAutomationAlert {
|
|
340
|
-
'execution': AutomationAlertAfm;
|
|
341
369
|
'condition': AutomationAutomationAlertCondition;
|
|
342
|
-
|
|
343
|
-
* Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met. ONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS.
|
|
344
|
-
*/
|
|
345
|
-
'trigger'?: AutomationAutomationAlertTriggerEnum;
|
|
370
|
+
'execution': AutomationAlertAfm;
|
|
346
371
|
/**
|
|
347
372
|
* Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR.
|
|
348
373
|
*/
|
|
349
374
|
'interval'?: AutomationAutomationAlertIntervalEnum;
|
|
375
|
+
/**
|
|
376
|
+
* Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met. ONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS.
|
|
377
|
+
*/
|
|
378
|
+
'trigger'?: AutomationAutomationAlertTriggerEnum;
|
|
350
379
|
}
|
|
351
|
-
export type AutomationAutomationAlertTriggerEnum = 'ALWAYS' | 'ONCE' | 'ONCE_PER_INTERVAL';
|
|
352
380
|
export type AutomationAutomationAlertIntervalEnum = 'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR';
|
|
381
|
+
export type AutomationAutomationAlertTriggerEnum = 'ALWAYS' | 'ONCE' | 'ONCE_PER_INTERVAL';
|
|
353
382
|
/**
|
|
354
383
|
* @type AutomationAutomationAlertCondition
|
|
355
384
|
*/
|
|
@@ -371,8 +400,8 @@ export interface AutomationAutomationImageExport {
|
|
|
371
400
|
*/
|
|
372
401
|
export interface AutomationAutomationMetadata {
|
|
373
402
|
[key: string]: any;
|
|
374
|
-
'widget'?: string;
|
|
375
403
|
'visibleFilters'?: Array<AutomationVisibleFilter>;
|
|
404
|
+
'widget'?: string;
|
|
376
405
|
}
|
|
377
406
|
export interface AutomationAutomationNotification extends AutomationNotificationContent {
|
|
378
407
|
'content': AutomationWebhookMessage;
|
|
@@ -393,23 +422,23 @@ export interface AutomationAutomationVisualExport {
|
|
|
393
422
|
* Bounding filter for this relative date filter. This can be used to limit the range of the relative date filter to a specific date range.
|
|
394
423
|
*/
|
|
395
424
|
export interface AutomationBoundedFilter {
|
|
396
|
-
/**
|
|
397
|
-
* Date granularity specifying particular date attribute in given dimension.
|
|
398
|
-
*/
|
|
399
|
-
'granularity': AutomationBoundedFilterGranularityEnum;
|
|
400
425
|
/**
|
|
401
426
|
* Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for \'2 days/weeks, ... ago\'). If null, then start of the range is unbounded.
|
|
402
427
|
*/
|
|
403
428
|
'from'?: number | null;
|
|
429
|
+
/**
|
|
430
|
+
* Date granularity specifying particular date attribute in given dimension.
|
|
431
|
+
*/
|
|
432
|
+
'granularity': AutomationBoundedFilterGranularityEnum;
|
|
404
433
|
/**
|
|
405
434
|
* End of the filtering interval. Specified by number of periods (with respect to given granularity). Value \'O\' is representing current time-interval (current day, week, ...). If null, then end of the range is unbounded.
|
|
406
435
|
*/
|
|
407
436
|
'to'?: number | null;
|
|
408
437
|
}
|
|
409
|
-
export type AutomationBoundedFilterGranularityEnum = '
|
|
438
|
+
export type AutomationBoundedFilterGranularityEnum = 'SECOND' | 'SECOND_OF_MINUTE' | 'SECOND_OF_DAY' | 'MINUTE' | 'MINUTE_OF_HOUR' | 'MINUTE_OF_DAY' | 'HOUR' | 'HOUR_OF_DAY' | 'DAY' | 'DAY_OF_WEEK' | 'DAY_OF_MONTH' | 'DAY_OF_QUARTER' | 'DAY_OF_YEAR' | 'WEEK' | 'WEEK_OF_YEAR' | 'MONTH' | 'MONTH_OF_YEAR' | 'QUARTER' | 'QUARTER_OF_YEAR' | 'YEAR' | 'FISCAL_DAY_OF_FISCAL_WEEK' | 'FISCAL_DAY_OF_FISCAL_MONTH' | 'FISCAL_DAY_OF_FISCAL_QUARTER' | 'FISCAL_DAY_OF_FISCAL_SEMESTER' | 'FISCAL_DAY_OF_FISCAL_YEAR' | 'FISCAL_WEEK' | 'FISCAL_WEEK_OF_FISCAL_MONTH' | 'FISCAL_WEEK_OF_FISCAL_QUARTER' | 'FISCAL_WEEK_OF_FISCAL_SEMESTER' | 'FISCAL_WEEK_OF_FISCAL_YEAR' | 'FISCAL_MONTH' | 'FISCAL_MONTH_OF_FISCAL_QUARTER' | 'FISCAL_MONTH_OF_FISCAL_SEMESTER' | 'FISCAL_MONTH_OF_FISCAL_YEAR' | 'FISCAL_QUARTER' | 'FISCAL_QUARTER_OF_FISCAL_SEMESTER' | 'FISCAL_QUARTER_OF_FISCAL_YEAR' | 'FISCAL_SEMESTER' | 'FISCAL_SEMESTER_OF_FISCAL_YEAR' | 'FISCAL_YEAR';
|
|
410
439
|
export interface AutomationComparison {
|
|
411
|
-
'operator': AutomationComparisonOperatorEnum;
|
|
412
440
|
'left': AutomationLocalIdentifier;
|
|
441
|
+
'operator': AutomationComparisonOperatorEnum;
|
|
413
442
|
'right': AutomationAlertConditionOperand;
|
|
414
443
|
}
|
|
415
444
|
export type AutomationComparisonOperatorEnum = 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'EQUAL_TO' | 'NOT_EQUAL_TO';
|
|
@@ -431,19 +460,19 @@ export interface AutomationComparisonMeasureValueFilter {
|
|
|
431
460
|
'comparisonMeasureValueFilter': AutomationComparisonMeasureValueFilterComparisonMeasureValueFilter;
|
|
432
461
|
}
|
|
433
462
|
export interface AutomationComparisonMeasureValueFilterComparisonMeasureValueFilter {
|
|
463
|
+
'applyOnResult'?: boolean;
|
|
434
464
|
/**
|
|
435
465
|
* References to the attributes to be used when filtering.
|
|
436
466
|
*/
|
|
437
467
|
'dimensionality'?: Array<AutomationAfmIdentifier>;
|
|
468
|
+
'localIdentifier'?: string;
|
|
469
|
+
'measure': AutomationAfmIdentifier;
|
|
470
|
+
'operator': AutomationComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum;
|
|
438
471
|
/**
|
|
439
472
|
* A value that will be substituted for null values in the metric for the comparisons.
|
|
440
473
|
*/
|
|
441
474
|
'treatNullValuesAs'?: number;
|
|
442
|
-
'operator': AutomationComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum;
|
|
443
475
|
'value': number;
|
|
444
|
-
'localIdentifier'?: string;
|
|
445
|
-
'applyOnResult'?: boolean;
|
|
446
|
-
'measure': AutomationAfmIdentifier;
|
|
447
476
|
}
|
|
448
477
|
export type AutomationComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum = 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'EQUAL_TO' | 'NOT_EQUAL_TO';
|
|
449
478
|
export interface AutomationComparisonWrapper {
|
|
@@ -456,21 +485,21 @@ export interface AutomationCompoundMeasureValueFilter {
|
|
|
456
485
|
'compoundMeasureValueFilter': AutomationCompoundMeasureValueFilterCompoundMeasureValueFilter;
|
|
457
486
|
}
|
|
458
487
|
export interface AutomationCompoundMeasureValueFilterCompoundMeasureValueFilter {
|
|
488
|
+
'applyOnResult'?: boolean;
|
|
489
|
+
/**
|
|
490
|
+
* List of conditions to apply. Conditions are combined with OR logic. Each condition can be either a comparison (e.g., > 100) or a range (e.g., BETWEEN 10 AND 50). If empty, no filtering is applied and all rows are returned.
|
|
491
|
+
*/
|
|
492
|
+
'conditions': Array<AutomationMeasureValueCondition>;
|
|
459
493
|
/**
|
|
460
494
|
* References to the attributes to be used when filtering.
|
|
461
495
|
*/
|
|
462
496
|
'dimensionality'?: Array<AutomationAfmIdentifier>;
|
|
497
|
+
'localIdentifier'?: string;
|
|
498
|
+
'measure': AutomationAfmIdentifier;
|
|
463
499
|
/**
|
|
464
500
|
* A value that will be substituted for null values in the metric for the comparisons.
|
|
465
501
|
*/
|
|
466
502
|
'treatNullValuesAs'?: number;
|
|
467
|
-
/**
|
|
468
|
-
* List of conditions to apply. Conditions are combined with OR logic. Each condition can be either a comparison (e.g., > 100) or a range (e.g., BETWEEN 10 AND 50). If empty, no filtering is applied and all rows are returned.
|
|
469
|
-
*/
|
|
470
|
-
'conditions': Array<AutomationMeasureValueCondition>;
|
|
471
|
-
'localIdentifier'?: string;
|
|
472
|
-
'applyOnResult'?: boolean;
|
|
473
|
-
'measure': AutomationAfmIdentifier;
|
|
474
503
|
}
|
|
475
504
|
/**
|
|
476
505
|
* Custom label object override.
|
|
@@ -485,14 +514,14 @@ export interface AutomationCustomLabel {
|
|
|
485
514
|
* Custom metric object override.
|
|
486
515
|
*/
|
|
487
516
|
export interface AutomationCustomMetric {
|
|
488
|
-
/**
|
|
489
|
-
* Metric title override.
|
|
490
|
-
*/
|
|
491
|
-
'title': string;
|
|
492
517
|
/**
|
|
493
518
|
* Format override.
|
|
494
519
|
*/
|
|
495
520
|
'format': string;
|
|
521
|
+
/**
|
|
522
|
+
* Metric title override.
|
|
523
|
+
*/
|
|
524
|
+
'title': string;
|
|
496
525
|
}
|
|
497
526
|
/**
|
|
498
527
|
* Custom cell value overrides (IDs will be replaced with specified values).
|
|
@@ -516,27 +545,27 @@ export interface AutomationDashboardArbitraryAttributeFilter {
|
|
|
516
545
|
}
|
|
517
546
|
export interface AutomationDashboardArbitraryAttributeFilterArbitraryAttributeFilter {
|
|
518
547
|
'displayForm': AutomationIdentifierRef;
|
|
519
|
-
'values': Array<string>;
|
|
520
|
-
'negativeSelection': boolean;
|
|
521
548
|
'filterElementsBy'?: Array<AutomationAttributeFilterParent>;
|
|
522
549
|
'filterElementsByDate'?: Array<AutomationAttributeFilterByDate>;
|
|
523
|
-
'validateElementsBy'?: Array<AutomationIdentifierRef>;
|
|
524
|
-
'title'?: string;
|
|
525
550
|
'localIdentifier'?: string;
|
|
551
|
+
'negativeSelection': boolean;
|
|
552
|
+
'title'?: string;
|
|
553
|
+
'validateElementsBy'?: Array<AutomationIdentifierRef>;
|
|
554
|
+
'values': Array<string>;
|
|
526
555
|
}
|
|
527
556
|
export interface AutomationDashboardAttributeFilter {
|
|
528
557
|
'attributeFilter': AutomationDashboardAttributeFilterAttributeFilter;
|
|
529
558
|
}
|
|
530
559
|
export interface AutomationDashboardAttributeFilterAttributeFilter {
|
|
531
|
-
'displayForm': AutomationIdentifierRef;
|
|
532
|
-
'negativeSelection': boolean;
|
|
533
560
|
'attributeElements': AutomationAttributeElements;
|
|
561
|
+
'displayForm': AutomationIdentifierRef;
|
|
534
562
|
'filterElementsBy'?: Array<AutomationAttributeFilterParent>;
|
|
535
563
|
'filterElementsByDate'?: Array<AutomationAttributeFilterByDate>;
|
|
536
|
-
'validateElementsBy'?: Array<AutomationIdentifierRef>;
|
|
537
|
-
'title'?: string;
|
|
538
|
-
'selectionMode'?: AutomationDashboardAttributeFilterAttributeFilterSelectionModeEnum;
|
|
539
564
|
'localIdentifier'?: string;
|
|
565
|
+
'negativeSelection': boolean;
|
|
566
|
+
'selectionMode'?: AutomationDashboardAttributeFilterAttributeFilterSelectionModeEnum;
|
|
567
|
+
'title'?: string;
|
|
568
|
+
'validateElementsBy'?: Array<AutomationIdentifierRef>;
|
|
540
569
|
}
|
|
541
570
|
export type AutomationDashboardAttributeFilterAttributeFilterSelectionModeEnum = 'single' | 'multi';
|
|
542
571
|
export interface AutomationDashboardCompoundComparisonCondition {
|
|
@@ -544,8 +573,8 @@ export interface AutomationDashboardCompoundComparisonCondition {
|
|
|
544
573
|
}
|
|
545
574
|
export interface AutomationDashboardCompoundComparisonConditionComparison {
|
|
546
575
|
'operator': AutomationDashboardCompoundComparisonConditionComparisonOperatorEnum;
|
|
547
|
-
'value': number;
|
|
548
576
|
'treatNullValuesAs'?: number;
|
|
577
|
+
'value': number;
|
|
549
578
|
}
|
|
550
579
|
export type AutomationDashboardCompoundComparisonConditionComparisonOperatorEnum = 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'EQUAL_TO' | 'NOT_EQUAL_TO';
|
|
551
580
|
/**
|
|
@@ -556,8 +585,8 @@ export interface AutomationDashboardCompoundRangeCondition {
|
|
|
556
585
|
'range': AutomationDashboardCompoundRangeConditionRange;
|
|
557
586
|
}
|
|
558
587
|
export interface AutomationDashboardCompoundRangeConditionRange {
|
|
559
|
-
'operator': AutomationDashboardCompoundRangeConditionRangeOperatorEnum;
|
|
560
588
|
'from': number;
|
|
589
|
+
'operator': AutomationDashboardCompoundRangeConditionRangeOperatorEnum;
|
|
561
590
|
'to': number;
|
|
562
591
|
'treatNullValuesAs'?: number;
|
|
563
592
|
}
|
|
@@ -566,23 +595,27 @@ export interface AutomationDashboardDateFilter {
|
|
|
566
595
|
'dateFilter': AutomationDashboardDateFilterDateFilter;
|
|
567
596
|
}
|
|
568
597
|
export interface AutomationDashboardDateFilterDateFilter {
|
|
569
|
-
'type': AutomationDashboardDateFilterDateFilterTypeEnum;
|
|
570
|
-
'granularity': AutomationDashboardDateFilterDateFilterGranularityEnum;
|
|
571
|
-
'from'?: AutomationDashboardDateFilterDateFilterFrom;
|
|
572
|
-
'to'?: AutomationDashboardDateFilterDateFilterFrom;
|
|
573
|
-
'dataSet'?: AutomationIdentifierRef;
|
|
574
598
|
'attribute'?: AutomationIdentifierRef;
|
|
575
599
|
'boundedFilter'?: AutomationRelativeBoundedDateFilter;
|
|
600
|
+
'dataSet'?: AutomationIdentifierRef;
|
|
576
601
|
'emptyValueHandling'?: AutomationDashboardDateFilterDateFilterEmptyValueHandlingEnum;
|
|
602
|
+
'from'?: AutomationDashboardDateFilterDateFilterFrom;
|
|
603
|
+
'granularity': AutomationDashboardDateFilterDateFilterGranularityEnum;
|
|
577
604
|
'localIdentifier'?: string;
|
|
605
|
+
'to'?: AutomationDashboardDateFilterDateFilterTo;
|
|
606
|
+
'type': AutomationDashboardDateFilterDateFilterTypeEnum;
|
|
578
607
|
}
|
|
579
|
-
export type AutomationDashboardDateFilterDateFilterTypeEnum = 'relative' | 'absolute';
|
|
580
|
-
export type AutomationDashboardDateFilterDateFilterGranularityEnum = 'ALL_TIME_GRANULARITY' | 'GDC.time.year' | 'GDC.time.week_us' | 'GDC.time.week_in_year' | 'GDC.time.week_in_quarter' | 'GDC.time.week' | 'GDC.time.euweek_in_year' | 'GDC.time.euweek_in_quarter' | 'GDC.time.quarter' | 'GDC.time.quarter_in_year' | 'GDC.time.month' | 'GDC.time.month_in_quarter' | 'GDC.time.month_in_year' | 'GDC.time.day_in_year' | 'GDC.time.day_in_quarter' | 'GDC.time.day_in_month' | 'GDC.time.day_in_week' | 'GDC.time.day_in_euweek' | 'GDC.time.date' | 'GDC.time.hour' | 'GDC.time.hour_in_day' | 'GDC.time.minute' | 'GDC.time.minute_in_hour' | 'GDC.time.fiscal_month' | 'GDC.time.fiscal_quarter' | 'GDC.time.fiscal_year';
|
|
581
608
|
export type AutomationDashboardDateFilterDateFilterEmptyValueHandlingEnum = 'include' | 'exclude' | 'only';
|
|
609
|
+
export type AutomationDashboardDateFilterDateFilterGranularityEnum = 'ALL_TIME_GRANULARITY' | 'GDC.time.year' | 'GDC.time.week_us' | 'GDC.time.week_in_year' | 'GDC.time.week_in_quarter' | 'GDC.time.week' | 'GDC.time.euweek_in_year' | 'GDC.time.euweek_in_quarter' | 'GDC.time.quarter' | 'GDC.time.quarter_in_year' | 'GDC.time.month' | 'GDC.time.month_in_quarter' | 'GDC.time.month_in_year' | 'GDC.time.day_in_year' | 'GDC.time.day_in_quarter' | 'GDC.time.day_in_month' | 'GDC.time.day_in_week' | 'GDC.time.day_in_euweek' | 'GDC.time.date' | 'GDC.time.hour' | 'GDC.time.hour_in_day' | 'GDC.time.minute' | 'GDC.time.minute_in_hour' | 'GDC.time.minute_in_day' | 'GDC.time.second' | 'GDC.time.second_in_minute' | 'GDC.time.second_in_day' | 'GDC.time.fiscal_week' | 'GDC.time.fiscal_month' | 'GDC.time.fiscal_quarter' | 'GDC.time.fiscal_semester' | 'GDC.time.fiscal_year' | 'GDC.time.fiscal_day_in_fiscal_week' | 'GDC.time.fiscal_day_in_fiscal_month' | 'GDC.time.fiscal_day_in_fiscal_quarter' | 'GDC.time.fiscal_day_in_fiscal_semester' | 'GDC.time.fiscal_day_in_fiscal_year' | 'GDC.time.fiscal_week_in_fiscal_month' | 'GDC.time.fiscal_week_in_fiscal_quarter' | 'GDC.time.fiscal_week_in_fiscal_semester' | 'GDC.time.fiscal_week_in_fiscal_year' | 'GDC.time.fiscal_month_in_fiscal_quarter' | 'GDC.time.fiscal_month_in_fiscal_semester' | 'GDC.time.fiscal_month_in_fiscal_year' | 'GDC.time.fiscal_quarter_in_fiscal_semester' | 'GDC.time.fiscal_quarter_in_fiscal_year' | 'GDC.time.fiscal_semester_in_fiscal_year';
|
|
610
|
+
export type AutomationDashboardDateFilterDateFilterTypeEnum = 'relative' | 'absolute';
|
|
582
611
|
/**
|
|
583
612
|
* @type AutomationDashboardDateFilterDateFilterFrom
|
|
584
613
|
*/
|
|
585
614
|
export type AutomationDashboardDateFilterDateFilterFrom = number | string;
|
|
615
|
+
/**
|
|
616
|
+
* @type AutomationDashboardDateFilterDateFilterTo
|
|
617
|
+
*/
|
|
618
|
+
export type AutomationDashboardDateFilterDateFilterTo = number | string;
|
|
586
619
|
/**
|
|
587
620
|
* Additional settings.
|
|
588
621
|
*/
|
|
@@ -595,17 +628,17 @@ export interface AutomationDashboardExportSettings {
|
|
|
595
628
|
* Merge equal headers in neighbouring cells. Used for [XLSX] format only.
|
|
596
629
|
*/
|
|
597
630
|
'mergeHeaders'?: boolean;
|
|
598
|
-
/**
|
|
599
|
-
* Set page size. (PDF)
|
|
600
|
-
*/
|
|
601
|
-
'pageSize'?: AutomationDashboardExportSettingsPageSizeEnum;
|
|
602
631
|
/**
|
|
603
632
|
* Set page orientation. (PDF)
|
|
604
633
|
*/
|
|
605
634
|
'pageOrientation'?: AutomationDashboardExportSettingsPageOrientationEnum;
|
|
635
|
+
/**
|
|
636
|
+
* Set page size. (PDF)
|
|
637
|
+
*/
|
|
638
|
+
'pageSize'?: AutomationDashboardExportSettingsPageSizeEnum;
|
|
606
639
|
}
|
|
607
|
-
export type AutomationDashboardExportSettingsPageSizeEnum = 'A3' | 'A4' | 'LETTER';
|
|
608
640
|
export type AutomationDashboardExportSettingsPageOrientationEnum = 'PORTRAIT' | 'LANDSCAPE';
|
|
641
|
+
export type AutomationDashboardExportSettingsPageSizeEnum = 'A3' | 'A4' | 'LETTER';
|
|
609
642
|
/**
|
|
610
643
|
* @type AutomationDashboardFilter
|
|
611
644
|
*/
|
|
@@ -614,41 +647,41 @@ export interface AutomationDashboardMatchAttributeFilter {
|
|
|
614
647
|
'matchAttributeFilter': AutomationDashboardMatchAttributeFilterMatchAttributeFilter;
|
|
615
648
|
}
|
|
616
649
|
export interface AutomationDashboardMatchAttributeFilterMatchAttributeFilter {
|
|
650
|
+
'caseSensitive': boolean;
|
|
617
651
|
'displayForm': AutomationIdentifierRef;
|
|
618
|
-
'operator': AutomationDashboardMatchAttributeFilterMatchAttributeFilterOperatorEnum;
|
|
619
652
|
'literal': string;
|
|
653
|
+
'localIdentifier'?: string;
|
|
620
654
|
'negativeSelection': boolean;
|
|
621
|
-
'
|
|
655
|
+
'operator': AutomationDashboardMatchAttributeFilterMatchAttributeFilterOperatorEnum;
|
|
622
656
|
'title'?: string;
|
|
623
|
-
'localIdentifier'?: string;
|
|
624
657
|
}
|
|
625
658
|
export type AutomationDashboardMatchAttributeFilterMatchAttributeFilterOperatorEnum = 'contains' | 'startsWith' | 'endsWith';
|
|
626
659
|
export interface AutomationDashboardMeasureValueFilter {
|
|
627
660
|
'dashboardMeasureValueFilter': AutomationDashboardMeasureValueFilterDashboardMeasureValueFilter;
|
|
628
661
|
}
|
|
629
662
|
export interface AutomationDashboardMeasureValueFilterDashboardMeasureValueFilter {
|
|
630
|
-
'measure': AutomationIdentifierRef;
|
|
631
663
|
'conditions': Array<AutomationDashboardCompoundConditionItem>;
|
|
632
664
|
'dimensionality'?: Array<AutomationIdentifierRef>;
|
|
633
|
-
'title'?: string;
|
|
634
665
|
'localIdentifier'?: string;
|
|
666
|
+
'measure': AutomationIdentifierRef;
|
|
667
|
+
'title'?: string;
|
|
635
668
|
}
|
|
636
669
|
/**
|
|
637
670
|
* Export request object describing the export properties for dashboard tabular exports (v2 with dashboardId).
|
|
638
671
|
*/
|
|
639
672
|
export interface AutomationDashboardTabularExportRequestV2 {
|
|
640
673
|
/**
|
|
641
|
-
*
|
|
674
|
+
* List of filters that will be used instead of the default dashboard filters.
|
|
642
675
|
*/
|
|
643
|
-
'
|
|
676
|
+
'dashboardFiltersOverride'?: Array<AutomationDashboardFilter>;
|
|
644
677
|
/**
|
|
645
|
-
*
|
|
678
|
+
* Dashboard identifier
|
|
646
679
|
*/
|
|
647
|
-
'
|
|
680
|
+
'dashboardId': string;
|
|
648
681
|
/**
|
|
649
|
-
*
|
|
682
|
+
* Parameter value overrides applied to the export\'s executions. Each entry carries the parameter id (used as an AFM execution override) plus the FE-supplied title for the info sheet. Applied uniformly across all tabs; use dashboardTabsParametersOverrides for tab-scoped overrides.
|
|
650
683
|
*/
|
|
651
|
-
'
|
|
684
|
+
'dashboardParametersOverride'?: Array<AutomationParameterValue>;
|
|
652
685
|
/**
|
|
653
686
|
* Map of tab-specific filter overrides. Key is tabId, value is list of filters for that tab.
|
|
654
687
|
*/
|
|
@@ -656,31 +689,31 @@ export interface AutomationDashboardTabularExportRequestV2 {
|
|
|
656
689
|
[key: string]: Array<AutomationDashboardFilter>;
|
|
657
690
|
};
|
|
658
691
|
/**
|
|
659
|
-
*
|
|
692
|
+
* Map of tab-specific parameter overrides. Key is tabId, value is a list of (id, value, title) entries that override the dashboard-level parameters for that tab only. Mirrors dashboardTabsFiltersOverrides. When a tab is present in this map, its entries take precedence over dashboardParametersOverride for that tab\'s executions and info-sheet display.
|
|
660
693
|
*/
|
|
661
|
-
'
|
|
694
|
+
'dashboardTabsParametersOverrides'?: {
|
|
695
|
+
[key: string]: Array<AutomationParameterValue>;
|
|
696
|
+
};
|
|
662
697
|
/**
|
|
663
|
-
*
|
|
698
|
+
* Filename of downloaded file without extension.
|
|
664
699
|
*/
|
|
665
|
-
'
|
|
666
|
-
'settings'?: AutomationDashboardExportSettings;
|
|
700
|
+
'fileName': string;
|
|
667
701
|
/**
|
|
668
|
-
*
|
|
702
|
+
* Requested tabular export type.
|
|
669
703
|
*/
|
|
670
|
-
'
|
|
704
|
+
'format': AutomationDashboardTabularExportRequestV2FormatEnum;
|
|
705
|
+
'settings'?: AutomationDashboardExportSettings;
|
|
671
706
|
/**
|
|
672
|
-
*
|
|
707
|
+
* List of widget identifiers to be exported. Note that only one widget is currently supported.
|
|
673
708
|
*/
|
|
674
|
-
'
|
|
675
|
-
[key: string]: Array<AutomationParameterValue>;
|
|
676
|
-
};
|
|
709
|
+
'widgetIds'?: Array<string>;
|
|
677
710
|
}
|
|
678
711
|
export type AutomationDashboardTabularExportRequestV2FormatEnum = 'XLSX' | 'PDF';
|
|
679
712
|
/**
|
|
680
713
|
* @type AutomationDateFilter
|
|
681
714
|
* Abstract filter definition type for dates.
|
|
682
715
|
*/
|
|
683
|
-
export type AutomationDateFilter = AutomationAbsoluteDateFilter | AutomationAllTimeDateFilter | AutomationRelativeDateFilter;
|
|
716
|
+
export type AutomationDateFilter = AutomationAbsoluteDateFilter | AutomationAbsoluteGranularityDateFilter | AutomationAllTimeDateFilter | AutomationRelativeDateFilter;
|
|
684
717
|
export interface AutomationDateValue {
|
|
685
718
|
'value': string;
|
|
686
719
|
}
|
|
@@ -756,25 +789,29 @@ export interface AutomationExecutionSettings {
|
|
|
756
789
|
* Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used.
|
|
757
790
|
*/
|
|
758
791
|
'timestamp'?: string;
|
|
792
|
+
/**
|
|
793
|
+
* Specifies the time zone used to resolve relative date filters and to convert time-zone-aware date/time values in the result. Expects an IANA time zone id (e.g. \"Europe/Prague\") or a fixed GMT offset (e.g. \"GMT+02:00\"). If not set, the time zone from the workspace/user settings is used.
|
|
794
|
+
*/
|
|
795
|
+
'timezone'?: string;
|
|
759
796
|
}
|
|
760
797
|
export interface AutomationExportResult {
|
|
761
|
-
'
|
|
762
|
-
'exportId': string;
|
|
763
|
-
'status': AutomationExportResultStatusEnum;
|
|
764
|
-
'fileUri'?: string;
|
|
798
|
+
'errorMessage'?: string;
|
|
765
799
|
'expiresAt'?: string;
|
|
800
|
+
'exportId': string;
|
|
801
|
+
'fileName': string;
|
|
766
802
|
'fileSize'?: number;
|
|
767
|
-
'
|
|
803
|
+
'fileUri'?: string;
|
|
804
|
+
'finishedAt'?: string;
|
|
805
|
+
'status': AutomationExportResultStatusEnum;
|
|
768
806
|
'traceId'?: string;
|
|
769
807
|
'triggeredAt'?: string;
|
|
770
|
-
'finishedAt'?: string;
|
|
771
808
|
}
|
|
772
809
|
export type AutomationExportResultStatusEnum = 'SUCCESS' | 'ERROR' | 'INTERNAL_ERROR' | 'TIMEOUT';
|
|
773
810
|
/**
|
|
774
811
|
* @type AutomationFilterDefinition
|
|
775
812
|
* Abstract filter definition type
|
|
776
813
|
*/
|
|
777
|
-
export type AutomationFilterDefinition = AutomationAbsoluteDateFilter | AutomationAllTimeDateFilter | AutomationComparisonMeasureValueFilter | AutomationCompoundMeasureValueFilter | AutomationInlineFilterDefinition | AutomationMatchAttributeFilter | AutomationNegativeAttributeFilter | AutomationPositiveAttributeFilter | AutomationRangeMeasureValueFilter | AutomationRankingFilter | AutomationRelativeDateFilter;
|
|
814
|
+
export type AutomationFilterDefinition = AutomationAbsoluteDateFilter | AutomationAbsoluteGranularityDateFilter | AutomationAllTimeDateFilter | AutomationComparisonMeasureValueFilter | AutomationCompoundMeasureValueFilter | AutomationInlineFilterDefinition | AutomationMatchAttributeFilter | AutomationNegativeAttributeFilter | AutomationPositiveAttributeFilter | AutomationRangeMeasureValueFilter | AutomationRankingFilter | AutomationRelativeDateFilter;
|
|
778
815
|
/**
|
|
779
816
|
* @type AutomationFilterDefinitionForSimpleMeasure
|
|
780
817
|
* Abstract filter definition type for simple metric.
|
|
@@ -787,31 +824,31 @@ export interface AutomationIdentifierRefIdentifier {
|
|
|
787
824
|
'id': string;
|
|
788
825
|
'type': AutomationIdentifierRefIdentifierTypeEnum;
|
|
789
826
|
}
|
|
790
|
-
export type AutomationIdentifierRefIdentifierTypeEnum = 'analyticalDashboard' | 'attribute' | 'attributeHierarchy' | 'dashboardPlugin' | 'dataset' | 'fact' | 'aggregatedFact' | 'label' | 'metric' | 'userDataFilter' | 'parameter' | 'exportDefinition' | 'automation' | 'automationResult' | 'memoryItem' | 'knowledgeRecommendation' | 'prompt' | 'visualizationObject' | 'filterContext' | 'workspaceSettings' | 'customApplicationSetting' | 'workspaceDataFilter' | 'workspaceDataFilterSetting' | 'filterView' | 'workspaceExportTemplate';
|
|
827
|
+
export type AutomationIdentifierRefIdentifierTypeEnum = 'analyticalDashboard' | 'attribute' | 'attributeHierarchy' | 'dashboardPlugin' | 'dataset' | 'fact' | 'aggregatedFact' | 'label' | 'metric' | 'userDataFilter' | 'parameter' | 'exportDefinition' | 'automation' | 'automationResult' | 'memoryItem' | 'knowledgeRecommendation' | 'prompt' | 'visualizationObject' | 'filterContext' | 'workspaceSettings' | 'customApplicationSetting' | 'workspaceDataFilter' | 'workspaceDataFilterSetting' | 'filterView' | 'workspaceExportTemplate' | 'workspaceTheme' | 'workspaceColorPalette' | 'fiscalCalendar' | 'fiscalCalendarGranularity';
|
|
791
828
|
/**
|
|
792
829
|
* Export request object describing the export properties and metadata for image exports.
|
|
793
830
|
*/
|
|
794
831
|
export interface AutomationImageExportRequest {
|
|
795
832
|
/**
|
|
796
|
-
*
|
|
833
|
+
* Dashboard identifier
|
|
797
834
|
*/
|
|
798
|
-
'
|
|
835
|
+
'dashboardId': string;
|
|
799
836
|
/**
|
|
800
837
|
* File name to be used for retrieving the image document.
|
|
801
838
|
*/
|
|
802
839
|
'fileName': string;
|
|
803
840
|
/**
|
|
804
|
-
*
|
|
805
|
-
*/
|
|
806
|
-
'dashboardId': string;
|
|
807
|
-
/**
|
|
808
|
-
* List of widget identifiers to be exported. Note that only one widget is currently supported.
|
|
841
|
+
* Requested resulting file type.
|
|
809
842
|
*/
|
|
810
|
-
'
|
|
843
|
+
'format': AutomationImageExportRequestFormatEnum;
|
|
811
844
|
/**
|
|
812
845
|
* Metadata definition in free-form JSON format.
|
|
813
846
|
*/
|
|
814
847
|
'metadata'?: object | null;
|
|
848
|
+
/**
|
|
849
|
+
* List of widget identifiers to be exported. Note that only one widget is currently supported.
|
|
850
|
+
*/
|
|
851
|
+
'widgetIds': Array<string>;
|
|
815
852
|
}
|
|
816
853
|
export type AutomationImageExportRequestFormatEnum = 'PNG';
|
|
817
854
|
/**
|
|
@@ -831,12 +868,12 @@ export interface AutomationInlineFilterDefinition {
|
|
|
831
868
|
'inline': AutomationInlineFilterDefinitionInline;
|
|
832
869
|
}
|
|
833
870
|
export interface AutomationInlineFilterDefinitionInline {
|
|
871
|
+
'applyOnResult'?: boolean;
|
|
834
872
|
/**
|
|
835
873
|
* MAQL query representing the filter.
|
|
836
874
|
*/
|
|
837
875
|
'filter': string;
|
|
838
876
|
'localIdentifier'?: string;
|
|
839
|
-
'applyOnResult'?: boolean;
|
|
840
877
|
}
|
|
841
878
|
/**
|
|
842
879
|
* Metric defined by the raw MAQL query.
|
|
@@ -851,14 +888,14 @@ export interface AutomationInlineMeasureDefinitionInline {
|
|
|
851
888
|
'maql': string;
|
|
852
889
|
}
|
|
853
890
|
export interface AutomationLocalIdentifier {
|
|
854
|
-
/**
|
|
855
|
-
* Local identifier of the metric to be compared.
|
|
856
|
-
*/
|
|
857
|
-
'localIdentifier': string;
|
|
858
891
|
/**
|
|
859
892
|
* Metric format.
|
|
860
893
|
*/
|
|
861
894
|
'format'?: string | null;
|
|
895
|
+
/**
|
|
896
|
+
* Local identifier of the metric to be compared.
|
|
897
|
+
*/
|
|
898
|
+
'localIdentifier': string;
|
|
862
899
|
/**
|
|
863
900
|
* Metric title.
|
|
864
901
|
*/
|
|
@@ -871,10 +908,17 @@ export interface AutomationMatchAttributeFilter {
|
|
|
871
908
|
'matchAttributeFilter': AutomationMatchAttributeFilterMatchAttributeFilter;
|
|
872
909
|
}
|
|
873
910
|
export interface AutomationMatchAttributeFilterMatchAttributeFilter {
|
|
911
|
+
'applyOnResult'?: boolean;
|
|
912
|
+
/**
|
|
913
|
+
* Indicates whether the filter match is evaluated in case-sensitive mode or not.
|
|
914
|
+
*/
|
|
915
|
+
'caseSensitive'?: boolean;
|
|
916
|
+
'label': AutomationAfmIdentifier;
|
|
874
917
|
/**
|
|
875
918
|
* Literal used to limit label values.
|
|
876
919
|
*/
|
|
877
920
|
'literal': string;
|
|
921
|
+
'localIdentifier'?: string;
|
|
878
922
|
/**
|
|
879
923
|
* Requested match type.
|
|
880
924
|
*/
|
|
@@ -883,13 +927,6 @@ export interface AutomationMatchAttributeFilterMatchAttributeFilter {
|
|
|
883
927
|
* Indicates whether the filter should negate the match.
|
|
884
928
|
*/
|
|
885
929
|
'negate'?: boolean;
|
|
886
|
-
/**
|
|
887
|
-
* Indicates whether the filter match is evaluated in case-sensitive mode or not.
|
|
888
|
-
*/
|
|
889
|
-
'caseSensitive'?: boolean;
|
|
890
|
-
'localIdentifier'?: string;
|
|
891
|
-
'applyOnResult'?: boolean;
|
|
892
|
-
'label': AutomationAfmIdentifier;
|
|
893
930
|
}
|
|
894
931
|
export type AutomationMatchAttributeFilterMatchAttributeFilterMatchTypeEnum = 'STARTS_WITH' | 'ENDS_WITH' | 'CONTAINS';
|
|
895
932
|
/**
|
|
@@ -901,11 +938,11 @@ export type AutomationMeasureDefinition = AutomationArithmeticMeasureDefinition
|
|
|
901
938
|
* Metric is a quantity that is calculated from the data.
|
|
902
939
|
*/
|
|
903
940
|
export interface AutomationMeasureItem {
|
|
941
|
+
'definition': AutomationMeasureItemDefinition;
|
|
904
942
|
/**
|
|
905
943
|
* Local identifier of the metric. This can be used to reference the metric in other parts of the execution definition.
|
|
906
944
|
*/
|
|
907
945
|
'localIdentifier': string;
|
|
908
|
-
'definition': AutomationMeasureItemDefinition;
|
|
909
946
|
}
|
|
910
947
|
/**
|
|
911
948
|
* @type AutomationMeasureItemDefinition
|
|
@@ -925,12 +962,12 @@ export type AutomationMeasureValueFilter = AutomationComparisonMeasureValueFilte
|
|
|
925
962
|
* (EXPERIMENTAL) Override for a catalog metric definition.
|
|
926
963
|
*/
|
|
927
964
|
export interface AutomationMetricDefinitionOverride {
|
|
928
|
-
'item': AutomationAfmObjectIdentifierCore;
|
|
929
965
|
'definition': AutomationInlineMeasureDefinition;
|
|
966
|
+
'item': AutomationAfmObjectIdentifierCore;
|
|
930
967
|
}
|
|
931
968
|
export interface AutomationMetricRecord {
|
|
932
|
-
'value': number;
|
|
933
969
|
'formattedValue'?: string;
|
|
970
|
+
'value': number;
|
|
934
971
|
}
|
|
935
972
|
/**
|
|
936
973
|
* Filter able to limit element values by label and related selected negated elements.
|
|
@@ -939,22 +976,22 @@ export interface AutomationNegativeAttributeFilter {
|
|
|
939
976
|
'negativeAttributeFilter': AutomationNegativeAttributeFilterNegativeAttributeFilter;
|
|
940
977
|
}
|
|
941
978
|
export interface AutomationNegativeAttributeFilterNegativeAttributeFilter {
|
|
942
|
-
'notIn': AutomationAttributeFilterElements;
|
|
943
|
-
'localIdentifier'?: string;
|
|
944
979
|
'applyOnResult'?: boolean;
|
|
980
|
+
'label': AutomationAfmIdentifier;
|
|
981
|
+
'localIdentifier'?: string;
|
|
982
|
+
'notIn': AutomationAttributeFilterElements;
|
|
945
983
|
/**
|
|
946
984
|
* If true, indicates that the values in notInElements were filled free-form, otherwise they have been picked from existing elements.
|
|
947
985
|
*/
|
|
948
986
|
'usesArbitraryValues'?: boolean;
|
|
949
|
-
'label': AutomationAfmIdentifier;
|
|
950
987
|
}
|
|
951
988
|
export interface AutomationNotification {
|
|
952
|
-
'id': string;
|
|
953
|
-
'workspaceId'?: string;
|
|
954
989
|
'automationId'?: string;
|
|
990
|
+
'createdAt': string;
|
|
955
991
|
'data': AutomationNotificationData;
|
|
992
|
+
'id': string;
|
|
956
993
|
'isRead': boolean;
|
|
957
|
-
'
|
|
994
|
+
'workspaceId'?: string;
|
|
958
995
|
}
|
|
959
996
|
/**
|
|
960
997
|
* @type AutomationNotificationChannelDestination
|
|
@@ -968,8 +1005,8 @@ export interface AutomationNotificationContent {
|
|
|
968
1005
|
*/
|
|
969
1006
|
export type AutomationNotificationData = AutomationAutomationNotification | AutomationTestNotification;
|
|
970
1007
|
export interface AutomationNotificationFilter {
|
|
971
|
-
'title': string;
|
|
972
1008
|
'filter': string;
|
|
1009
|
+
'title': string;
|
|
973
1010
|
}
|
|
974
1011
|
export interface AutomationNotifications {
|
|
975
1012
|
'data': Array<AutomationNotification>;
|
|
@@ -979,8 +1016,8 @@ export interface AutomationNotificationsMeta {
|
|
|
979
1016
|
'total'?: AutomationNotificationsMetaTotal;
|
|
980
1017
|
}
|
|
981
1018
|
export interface AutomationNotificationsMetaTotal {
|
|
982
|
-
'unread': number;
|
|
983
1019
|
'all': number;
|
|
1020
|
+
'unread': number;
|
|
984
1021
|
}
|
|
985
1022
|
export interface AutomationOver {
|
|
986
1023
|
'attributes': Array<AutomationIdentifierRef>;
|
|
@@ -989,6 +1026,7 @@ export interface AutomationOver {
|
|
|
989
1026
|
* (EXPERIMENTAL) Parameter value for this execution.
|
|
990
1027
|
*/
|
|
991
1028
|
export interface AutomationParameterItem {
|
|
1029
|
+
[key: string]: any;
|
|
992
1030
|
'parameter': AutomationAfmObjectIdentifierParameter;
|
|
993
1031
|
/**
|
|
994
1032
|
* Value to use for this parameter instead of its default.
|
|
@@ -999,31 +1037,32 @@ export interface AutomationParameterItem {
|
|
|
999
1037
|
* Parameter value override applied to the export. The (id, value) pair drives the execution; the title is FE-supplied for info-sheet display.
|
|
1000
1038
|
*/
|
|
1001
1039
|
export interface AutomationParameterValue {
|
|
1040
|
+
[key: string]: any;
|
|
1002
1041
|
/**
|
|
1003
1042
|
* Identifier of the workspace parameter (matches the parameter entity id).
|
|
1004
1043
|
*/
|
|
1005
1044
|
'id': string;
|
|
1006
|
-
/**
|
|
1007
|
-
* Value to use for this parameter when executing the export.
|
|
1008
|
-
*/
|
|
1009
|
-
'value': string;
|
|
1010
1045
|
/**
|
|
1011
1046
|
* Display title of the parameter as the client wants it rendered on the info sheet.
|
|
1012
1047
|
*/
|
|
1013
1048
|
'title': string;
|
|
1049
|
+
/**
|
|
1050
|
+
* Value to use for this parameter when executing the export.
|
|
1051
|
+
*/
|
|
1052
|
+
'value': string;
|
|
1014
1053
|
}
|
|
1015
1054
|
/**
|
|
1016
1055
|
* Custom CSS styles for the table. (PDF, HTML)
|
|
1017
1056
|
*/
|
|
1018
1057
|
export interface AutomationPdfTableStyle {
|
|
1019
|
-
/**
|
|
1020
|
-
* CSS selector where to apply given properties.
|
|
1021
|
-
*/
|
|
1022
|
-
'selector': string;
|
|
1023
1058
|
/**
|
|
1024
1059
|
* List of CSS properties.
|
|
1025
1060
|
*/
|
|
1026
1061
|
'properties'?: Array<AutomationPdfTableStyleProperty>;
|
|
1062
|
+
/**
|
|
1063
|
+
* CSS selector where to apply given properties.
|
|
1064
|
+
*/
|
|
1065
|
+
'selector': string;
|
|
1027
1066
|
}
|
|
1028
1067
|
/**
|
|
1029
1068
|
* CSS property.
|
|
@@ -1055,11 +1094,11 @@ export interface AutomationPopDatasetMeasureDefinition {
|
|
|
1055
1094
|
'previousPeriodMeasure': AutomationPopDatasetMeasureDefinitionPreviousPeriodMeasure;
|
|
1056
1095
|
}
|
|
1057
1096
|
export interface AutomationPopDatasetMeasureDefinitionPreviousPeriodMeasure {
|
|
1058
|
-
'measureIdentifier': AutomationAfmLocalIdentifier;
|
|
1059
1097
|
/**
|
|
1060
1098
|
* Specification of which date data sets to use for determining the period to calculate the previous period for.
|
|
1061
1099
|
*/
|
|
1062
1100
|
'dateDatasets': Array<AutomationPopDataset>;
|
|
1101
|
+
'measureIdentifier': AutomationAfmLocalIdentifier;
|
|
1063
1102
|
}
|
|
1064
1103
|
/**
|
|
1065
1104
|
* Combination of the date attribute to use and how many periods ago to calculate the PoP for.
|
|
@@ -1078,11 +1117,11 @@ export interface AutomationPopDateMeasureDefinition {
|
|
|
1078
1117
|
'overPeriodMeasure': AutomationPopDateMeasureDefinitionOverPeriodMeasure;
|
|
1079
1118
|
}
|
|
1080
1119
|
export interface AutomationPopDateMeasureDefinitionOverPeriodMeasure {
|
|
1081
|
-
'measureIdentifier': AutomationAfmLocalIdentifier;
|
|
1082
1120
|
/**
|
|
1083
1121
|
* Attributes to use for determining the period to calculate the PoP for.
|
|
1084
1122
|
*/
|
|
1085
1123
|
'dateAttributes': Array<AutomationPopDate>;
|
|
1124
|
+
'measureIdentifier': AutomationAfmLocalIdentifier;
|
|
1086
1125
|
}
|
|
1087
1126
|
/**
|
|
1088
1127
|
* @type AutomationPopMeasureDefinition
|
|
@@ -1095,19 +1134,19 @@ export interface AutomationPositiveAttributeFilter {
|
|
|
1095
1134
|
'positiveAttributeFilter': AutomationPositiveAttributeFilterPositiveAttributeFilter;
|
|
1096
1135
|
}
|
|
1097
1136
|
export interface AutomationPositiveAttributeFilterPositiveAttributeFilter {
|
|
1137
|
+
'applyOnResult'?: boolean;
|
|
1098
1138
|
'in': AutomationAttributeFilterElements;
|
|
1139
|
+
'label': AutomationAfmIdentifier;
|
|
1099
1140
|
'localIdentifier'?: string;
|
|
1100
|
-
'applyOnResult'?: boolean;
|
|
1101
1141
|
/**
|
|
1102
1142
|
* If true, indicates that the values in inElements were filled free-form, otherwise they have been picked from existing elements.
|
|
1103
1143
|
*/
|
|
1104
1144
|
'usesArbitraryValues'?: boolean;
|
|
1105
|
-
'label': AutomationAfmIdentifier;
|
|
1106
1145
|
}
|
|
1107
1146
|
export interface AutomationRange {
|
|
1108
|
-
'operator': AutomationRangeOperatorEnum;
|
|
1109
|
-
'measure': AutomationLocalIdentifier;
|
|
1110
1147
|
'from': AutomationValue;
|
|
1148
|
+
'measure': AutomationLocalIdentifier;
|
|
1149
|
+
'operator': AutomationRangeOperatorEnum;
|
|
1111
1150
|
'to': AutomationValue;
|
|
1112
1151
|
}
|
|
1113
1152
|
export type AutomationRangeOperatorEnum = 'BETWEEN' | 'NOT_BETWEEN';
|
|
@@ -1118,8 +1157,8 @@ export interface AutomationRangeCondition {
|
|
|
1118
1157
|
'range': AutomationRangeConditionRange;
|
|
1119
1158
|
}
|
|
1120
1159
|
export interface AutomationRangeConditionRange {
|
|
1121
|
-
'operator': AutomationRangeConditionRangeOperatorEnum;
|
|
1122
1160
|
'from': number;
|
|
1161
|
+
'operator': AutomationRangeConditionRangeOperatorEnum;
|
|
1123
1162
|
'to': number;
|
|
1124
1163
|
}
|
|
1125
1164
|
export type AutomationRangeConditionRangeOperatorEnum = 'BETWEEN' | 'NOT_BETWEEN';
|
|
@@ -1130,20 +1169,20 @@ export interface AutomationRangeMeasureValueFilter {
|
|
|
1130
1169
|
'rangeMeasureValueFilter': AutomationRangeMeasureValueFilterRangeMeasureValueFilter;
|
|
1131
1170
|
}
|
|
1132
1171
|
export interface AutomationRangeMeasureValueFilterRangeMeasureValueFilter {
|
|
1172
|
+
'applyOnResult'?: boolean;
|
|
1133
1173
|
/**
|
|
1134
1174
|
* References to the attributes to be used when filtering.
|
|
1135
1175
|
*/
|
|
1136
1176
|
'dimensionality'?: Array<AutomationAfmIdentifier>;
|
|
1177
|
+
'from': number;
|
|
1178
|
+
'localIdentifier'?: string;
|
|
1179
|
+
'measure': AutomationAfmIdentifier;
|
|
1180
|
+
'operator': AutomationRangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum;
|
|
1181
|
+
'to': number;
|
|
1137
1182
|
/**
|
|
1138
1183
|
* A value that will be substituted for null values in the metric for the comparisons.
|
|
1139
1184
|
*/
|
|
1140
1185
|
'treatNullValuesAs'?: number;
|
|
1141
|
-
'operator': AutomationRangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum;
|
|
1142
|
-
'from': number;
|
|
1143
|
-
'to': number;
|
|
1144
|
-
'localIdentifier'?: string;
|
|
1145
|
-
'applyOnResult'?: boolean;
|
|
1146
|
-
'measure': AutomationAfmIdentifier;
|
|
1147
1186
|
}
|
|
1148
1187
|
export type AutomationRangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum = 'BETWEEN' | 'NOT_BETWEEN';
|
|
1149
1188
|
export interface AutomationRangeWrapper {
|
|
@@ -1156,10 +1195,12 @@ export interface AutomationRankingFilter {
|
|
|
1156
1195
|
'rankingFilter': AutomationRankingFilterRankingFilter;
|
|
1157
1196
|
}
|
|
1158
1197
|
export interface AutomationRankingFilterRankingFilter {
|
|
1198
|
+
'applyOnResult'?: boolean;
|
|
1159
1199
|
/**
|
|
1160
1200
|
* References to the attributes to be used when filtering.
|
|
1161
1201
|
*/
|
|
1162
1202
|
'dimensionality'?: Array<AutomationAfmIdentifier>;
|
|
1203
|
+
'localIdentifier'?: string;
|
|
1163
1204
|
/**
|
|
1164
1205
|
* References to the metrics to be used when filtering.
|
|
1165
1206
|
*/
|
|
@@ -1168,16 +1209,14 @@ export interface AutomationRankingFilterRankingFilter {
|
|
|
1168
1209
|
* The type of ranking to use, TOP or BOTTOM.
|
|
1169
1210
|
*/
|
|
1170
1211
|
'operator': AutomationRankingFilterRankingFilterOperatorEnum;
|
|
1171
|
-
/**
|
|
1172
|
-
* Number of top/bottom values to filter.
|
|
1173
|
-
*/
|
|
1174
|
-
'value': number;
|
|
1175
1212
|
/**
|
|
1176
1213
|
* When true, filter returns requested number of rows at most. Default is false.
|
|
1177
1214
|
*/
|
|
1178
1215
|
'strictLimitOfRows'?: boolean;
|
|
1179
|
-
|
|
1180
|
-
|
|
1216
|
+
/**
|
|
1217
|
+
* Number of top/bottom values to filter.
|
|
1218
|
+
*/
|
|
1219
|
+
'value': number;
|
|
1181
1220
|
}
|
|
1182
1221
|
export type AutomationRankingFilterRankingFilterOperatorEnum = 'TOP' | 'BOTTOM';
|
|
1183
1222
|
/**
|
|
@@ -1219,21 +1258,21 @@ export interface AutomationRawCustomOverride {
|
|
|
1219
1258
|
* Export request object describing the export properties and overrides for raw exports.
|
|
1220
1259
|
*/
|
|
1221
1260
|
export interface AutomationRawExportAutomationRequest {
|
|
1261
|
+
'customOverride'?: AutomationRawCustomOverride;
|
|
1222
1262
|
/**
|
|
1223
|
-
*
|
|
1263
|
+
* Set column delimiter. (CSV)
|
|
1224
1264
|
*/
|
|
1225
|
-
'
|
|
1265
|
+
'delimiter'?: string;
|
|
1226
1266
|
'execution': AutomationAFM;
|
|
1267
|
+
'executionSettings'?: AutomationExecutionSettings;
|
|
1227
1268
|
/**
|
|
1228
1269
|
* Filename of downloaded file without extension.
|
|
1229
1270
|
*/
|
|
1230
1271
|
'fileName': string;
|
|
1231
|
-
'customOverride'?: AutomationRawCustomOverride;
|
|
1232
|
-
'executionSettings'?: AutomationExecutionSettings;
|
|
1233
1272
|
/**
|
|
1234
|
-
*
|
|
1273
|
+
* Requested resulting file type.
|
|
1235
1274
|
*/
|
|
1236
|
-
'
|
|
1275
|
+
'format': AutomationRawExportAutomationRequestFormatEnum;
|
|
1237
1276
|
/**
|
|
1238
1277
|
* Metadata definition in free-form JSON format.
|
|
1239
1278
|
*/
|
|
@@ -1241,20 +1280,20 @@ export interface AutomationRawExportAutomationRequest {
|
|
|
1241
1280
|
}
|
|
1242
1281
|
export type AutomationRawExportAutomationRequestFormatEnum = 'ARROW_FILE' | 'ARROW_STREAM' | 'CSV';
|
|
1243
1282
|
export interface AutomationRelative {
|
|
1283
|
+
'measure': AutomationArithmeticMeasure;
|
|
1244
1284
|
/**
|
|
1245
1285
|
* Relative condition operator. INCREASES_BY - the metric increases by the specified value. DECREASES_BY - the metric decreases by the specified value. CHANGES_BY - the metric increases or decreases by the specified value.
|
|
1246
1286
|
*/
|
|
1247
1287
|
'operator': AutomationRelativeOperatorEnum;
|
|
1248
|
-
'measure': AutomationArithmeticMeasure;
|
|
1249
1288
|
'threshold': AutomationValue;
|
|
1250
1289
|
}
|
|
1251
1290
|
export type AutomationRelativeOperatorEnum = 'INCREASES_BY' | 'DECREASES_BY' | 'CHANGES_BY';
|
|
1252
1291
|
export interface AutomationRelativeBoundedDateFilter {
|
|
1253
|
-
'granularity': AutomationRelativeBoundedDateFilterGranularityEnum;
|
|
1254
1292
|
'from'?: number;
|
|
1293
|
+
'granularity': AutomationRelativeBoundedDateFilterGranularityEnum;
|
|
1255
1294
|
'to'?: number;
|
|
1256
1295
|
}
|
|
1257
|
-
export type AutomationRelativeBoundedDateFilterGranularityEnum = 'ALL_TIME_GRANULARITY' | 'GDC.time.year' | 'GDC.time.week_us' | 'GDC.time.week_in_year' | 'GDC.time.week_in_quarter' | 'GDC.time.week' | 'GDC.time.euweek_in_year' | 'GDC.time.euweek_in_quarter' | 'GDC.time.quarter' | 'GDC.time.quarter_in_year' | 'GDC.time.month' | 'GDC.time.month_in_quarter' | 'GDC.time.month_in_year' | 'GDC.time.day_in_year' | 'GDC.time.day_in_quarter' | 'GDC.time.day_in_month' | 'GDC.time.day_in_week' | 'GDC.time.day_in_euweek' | 'GDC.time.date' | 'GDC.time.hour' | 'GDC.time.hour_in_day' | 'GDC.time.minute' | 'GDC.time.minute_in_hour' | 'GDC.time.fiscal_month' | 'GDC.time.fiscal_quarter' | 'GDC.time.fiscal_year';
|
|
1296
|
+
export type AutomationRelativeBoundedDateFilterGranularityEnum = 'ALL_TIME_GRANULARITY' | 'GDC.time.year' | 'GDC.time.week_us' | 'GDC.time.week_in_year' | 'GDC.time.week_in_quarter' | 'GDC.time.week' | 'GDC.time.euweek_in_year' | 'GDC.time.euweek_in_quarter' | 'GDC.time.quarter' | 'GDC.time.quarter_in_year' | 'GDC.time.month' | 'GDC.time.month_in_quarter' | 'GDC.time.month_in_year' | 'GDC.time.day_in_year' | 'GDC.time.day_in_quarter' | 'GDC.time.day_in_month' | 'GDC.time.day_in_week' | 'GDC.time.day_in_euweek' | 'GDC.time.date' | 'GDC.time.hour' | 'GDC.time.hour_in_day' | 'GDC.time.minute' | 'GDC.time.minute_in_hour' | 'GDC.time.minute_in_day' | 'GDC.time.second' | 'GDC.time.second_in_minute' | 'GDC.time.second_in_day' | 'GDC.time.fiscal_week' | 'GDC.time.fiscal_month' | 'GDC.time.fiscal_quarter' | 'GDC.time.fiscal_semester' | 'GDC.time.fiscal_year' | 'GDC.time.fiscal_day_in_fiscal_week' | 'GDC.time.fiscal_day_in_fiscal_month' | 'GDC.time.fiscal_day_in_fiscal_quarter' | 'GDC.time.fiscal_day_in_fiscal_semester' | 'GDC.time.fiscal_day_in_fiscal_year' | 'GDC.time.fiscal_week_in_fiscal_month' | 'GDC.time.fiscal_week_in_fiscal_quarter' | 'GDC.time.fiscal_week_in_fiscal_semester' | 'GDC.time.fiscal_week_in_fiscal_year' | 'GDC.time.fiscal_month_in_fiscal_quarter' | 'GDC.time.fiscal_month_in_fiscal_semester' | 'GDC.time.fiscal_month_in_fiscal_year' | 'GDC.time.fiscal_quarter_in_fiscal_semester' | 'GDC.time.fiscal_quarter_in_fiscal_year' | 'GDC.time.fiscal_semester_in_fiscal_year';
|
|
1258
1297
|
/**
|
|
1259
1298
|
* A date filter specifying a time interval that is relative to the current date. For example, last week, next month, and so on. Field dataset is representing qualifier of date dimension. The \'from\' and \'to\' properties mark the boundaries of the interval. If \'from\' is omitted, all values earlier than \'to\' are included. If \'to\' is omitted, all values later than \'from\' are included. It is not allowed to omit both.
|
|
1260
1299
|
*/
|
|
@@ -1262,29 +1301,29 @@ export interface AutomationRelativeDateFilter {
|
|
|
1262
1301
|
'relativeDateFilter': AutomationRelativeDateFilterRelativeDateFilter;
|
|
1263
1302
|
}
|
|
1264
1303
|
export interface AutomationRelativeDateFilterRelativeDateFilter {
|
|
1304
|
+
'applyOnResult'?: boolean;
|
|
1305
|
+
'boundedFilter'?: AutomationBoundedFilter;
|
|
1306
|
+
'dataset': AutomationAfmObjectIdentifierDataset;
|
|
1265
1307
|
/**
|
|
1266
|
-
*
|
|
1308
|
+
* Specifies how rows with empty (null/missing) date values should be handled. INCLUDE includes empty dates in addition to the date range restriction, EXCLUDE removes rows with empty dates (default), ONLY keeps only rows with empty dates.
|
|
1267
1309
|
*/
|
|
1268
|
-
'
|
|
1310
|
+
'emptyValueHandling'?: AutomationRelativeDateFilterRelativeDateFilterEmptyValueHandlingEnum;
|
|
1269
1311
|
/**
|
|
1270
1312
|
* Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for \'2 days/weeks, ... ago\').
|
|
1271
1313
|
*/
|
|
1272
1314
|
'from': number;
|
|
1273
1315
|
/**
|
|
1274
|
-
*
|
|
1316
|
+
* Date granularity specifying particular date attribute in given dimension.
|
|
1275
1317
|
*/
|
|
1276
|
-
'
|
|
1318
|
+
'granularity': AutomationRelativeDateFilterRelativeDateFilterGranularityEnum;
|
|
1277
1319
|
'localIdentifier'?: string;
|
|
1278
|
-
'applyOnResult'?: boolean;
|
|
1279
|
-
'boundedFilter'?: AutomationBoundedFilter;
|
|
1280
1320
|
/**
|
|
1281
|
-
*
|
|
1321
|
+
* End of the filtering interval. Specified by number of periods (with respect to given granularity). Value \'O\' is representing current time-interval (current day, week, ...).
|
|
1282
1322
|
*/
|
|
1283
|
-
'
|
|
1284
|
-
'dataset': AutomationAfmObjectIdentifierDataset;
|
|
1323
|
+
'to': number;
|
|
1285
1324
|
}
|
|
1286
|
-
export type AutomationRelativeDateFilterRelativeDateFilterGranularityEnum = 'MINUTE' | 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR' | 'MINUTE_OF_HOUR' | 'HOUR_OF_DAY' | 'DAY_OF_WEEK' | 'DAY_OF_MONTH' | 'DAY_OF_QUARTER' | 'DAY_OF_YEAR' | 'WEEK_OF_YEAR' | 'MONTH_OF_YEAR' | 'QUARTER_OF_YEAR' | 'FISCAL_MONTH' | 'FISCAL_QUARTER' | 'FISCAL_YEAR';
|
|
1287
1325
|
export type AutomationRelativeDateFilterRelativeDateFilterEmptyValueHandlingEnum = 'INCLUDE' | 'EXCLUDE' | 'ONLY';
|
|
1326
|
+
export type AutomationRelativeDateFilterRelativeDateFilterGranularityEnum = 'SECOND' | 'SECOND_OF_MINUTE' | 'SECOND_OF_DAY' | 'MINUTE' | 'MINUTE_OF_HOUR' | 'MINUTE_OF_DAY' | 'HOUR' | 'HOUR_OF_DAY' | 'DAY' | 'DAY_OF_WEEK' | 'DAY_OF_MONTH' | 'DAY_OF_QUARTER' | 'DAY_OF_YEAR' | 'WEEK' | 'WEEK_OF_YEAR' | 'MONTH' | 'MONTH_OF_YEAR' | 'QUARTER' | 'QUARTER_OF_YEAR' | 'YEAR' | 'FISCAL_DAY_OF_FISCAL_WEEK' | 'FISCAL_DAY_OF_FISCAL_MONTH' | 'FISCAL_DAY_OF_FISCAL_QUARTER' | 'FISCAL_DAY_OF_FISCAL_SEMESTER' | 'FISCAL_DAY_OF_FISCAL_YEAR' | 'FISCAL_WEEK' | 'FISCAL_WEEK_OF_FISCAL_MONTH' | 'FISCAL_WEEK_OF_FISCAL_QUARTER' | 'FISCAL_WEEK_OF_FISCAL_SEMESTER' | 'FISCAL_WEEK_OF_FISCAL_YEAR' | 'FISCAL_MONTH' | 'FISCAL_MONTH_OF_FISCAL_QUARTER' | 'FISCAL_MONTH_OF_FISCAL_SEMESTER' | 'FISCAL_MONTH_OF_FISCAL_YEAR' | 'FISCAL_QUARTER' | 'FISCAL_QUARTER_OF_FISCAL_SEMESTER' | 'FISCAL_QUARTER_OF_FISCAL_YEAR' | 'FISCAL_SEMESTER' | 'FISCAL_SEMESTER_OF_FISCAL_YEAR' | 'FISCAL_YEAR';
|
|
1288
1327
|
export interface AutomationRelativeWrapper {
|
|
1289
1328
|
'relative': AutomationRelative;
|
|
1290
1329
|
}
|
|
@@ -1292,19 +1331,30 @@ export interface AutomationRelativeWrapper {
|
|
|
1292
1331
|
* Additional settings.
|
|
1293
1332
|
*/
|
|
1294
1333
|
export interface AutomationSettings {
|
|
1334
|
+
/**
|
|
1335
|
+
* Set column delimiter. (CSV)
|
|
1336
|
+
*/
|
|
1337
|
+
'delimiter'?: string;
|
|
1295
1338
|
/**
|
|
1296
1339
|
* If true, the export will contain the information about the export – exported date, filters, etc. Works only with `visualizationObject`. (XLSX, PDF)
|
|
1297
1340
|
*/
|
|
1298
1341
|
'exportInfo'?: boolean;
|
|
1342
|
+
/**
|
|
1343
|
+
* Grand totals position. Takes precedence over position specified in visualization.
|
|
1344
|
+
*/
|
|
1345
|
+
'grandTotalsPosition'?: AutomationSettingsGrandTotalsPositionEnum;
|
|
1299
1346
|
/**
|
|
1300
1347
|
* Merge equal headers in neighbouring cells. (XLSX)
|
|
1301
1348
|
*/
|
|
1302
1349
|
'mergeHeaders'?: boolean;
|
|
1303
1350
|
/**
|
|
1304
|
-
*
|
|
1305
|
-
* @deprecated
|
|
1351
|
+
* Set page orientation. (PDF)
|
|
1306
1352
|
*/
|
|
1307
|
-
'
|
|
1353
|
+
'pageOrientation'?: AutomationSettingsPageOrientationEnum;
|
|
1354
|
+
/**
|
|
1355
|
+
* Set page size. (PDF)
|
|
1356
|
+
*/
|
|
1357
|
+
'pageSize'?: AutomationSettingsPageSizeEnum;
|
|
1308
1358
|
/**
|
|
1309
1359
|
* Page size and orientation. (PDF)
|
|
1310
1360
|
* @deprecated
|
|
@@ -1326,25 +1376,14 @@ export interface AutomationSettings {
|
|
|
1326
1376
|
*/
|
|
1327
1377
|
'pdfTopRightContent'?: string;
|
|
1328
1378
|
/**
|
|
1329
|
-
*
|
|
1330
|
-
|
|
1331
|
-
'pageSize'?: AutomationSettingsPageSizeEnum;
|
|
1332
|
-
/**
|
|
1333
|
-
* Set page orientation. (PDF)
|
|
1334
|
-
*/
|
|
1335
|
-
'pageOrientation'?: AutomationSettingsPageOrientationEnum;
|
|
1336
|
-
/**
|
|
1337
|
-
* Set column delimiter. (CSV)
|
|
1338
|
-
*/
|
|
1339
|
-
'delimiter'?: string;
|
|
1340
|
-
/**
|
|
1341
|
-
* Grand totals position. Takes precedence over position specified in visualization.
|
|
1379
|
+
* Print applied filters on top of the document. (PDF/HTML when visualizationObject is given)
|
|
1380
|
+
* @deprecated
|
|
1342
1381
|
*/
|
|
1343
|
-
'
|
|
1382
|
+
'showFilters'?: boolean;
|
|
1344
1383
|
}
|
|
1345
|
-
export type AutomationSettingsPageSizeEnum = 'A3' | 'A4' | 'LETTER';
|
|
1346
|
-
export type AutomationSettingsPageOrientationEnum = 'PORTRAIT' | 'LANDSCAPE';
|
|
1347
1384
|
export type AutomationSettingsGrandTotalsPositionEnum = 'pinnedBottom' | 'pinnedTop' | 'bottom' | 'top';
|
|
1385
|
+
export type AutomationSettingsPageOrientationEnum = 'PORTRAIT' | 'LANDSCAPE';
|
|
1386
|
+
export type AutomationSettingsPageSizeEnum = 'A3' | 'A4' | 'LETTER';
|
|
1348
1387
|
/**
|
|
1349
1388
|
* Metric defined by referencing a MAQL metric or an LDM fact object with aggregation.
|
|
1350
1389
|
*/
|
|
@@ -1352,7 +1391,6 @@ export interface AutomationSimpleMeasureDefinition {
|
|
|
1352
1391
|
'measure': AutomationSimpleMeasureDefinitionMeasure;
|
|
1353
1392
|
}
|
|
1354
1393
|
export interface AutomationSimpleMeasureDefinitionMeasure {
|
|
1355
|
-
'item': AutomationAfmObjectIdentifierCore;
|
|
1356
1394
|
/**
|
|
1357
1395
|
* Definition of aggregation type of the metric.
|
|
1358
1396
|
*/
|
|
@@ -1365,32 +1403,25 @@ export interface AutomationSimpleMeasureDefinitionMeasure {
|
|
|
1365
1403
|
* Metrics can be filtered by attribute filters with the same interface as ones for global AFM. Note that only one DateFilter is allowed.
|
|
1366
1404
|
*/
|
|
1367
1405
|
'filters'?: Array<AutomationFilterDefinitionForSimpleMeasure>;
|
|
1406
|
+
'item': AutomationAfmObjectIdentifierCore;
|
|
1368
1407
|
}
|
|
1369
1408
|
export type AutomationSimpleMeasureDefinitionMeasureAggregationEnum = 'SUM' | 'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'MEDIAN' | 'RUNSUM' | 'APPROXIMATE_COUNT';
|
|
1370
1409
|
/**
|
|
1371
1410
|
* Export request object describing the export properties and metadata for slides exports.
|
|
1372
1411
|
*/
|
|
1373
1412
|
export interface AutomationSlidesExportRequest {
|
|
1374
|
-
/**
|
|
1375
|
-
* Requested resulting file type.
|
|
1376
|
-
*/
|
|
1377
|
-
'format': AutomationSlidesExportRequestFormatEnum;
|
|
1378
|
-
/**
|
|
1379
|
-
* File name to be used for retrieving the pdf document.
|
|
1380
|
-
*/
|
|
1381
|
-
'fileName': string;
|
|
1382
1413
|
/**
|
|
1383
1414
|
* Dashboard identifier
|
|
1384
1415
|
*/
|
|
1385
1416
|
'dashboardId'?: string;
|
|
1386
1417
|
/**
|
|
1387
|
-
*
|
|
1418
|
+
* File name to be used for retrieving the pdf document.
|
|
1388
1419
|
*/
|
|
1389
|
-
'
|
|
1420
|
+
'fileName': string;
|
|
1390
1421
|
/**
|
|
1391
|
-
*
|
|
1422
|
+
* Requested resulting file type.
|
|
1392
1423
|
*/
|
|
1393
|
-
'
|
|
1424
|
+
'format': AutomationSlidesExportRequestFormatEnum;
|
|
1394
1425
|
/**
|
|
1395
1426
|
* Metadata definition in free-form JSON format.
|
|
1396
1427
|
*/
|
|
@@ -1399,6 +1430,14 @@ export interface AutomationSlidesExportRequest {
|
|
|
1399
1430
|
* Export template identifier.
|
|
1400
1431
|
*/
|
|
1401
1432
|
'templateId'?: string | null;
|
|
1433
|
+
/**
|
|
1434
|
+
* List of visualization ids to be exported. Note that only one visualization is currently supported.
|
|
1435
|
+
*/
|
|
1436
|
+
'visualizationIds'?: Array<string>;
|
|
1437
|
+
/**
|
|
1438
|
+
* List of widget identifiers to be exported. Note that only one widget is currently supported.
|
|
1439
|
+
*/
|
|
1440
|
+
'widgetIds'?: Array<string>;
|
|
1402
1441
|
}
|
|
1403
1442
|
export type AutomationSlidesExportRequestFormatEnum = 'PDF' | 'PPTX';
|
|
1404
1443
|
/**
|
|
@@ -1417,22 +1456,22 @@ export interface AutomationSmtp {
|
|
|
1417
1456
|
* The SMTP server address.
|
|
1418
1457
|
*/
|
|
1419
1458
|
'host'?: string;
|
|
1420
|
-
/**
|
|
1421
|
-
* The SMTP server port.
|
|
1422
|
-
*/
|
|
1423
|
-
'port'?: AutomationSmtpPortEnum;
|
|
1424
|
-
/**
|
|
1425
|
-
* The SMTP server username.
|
|
1426
|
-
*/
|
|
1427
|
-
'username'?: string;
|
|
1428
1459
|
/**
|
|
1429
1460
|
* The SMTP server password.
|
|
1430
1461
|
*/
|
|
1431
1462
|
'password'?: string;
|
|
1463
|
+
/**
|
|
1464
|
+
* The SMTP server port.
|
|
1465
|
+
*/
|
|
1466
|
+
'port'?: AutomationSmtpPortEnum;
|
|
1432
1467
|
/**
|
|
1433
1468
|
* The destination type.
|
|
1434
1469
|
*/
|
|
1435
1470
|
'type': AutomationSmtpTypeEnum;
|
|
1471
|
+
/**
|
|
1472
|
+
* The SMTP server username.
|
|
1473
|
+
*/
|
|
1474
|
+
'username'?: string;
|
|
1436
1475
|
}
|
|
1437
1476
|
export type AutomationSmtpPortEnum = 25 | 465 | 587 | 2525;
|
|
1438
1477
|
export type AutomationSmtpTypeEnum = 'SMTP';
|
|
@@ -1440,6 +1479,7 @@ export type AutomationSmtpTypeEnum = 'SMTP';
|
|
|
1440
1479
|
* A single pre-executed layer in a multi-layer tabular export.
|
|
1441
1480
|
*/
|
|
1442
1481
|
export interface AutomationTabularExportExecution {
|
|
1482
|
+
'customOverride'?: AutomationCustomOverride;
|
|
1443
1483
|
/**
|
|
1444
1484
|
* Execution result identifier for this layer.
|
|
1445
1485
|
*/
|
|
@@ -1448,26 +1488,37 @@ export interface AutomationTabularExportExecution {
|
|
|
1448
1488
|
* Layer title used for the exported sheet or file name.
|
|
1449
1489
|
*/
|
|
1450
1490
|
'title'?: string;
|
|
1451
|
-
'customOverride'?: AutomationCustomOverride;
|
|
1452
1491
|
}
|
|
1453
1492
|
/**
|
|
1454
1493
|
* Export request object describing the export properties and overrides for tabular exports.
|
|
1455
1494
|
*/
|
|
1456
1495
|
export interface AutomationTabularExportRequest {
|
|
1457
|
-
|
|
1458
|
-
* Expected file format.
|
|
1459
|
-
*/
|
|
1460
|
-
'format': AutomationTabularExportRequestFormatEnum;
|
|
1496
|
+
'customOverride'?: AutomationCustomOverride;
|
|
1461
1497
|
/**
|
|
1462
1498
|
* Execution result identifier.
|
|
1463
1499
|
*/
|
|
1464
1500
|
'executionResult'?: string;
|
|
1501
|
+
/**
|
|
1502
|
+
* Pre-executed layers for multi-layer geo visualizations. When provided, this is the canonical source of the exported layers and takes precedence over the top-level executionResult and customOverride, which are ignored. Index 0 is the main layer; each layer carries its own executionResult and customOverride.
|
|
1503
|
+
*/
|
|
1504
|
+
'executions'?: Array<AutomationTabularExportExecution>;
|
|
1465
1505
|
/**
|
|
1466
1506
|
* Filename of downloaded file without extension.
|
|
1467
1507
|
*/
|
|
1468
1508
|
'fileName': string;
|
|
1509
|
+
/**
|
|
1510
|
+
* Expected file format.
|
|
1511
|
+
*/
|
|
1512
|
+
'format': AutomationTabularExportRequestFormatEnum;
|
|
1513
|
+
/**
|
|
1514
|
+
* Metadata definition in free-form JSON format.
|
|
1515
|
+
*/
|
|
1516
|
+
'metadata'?: object | null;
|
|
1517
|
+
/**
|
|
1518
|
+
* Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.
|
|
1519
|
+
*/
|
|
1520
|
+
'relatedDashboardId'?: string;
|
|
1469
1521
|
'settings'?: AutomationSettings;
|
|
1470
|
-
'customOverride'?: AutomationCustomOverride;
|
|
1471
1522
|
/**
|
|
1472
1523
|
* Visualization object identifier. Alternative to executionResult property.
|
|
1473
1524
|
*/
|
|
@@ -1480,18 +1531,6 @@ export interface AutomationTabularExportRequest {
|
|
|
1480
1531
|
* Optional custom parameters to be applied when visualizationObject is given. Those parameters override the original parameters defined in the visualization.
|
|
1481
1532
|
*/
|
|
1482
1533
|
'visualizationObjectCustomParameters'?: Array<AutomationParameterValue>;
|
|
1483
|
-
/**
|
|
1484
|
-
* Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.
|
|
1485
|
-
*/
|
|
1486
|
-
'relatedDashboardId'?: string;
|
|
1487
|
-
/**
|
|
1488
|
-
* Metadata definition in free-form JSON format.
|
|
1489
|
-
*/
|
|
1490
|
-
'metadata'?: object | null;
|
|
1491
|
-
/**
|
|
1492
|
-
* Pre-executed layers for multi-layer geo visualizations. When provided, this is the canonical source of the exported layers and takes precedence over the top-level executionResult and customOverride, which are ignored. Index 0 is the main layer; each layer carries its own executionResult and customOverride.
|
|
1493
|
-
*/
|
|
1494
|
-
'executions'?: Array<AutomationTabularExportExecution>;
|
|
1495
1534
|
}
|
|
1496
1535
|
export type AutomationTabularExportRequestFormatEnum = 'CSV' | 'XLSX' | 'HTML' | 'PDF';
|
|
1497
1536
|
/**
|
|
@@ -1515,14 +1554,14 @@ export interface AutomationTestNotification extends AutomationNotificationConten
|
|
|
1515
1554
|
* Response from notification channel testing.
|
|
1516
1555
|
*/
|
|
1517
1556
|
export interface AutomationTestResponse {
|
|
1518
|
-
/**
|
|
1519
|
-
* A flag indicating whether test passed or not.
|
|
1520
|
-
*/
|
|
1521
|
-
'successful': boolean;
|
|
1522
1557
|
/**
|
|
1523
1558
|
* Field containing more details in case of a failure. Details are available to a privileged user only.
|
|
1524
1559
|
*/
|
|
1525
1560
|
'error'?: string;
|
|
1561
|
+
/**
|
|
1562
|
+
* A flag indicating whether test passed or not.
|
|
1563
|
+
*/
|
|
1564
|
+
'successful': boolean;
|
|
1526
1565
|
}
|
|
1527
1566
|
export interface AutomationTriggerAutomationRequest {
|
|
1528
1567
|
'automation': AutomationAdHocAutomation;
|
|
@@ -1534,25 +1573,25 @@ export interface AutomationValue {
|
|
|
1534
1573
|
'value': number;
|
|
1535
1574
|
}
|
|
1536
1575
|
export interface AutomationVisibleFilter {
|
|
1537
|
-
'localIdentifier'?: string;
|
|
1538
|
-
'title'?: string;
|
|
1539
1576
|
/**
|
|
1540
1577
|
* Indicates if the filter is an all-time date filter. Such a filter is not included in report computation, so there is no filter with the same \'localIdentifier\' to be found. In such cases, this flag is used to inform the server to not search for the filter in the definitions and include it anyways.
|
|
1541
1578
|
*/
|
|
1542
1579
|
'isAllTimeDateFilter'?: boolean;
|
|
1580
|
+
'localIdentifier'?: string;
|
|
1581
|
+
'title'?: string;
|
|
1543
1582
|
}
|
|
1544
1583
|
/**
|
|
1545
1584
|
* Export request object describing the export properties and metadata for dashboard PDF exports.
|
|
1546
1585
|
*/
|
|
1547
1586
|
export interface AutomationVisualExportRequest {
|
|
1548
|
-
/**
|
|
1549
|
-
* File name to be used for retrieving the pdf document.
|
|
1550
|
-
*/
|
|
1551
|
-
'fileName': string;
|
|
1552
1587
|
/**
|
|
1553
1588
|
* Dashboard identifier
|
|
1554
1589
|
*/
|
|
1555
1590
|
'dashboardId': string;
|
|
1591
|
+
/**
|
|
1592
|
+
* File name to be used for retrieving the pdf document.
|
|
1593
|
+
*/
|
|
1594
|
+
'fileName': string;
|
|
1556
1595
|
/**
|
|
1557
1596
|
* Metadata definition in free-form JSON format.
|
|
1558
1597
|
*/
|
|
@@ -1563,13 +1602,9 @@ export interface AutomationVisualExportRequest {
|
|
|
1563
1602
|
*/
|
|
1564
1603
|
export interface AutomationWebhook {
|
|
1565
1604
|
/**
|
|
1566
|
-
*
|
|
1567
|
-
*/
|
|
1568
|
-
'url'?: string;
|
|
1569
|
-
/**
|
|
1570
|
-
* Bearer token for the webhook.
|
|
1605
|
+
* Flag indicating if webhook has a hmac secret key.
|
|
1571
1606
|
*/
|
|
1572
|
-
'
|
|
1607
|
+
'hasSecretKey'?: boolean | null;
|
|
1573
1608
|
/**
|
|
1574
1609
|
* Flag indicating if webhook has a token.
|
|
1575
1610
|
*/
|
|
@@ -1579,48 +1614,52 @@ export interface AutomationWebhook {
|
|
|
1579
1614
|
*/
|
|
1580
1615
|
'secretKey'?: string | null;
|
|
1581
1616
|
/**
|
|
1582
|
-
*
|
|
1617
|
+
* Bearer token for the webhook.
|
|
1583
1618
|
*/
|
|
1584
|
-
'
|
|
1619
|
+
'token'?: string | null;
|
|
1585
1620
|
/**
|
|
1586
1621
|
* The destination type.
|
|
1587
1622
|
*/
|
|
1588
1623
|
'type': AutomationWebhookTypeEnum;
|
|
1624
|
+
/**
|
|
1625
|
+
* The webhook URL.
|
|
1626
|
+
*/
|
|
1627
|
+
'url'?: string;
|
|
1589
1628
|
}
|
|
1590
1629
|
export type AutomationWebhookTypeEnum = 'WEBHOOK';
|
|
1591
1630
|
export interface AutomationWebhookAutomationInfo {
|
|
1592
|
-
'id': string;
|
|
1593
|
-
'title'?: string;
|
|
1594
1631
|
'dashboardTitle'?: string;
|
|
1595
1632
|
'dashboardURL': string;
|
|
1633
|
+
'id': string;
|
|
1596
1634
|
'isCustomDashboardURL': boolean;
|
|
1635
|
+
'title'?: string;
|
|
1597
1636
|
}
|
|
1598
1637
|
export interface AutomationWebhookMessage {
|
|
1599
|
-
'timestamp': string;
|
|
1600
1638
|
'data': AutomationWebhookMessageData;
|
|
1639
|
+
'timestamp': string;
|
|
1601
1640
|
'type': AutomationWebhookMessageTypeEnum;
|
|
1602
1641
|
}
|
|
1603
1642
|
export type AutomationWebhookMessageTypeEnum = 'automation-task.completed' | 'automation-task.limit-exceeded';
|
|
1604
1643
|
export interface AutomationWebhookMessageData {
|
|
1644
|
+
'alert'?: AutomationAlertDescription;
|
|
1605
1645
|
'automation': AutomationWebhookAutomationInfo;
|
|
1606
|
-
'
|
|
1646
|
+
'dashboardTabularExports'?: Array<AutomationExportResult>;
|
|
1607
1647
|
'details'?: {
|
|
1608
1648
|
[key: string]: string;
|
|
1609
1649
|
};
|
|
1610
|
-
'
|
|
1611
|
-
'tabularExports'?: Array<AutomationExportResult>;
|
|
1612
|
-
'visualExports'?: Array<AutomationExportResult>;
|
|
1650
|
+
'filters'?: Array<AutomationNotificationFilter>;
|
|
1613
1651
|
'imageExports'?: Array<AutomationExportResult>;
|
|
1652
|
+
'notificationSource'?: string;
|
|
1614
1653
|
'rawExports'?: Array<AutomationExportResult>;
|
|
1654
|
+
'recipients'?: Array<AutomationWebhookRecipient>;
|
|
1655
|
+
'remainingActionCount'?: number;
|
|
1615
1656
|
'slidesExports'?: Array<AutomationExportResult>;
|
|
1616
|
-
'
|
|
1617
|
-
'
|
|
1618
|
-
'filters'?: Array<AutomationNotificationFilter>;
|
|
1619
|
-
'notificationSource'?: string;
|
|
1657
|
+
'tabularExports'?: Array<AutomationExportResult>;
|
|
1658
|
+
'visualExports'?: Array<AutomationExportResult>;
|
|
1620
1659
|
}
|
|
1621
1660
|
export interface AutomationWebhookRecipient {
|
|
1622
|
-
'id': string;
|
|
1623
1661
|
'email': string;
|
|
1662
|
+
'id': string;
|
|
1624
1663
|
}
|
|
1625
1664
|
/**
|
|
1626
1665
|
* Get latest in-platform notifications for the current user.
|