@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 ExportAFM {
|
|
|
20
20
|
* Attributes to be used in the computation.
|
|
21
21
|
*/
|
|
22
22
|
'attributes': Array<ExportAttributeItem>;
|
|
23
|
+
/**
|
|
24
|
+
* Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.
|
|
25
|
+
*/
|
|
26
|
+
'auxMeasures'?: Array<ExportMeasureItem>;
|
|
23
27
|
/**
|
|
24
28
|
* Various filter types to filter the execution result.
|
|
25
29
|
*/
|
|
26
30
|
'filters': Array<ExportFilterDefinition>;
|
|
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<ExportMetricDefinitionOverride>;
|
|
31
35
|
/**
|
|
32
|
-
* Metrics to be
|
|
36
|
+
* Metrics to be computed.
|
|
33
37
|
*/
|
|
34
|
-
'
|
|
38
|
+
'measures': Array<ExportMeasureItem>;
|
|
35
39
|
/**
|
|
36
40
|
* (EXPERIMENTAL) Parameter values to use for this execution.
|
|
37
41
|
*/
|
|
38
42
|
'parameters'?: Array<ExportParameterItem>;
|
|
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<ExportMetricDefinitionOverride>;
|
|
43
43
|
}
|
|
44
44
|
/**
|
|
45
45
|
* A datetime filter specifying exact from and to values.
|
|
@@ -48,17 +48,46 @@ export interface ExportAbsoluteDateFilter {
|
|
|
48
48
|
'absoluteDateFilter': ExportAbsoluteDateFilterAbsoluteDateFilter;
|
|
49
49
|
}
|
|
50
50
|
export interface ExportAbsoluteDateFilterAbsoluteDateFilter {
|
|
51
|
-
'from': string;
|
|
52
|
-
'to': string;
|
|
53
|
-
'localIdentifier'?: string;
|
|
54
51
|
'applyOnResult'?: boolean;
|
|
52
|
+
'dataset': ExportAfmObjectIdentifierDataset;
|
|
55
53
|
/**
|
|
56
54
|
* 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.
|
|
57
55
|
*/
|
|
58
56
|
'emptyValueHandling'?: ExportAbsoluteDateFilterAbsoluteDateFilterEmptyValueHandlingEnum;
|
|
59
|
-
'
|
|
57
|
+
'from': string;
|
|
58
|
+
'localIdentifier'?: string;
|
|
59
|
+
'to': string;
|
|
60
60
|
}
|
|
61
61
|
export type ExportAbsoluteDateFilterAbsoluteDateFilterEmptyValueHandlingEnum = 'INCLUDE' | 'EXCLUDE' | 'ONLY';
|
|
62
|
+
/**
|
|
63
|
+
* 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.
|
|
64
|
+
*/
|
|
65
|
+
export interface ExportAbsoluteGranularityDateFilter {
|
|
66
|
+
'absoluteGranularityDateFilter': ExportAbsoluteGranularityDateFilterAbsoluteGranularityDateFilter;
|
|
67
|
+
}
|
|
68
|
+
export interface ExportAbsoluteGranularityDateFilterAbsoluteGranularityDateFilter {
|
|
69
|
+
'applyOnResult'?: boolean;
|
|
70
|
+
'dataset': ExportAfmObjectIdentifierDataset;
|
|
71
|
+
/**
|
|
72
|
+
* 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.
|
|
73
|
+
*/
|
|
74
|
+
'emptyValueHandling'?: ExportAbsoluteGranularityDateFilterAbsoluteGranularityDateFilterEmptyValueHandlingEnum;
|
|
75
|
+
/**
|
|
76
|
+
* Start of the range (including), in the format matching \'granularity\'. If omitted, the range is unbounded at the start.
|
|
77
|
+
*/
|
|
78
|
+
'from'?: string | null;
|
|
79
|
+
/**
|
|
80
|
+
* Granularity determining the filtered date attribute and the expected \'from\'/\'to\' format.
|
|
81
|
+
*/
|
|
82
|
+
'granularity': ExportAbsoluteGranularityDateFilterAbsoluteGranularityDateFilterGranularityEnum;
|
|
83
|
+
'localIdentifier'?: string;
|
|
84
|
+
/**
|
|
85
|
+
* End of the range (including), in the format matching \'granularity\'. If omitted, the range is unbounded at the end.
|
|
86
|
+
*/
|
|
87
|
+
'to'?: string | null;
|
|
88
|
+
}
|
|
89
|
+
export type ExportAbsoluteGranularityDateFilterAbsoluteGranularityDateFilterEmptyValueHandlingEnum = 'INCLUDE' | 'EXCLUDE' | 'ONLY';
|
|
90
|
+
export type ExportAbsoluteGranularityDateFilterAbsoluteGranularityDateFilterGranularityEnum = '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';
|
|
62
91
|
/**
|
|
63
92
|
* @type ExportAbstractMeasureValueFilter
|
|
64
93
|
*/
|
|
@@ -111,16 +140,16 @@ export interface ExportAfmObjectIdentifierDatasetIdentifier {
|
|
|
111
140
|
}
|
|
112
141
|
export type ExportAfmObjectIdentifierDatasetIdentifierTypeEnum = 'dataset';
|
|
113
142
|
export interface ExportAfmObjectIdentifierIdentifier {
|
|
114
|
-
'type': ExportAfmObjectIdentifierIdentifierTypeEnum;
|
|
115
143
|
'id': string;
|
|
144
|
+
'type': ExportAfmObjectIdentifierIdentifierTypeEnum;
|
|
116
145
|
}
|
|
117
146
|
export type ExportAfmObjectIdentifierIdentifierTypeEnum = 'analyticalDashboard' | 'attribute' | 'dashboardPlugin' | 'dataset' | 'fact' | 'label' | 'metric' | 'prompt' | 'visualizationObject' | 'filterContext';
|
|
118
147
|
export interface ExportAfmObjectIdentifierLabel {
|
|
119
148
|
'identifier': ExportAfmObjectIdentifierLabelIdentifier;
|
|
120
149
|
}
|
|
121
150
|
export interface ExportAfmObjectIdentifierLabelIdentifier {
|
|
122
|
-
'type': ExportAfmObjectIdentifierLabelIdentifierTypeEnum;
|
|
123
151
|
'id': string;
|
|
152
|
+
'type': ExportAfmObjectIdentifierLabelIdentifierTypeEnum;
|
|
124
153
|
}
|
|
125
154
|
export type ExportAfmObjectIdentifierLabelIdentifierTypeEnum = 'label';
|
|
126
155
|
/**
|
|
@@ -141,6 +170,8 @@ export interface ExportAllTimeDateFilter {
|
|
|
141
170
|
'allTimeDateFilter': ExportAllTimeDateFilterAllTimeDateFilter;
|
|
142
171
|
}
|
|
143
172
|
export interface ExportAllTimeDateFilterAllTimeDateFilter {
|
|
173
|
+
'applyOnResult'?: boolean;
|
|
174
|
+
'dataset': ExportAfmObjectIdentifierDataset;
|
|
144
175
|
/**
|
|
145
176
|
* 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.
|
|
146
177
|
*/
|
|
@@ -150,11 +181,9 @@ export interface ExportAllTimeDateFilterAllTimeDateFilter {
|
|
|
150
181
|
*/
|
|
151
182
|
'granularity'?: ExportAllTimeDateFilterAllTimeDateFilterGranularityEnum;
|
|
152
183
|
'localIdentifier'?: string;
|
|
153
|
-
'applyOnResult'?: boolean;
|
|
154
|
-
'dataset': ExportAfmObjectIdentifierDataset;
|
|
155
184
|
}
|
|
156
185
|
export type ExportAllTimeDateFilterAllTimeDateFilterEmptyValueHandlingEnum = 'INCLUDE' | 'EXCLUDE' | 'ONLY';
|
|
157
|
-
export type ExportAllTimeDateFilterAllTimeDateFilterGranularityEnum = '
|
|
186
|
+
export type ExportAllTimeDateFilterAllTimeDateFilterGranularityEnum = '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';
|
|
158
187
|
/**
|
|
159
188
|
* Metric representing arithmetics between other metrics.
|
|
160
189
|
*/
|
|
@@ -211,11 +240,11 @@ export interface ExportAttributeFilterParent {
|
|
|
211
240
|
'over': ExportOver;
|
|
212
241
|
}
|
|
213
242
|
export interface ExportAttributeItem {
|
|
243
|
+
'label': ExportAfmObjectIdentifierLabel;
|
|
214
244
|
/**
|
|
215
245
|
* Local identifier of the attribute. This can be used to reference the attribute in other parts of the execution definition.
|
|
216
246
|
*/
|
|
217
247
|
'localIdentifier': string;
|
|
218
|
-
'label': ExportAfmObjectIdentifierLabel;
|
|
219
248
|
/**
|
|
220
249
|
* Indicates whether to show all values of given attribute even if the data bound to those values is not available.
|
|
221
250
|
*/
|
|
@@ -225,20 +254,20 @@ export interface ExportAttributeItem {
|
|
|
225
254
|
* 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.
|
|
226
255
|
*/
|
|
227
256
|
export interface ExportBoundedFilter {
|
|
228
|
-
/**
|
|
229
|
-
* Date granularity specifying particular date attribute in given dimension.
|
|
230
|
-
*/
|
|
231
|
-
'granularity': ExportBoundedFilterGranularityEnum;
|
|
232
257
|
/**
|
|
233
258
|
* 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.
|
|
234
259
|
*/
|
|
235
260
|
'from'?: number | null;
|
|
261
|
+
/**
|
|
262
|
+
* Date granularity specifying particular date attribute in given dimension.
|
|
263
|
+
*/
|
|
264
|
+
'granularity': ExportBoundedFilterGranularityEnum;
|
|
236
265
|
/**
|
|
237
266
|
* 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.
|
|
238
267
|
*/
|
|
239
268
|
'to'?: number | null;
|
|
240
269
|
}
|
|
241
|
-
export type ExportBoundedFilterGranularityEnum = '
|
|
270
|
+
export type ExportBoundedFilterGranularityEnum = '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';
|
|
242
271
|
/**
|
|
243
272
|
* Condition that compares the metric value to a given constant value using a comparison operator.
|
|
244
273
|
*/
|
|
@@ -257,19 +286,19 @@ export interface ExportComparisonMeasureValueFilter {
|
|
|
257
286
|
'comparisonMeasureValueFilter': ExportComparisonMeasureValueFilterComparisonMeasureValueFilter;
|
|
258
287
|
}
|
|
259
288
|
export interface ExportComparisonMeasureValueFilterComparisonMeasureValueFilter {
|
|
289
|
+
'applyOnResult'?: boolean;
|
|
260
290
|
/**
|
|
261
291
|
* References to the attributes to be used when filtering.
|
|
262
292
|
*/
|
|
263
293
|
'dimensionality'?: Array<ExportAfmIdentifier>;
|
|
294
|
+
'localIdentifier'?: string;
|
|
295
|
+
'measure': ExportAfmIdentifier;
|
|
296
|
+
'operator': ExportComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum;
|
|
264
297
|
/**
|
|
265
298
|
* A value that will be substituted for null values in the metric for the comparisons.
|
|
266
299
|
*/
|
|
267
300
|
'treatNullValuesAs'?: number;
|
|
268
|
-
'operator': ExportComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum;
|
|
269
301
|
'value': number;
|
|
270
|
-
'localIdentifier'?: string;
|
|
271
|
-
'applyOnResult'?: boolean;
|
|
272
|
-
'measure': ExportAfmIdentifier;
|
|
273
302
|
}
|
|
274
303
|
export type ExportComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum = 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'EQUAL_TO' | 'NOT_EQUAL_TO';
|
|
275
304
|
/**
|
|
@@ -279,21 +308,21 @@ export interface ExportCompoundMeasureValueFilter {
|
|
|
279
308
|
'compoundMeasureValueFilter': ExportCompoundMeasureValueFilterCompoundMeasureValueFilter;
|
|
280
309
|
}
|
|
281
310
|
export interface ExportCompoundMeasureValueFilterCompoundMeasureValueFilter {
|
|
311
|
+
'applyOnResult'?: boolean;
|
|
312
|
+
/**
|
|
313
|
+
* 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.
|
|
314
|
+
*/
|
|
315
|
+
'conditions': Array<ExportMeasureValueCondition>;
|
|
282
316
|
/**
|
|
283
317
|
* References to the attributes to be used when filtering.
|
|
284
318
|
*/
|
|
285
319
|
'dimensionality'?: Array<ExportAfmIdentifier>;
|
|
320
|
+
'localIdentifier'?: string;
|
|
321
|
+
'measure': ExportAfmIdentifier;
|
|
286
322
|
/**
|
|
287
323
|
* A value that will be substituted for null values in the metric for the comparisons.
|
|
288
324
|
*/
|
|
289
325
|
'treatNullValuesAs'?: number;
|
|
290
|
-
/**
|
|
291
|
-
* 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.
|
|
292
|
-
*/
|
|
293
|
-
'conditions': Array<ExportMeasureValueCondition>;
|
|
294
|
-
'localIdentifier'?: string;
|
|
295
|
-
'applyOnResult'?: boolean;
|
|
296
|
-
'measure': ExportAfmIdentifier;
|
|
297
326
|
}
|
|
298
327
|
/**
|
|
299
328
|
* Custom label object override.
|
|
@@ -308,14 +337,14 @@ export interface ExportCustomLabel {
|
|
|
308
337
|
* Custom metric object override.
|
|
309
338
|
*/
|
|
310
339
|
export interface ExportCustomMetric {
|
|
311
|
-
/**
|
|
312
|
-
* Metric title override.
|
|
313
|
-
*/
|
|
314
|
-
'title': string;
|
|
315
340
|
/**
|
|
316
341
|
* Format override.
|
|
317
342
|
*/
|
|
318
343
|
'format': string;
|
|
344
|
+
/**
|
|
345
|
+
* Metric title override.
|
|
346
|
+
*/
|
|
347
|
+
'title': string;
|
|
319
348
|
}
|
|
320
349
|
/**
|
|
321
350
|
* Custom cell value overrides (IDs will be replaced with specified values).
|
|
@@ -339,27 +368,27 @@ export interface ExportDashboardArbitraryAttributeFilter {
|
|
|
339
368
|
}
|
|
340
369
|
export interface ExportDashboardArbitraryAttributeFilterArbitraryAttributeFilter {
|
|
341
370
|
'displayForm': ExportIdentifierRef;
|
|
342
|
-
'values': Array<string>;
|
|
343
|
-
'negativeSelection': boolean;
|
|
344
371
|
'filterElementsBy'?: Array<ExportAttributeFilterParent>;
|
|
345
372
|
'filterElementsByDate'?: Array<ExportAttributeFilterByDate>;
|
|
346
|
-
'validateElementsBy'?: Array<ExportIdentifierRef>;
|
|
347
|
-
'title'?: string;
|
|
348
373
|
'localIdentifier'?: string;
|
|
374
|
+
'negativeSelection': boolean;
|
|
375
|
+
'title'?: string;
|
|
376
|
+
'validateElementsBy'?: Array<ExportIdentifierRef>;
|
|
377
|
+
'values': Array<string>;
|
|
349
378
|
}
|
|
350
379
|
export interface ExportDashboardAttributeFilter {
|
|
351
380
|
'attributeFilter': ExportDashboardAttributeFilterAttributeFilter;
|
|
352
381
|
}
|
|
353
382
|
export interface ExportDashboardAttributeFilterAttributeFilter {
|
|
354
|
-
'displayForm': ExportIdentifierRef;
|
|
355
|
-
'negativeSelection': boolean;
|
|
356
383
|
'attributeElements': ExportAttributeElements;
|
|
384
|
+
'displayForm': ExportIdentifierRef;
|
|
357
385
|
'filterElementsBy'?: Array<ExportAttributeFilterParent>;
|
|
358
386
|
'filterElementsByDate'?: Array<ExportAttributeFilterByDate>;
|
|
359
|
-
'validateElementsBy'?: Array<ExportIdentifierRef>;
|
|
360
|
-
'title'?: string;
|
|
361
|
-
'selectionMode'?: ExportDashboardAttributeFilterAttributeFilterSelectionModeEnum;
|
|
362
387
|
'localIdentifier'?: string;
|
|
388
|
+
'negativeSelection': boolean;
|
|
389
|
+
'selectionMode'?: ExportDashboardAttributeFilterAttributeFilterSelectionModeEnum;
|
|
390
|
+
'title'?: string;
|
|
391
|
+
'validateElementsBy'?: Array<ExportIdentifierRef>;
|
|
363
392
|
}
|
|
364
393
|
export type ExportDashboardAttributeFilterAttributeFilterSelectionModeEnum = 'single' | 'multi';
|
|
365
394
|
export interface ExportDashboardCompoundComparisonCondition {
|
|
@@ -367,8 +396,8 @@ export interface ExportDashboardCompoundComparisonCondition {
|
|
|
367
396
|
}
|
|
368
397
|
export interface ExportDashboardCompoundComparisonConditionComparison {
|
|
369
398
|
'operator': ExportDashboardCompoundComparisonConditionComparisonOperatorEnum;
|
|
370
|
-
'value': number;
|
|
371
399
|
'treatNullValuesAs'?: number;
|
|
400
|
+
'value': number;
|
|
372
401
|
}
|
|
373
402
|
export type ExportDashboardCompoundComparisonConditionComparisonOperatorEnum = 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'EQUAL_TO' | 'NOT_EQUAL_TO';
|
|
374
403
|
/**
|
|
@@ -379,8 +408,8 @@ export interface ExportDashboardCompoundRangeCondition {
|
|
|
379
408
|
'range': ExportDashboardCompoundRangeConditionRange;
|
|
380
409
|
}
|
|
381
410
|
export interface ExportDashboardCompoundRangeConditionRange {
|
|
382
|
-
'operator': ExportDashboardCompoundRangeConditionRangeOperatorEnum;
|
|
383
411
|
'from': number;
|
|
412
|
+
'operator': ExportDashboardCompoundRangeConditionRangeOperatorEnum;
|
|
384
413
|
'to': number;
|
|
385
414
|
'treatNullValuesAs'?: number;
|
|
386
415
|
}
|
|
@@ -389,23 +418,27 @@ export interface ExportDashboardDateFilter {
|
|
|
389
418
|
'dateFilter': ExportDashboardDateFilterDateFilter;
|
|
390
419
|
}
|
|
391
420
|
export interface ExportDashboardDateFilterDateFilter {
|
|
392
|
-
'type': ExportDashboardDateFilterDateFilterTypeEnum;
|
|
393
|
-
'granularity': ExportDashboardDateFilterDateFilterGranularityEnum;
|
|
394
|
-
'from'?: ExportDashboardDateFilterDateFilterFrom;
|
|
395
|
-
'to'?: ExportDashboardDateFilterDateFilterFrom;
|
|
396
|
-
'dataSet'?: ExportIdentifierRef;
|
|
397
421
|
'attribute'?: ExportIdentifierRef;
|
|
398
422
|
'boundedFilter'?: ExportRelativeBoundedDateFilter;
|
|
423
|
+
'dataSet'?: ExportIdentifierRef;
|
|
399
424
|
'emptyValueHandling'?: ExportDashboardDateFilterDateFilterEmptyValueHandlingEnum;
|
|
425
|
+
'from'?: ExportDashboardDateFilterDateFilterFrom;
|
|
426
|
+
'granularity': ExportDashboardDateFilterDateFilterGranularityEnum;
|
|
400
427
|
'localIdentifier'?: string;
|
|
428
|
+
'to'?: ExportDashboardDateFilterDateFilterTo;
|
|
429
|
+
'type': ExportDashboardDateFilterDateFilterTypeEnum;
|
|
401
430
|
}
|
|
402
|
-
export type ExportDashboardDateFilterDateFilterTypeEnum = 'relative' | 'absolute';
|
|
403
|
-
export type ExportDashboardDateFilterDateFilterGranularityEnum = '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';
|
|
404
431
|
export type ExportDashboardDateFilterDateFilterEmptyValueHandlingEnum = 'include' | 'exclude' | 'only';
|
|
432
|
+
export type ExportDashboardDateFilterDateFilterGranularityEnum = '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';
|
|
433
|
+
export type ExportDashboardDateFilterDateFilterTypeEnum = 'relative' | 'absolute';
|
|
405
434
|
/**
|
|
406
435
|
* @type ExportDashboardDateFilterDateFilterFrom
|
|
407
436
|
*/
|
|
408
437
|
export type ExportDashboardDateFilterDateFilterFrom = number | string;
|
|
438
|
+
/**
|
|
439
|
+
* @type ExportDashboardDateFilterDateFilterTo
|
|
440
|
+
*/
|
|
441
|
+
export type ExportDashboardDateFilterDateFilterTo = number | string;
|
|
409
442
|
/**
|
|
410
443
|
* Additional settings.
|
|
411
444
|
*/
|
|
@@ -418,17 +451,17 @@ export interface ExportDashboardExportSettings {
|
|
|
418
451
|
* Merge equal headers in neighbouring cells. Used for [XLSX] format only.
|
|
419
452
|
*/
|
|
420
453
|
'mergeHeaders'?: boolean;
|
|
421
|
-
/**
|
|
422
|
-
* Set page size. (PDF)
|
|
423
|
-
*/
|
|
424
|
-
'pageSize'?: ExportDashboardExportSettingsPageSizeEnum;
|
|
425
454
|
/**
|
|
426
455
|
* Set page orientation. (PDF)
|
|
427
456
|
*/
|
|
428
457
|
'pageOrientation'?: ExportDashboardExportSettingsPageOrientationEnum;
|
|
458
|
+
/**
|
|
459
|
+
* Set page size. (PDF)
|
|
460
|
+
*/
|
|
461
|
+
'pageSize'?: ExportDashboardExportSettingsPageSizeEnum;
|
|
429
462
|
}
|
|
430
|
-
export type ExportDashboardExportSettingsPageSizeEnum = 'A3' | 'A4' | 'LETTER';
|
|
431
463
|
export type ExportDashboardExportSettingsPageOrientationEnum = 'PORTRAIT' | 'LANDSCAPE';
|
|
464
|
+
export type ExportDashboardExportSettingsPageSizeEnum = 'A3' | 'A4' | 'LETTER';
|
|
432
465
|
/**
|
|
433
466
|
* @type ExportDashboardFilter
|
|
434
467
|
*/
|
|
@@ -437,69 +470,69 @@ export interface ExportDashboardMatchAttributeFilter {
|
|
|
437
470
|
'matchAttributeFilter': ExportDashboardMatchAttributeFilterMatchAttributeFilter;
|
|
438
471
|
}
|
|
439
472
|
export interface ExportDashboardMatchAttributeFilterMatchAttributeFilter {
|
|
473
|
+
'caseSensitive': boolean;
|
|
440
474
|
'displayForm': ExportIdentifierRef;
|
|
441
|
-
'operator': ExportDashboardMatchAttributeFilterMatchAttributeFilterOperatorEnum;
|
|
442
475
|
'literal': string;
|
|
476
|
+
'localIdentifier'?: string;
|
|
443
477
|
'negativeSelection': boolean;
|
|
444
|
-
'
|
|
478
|
+
'operator': ExportDashboardMatchAttributeFilterMatchAttributeFilterOperatorEnum;
|
|
445
479
|
'title'?: string;
|
|
446
|
-
'localIdentifier'?: string;
|
|
447
480
|
}
|
|
448
481
|
export type ExportDashboardMatchAttributeFilterMatchAttributeFilterOperatorEnum = 'contains' | 'startsWith' | 'endsWith';
|
|
449
482
|
export interface ExportDashboardMeasureValueFilter {
|
|
450
483
|
'dashboardMeasureValueFilter': ExportDashboardMeasureValueFilterDashboardMeasureValueFilter;
|
|
451
484
|
}
|
|
452
485
|
export interface ExportDashboardMeasureValueFilterDashboardMeasureValueFilter {
|
|
453
|
-
'measure': ExportIdentifierRef;
|
|
454
486
|
'conditions': Array<ExportDashboardCompoundConditionItem>;
|
|
455
487
|
'dimensionality'?: Array<ExportIdentifierRef>;
|
|
456
|
-
'title'?: string;
|
|
457
488
|
'localIdentifier'?: string;
|
|
489
|
+
'measure': ExportIdentifierRef;
|
|
490
|
+
'title'?: string;
|
|
458
491
|
}
|
|
459
492
|
/**
|
|
460
493
|
* Export request object describing the export properties for dashboard tabular exports.
|
|
461
494
|
*/
|
|
462
495
|
export interface ExportDashboardTabularExportRequest {
|
|
463
|
-
/**
|
|
464
|
-
* Requested tabular export type.
|
|
465
|
-
*/
|
|
466
|
-
'format': ExportDashboardTabularExportRequestFormatEnum;
|
|
467
|
-
/**
|
|
468
|
-
* Filename of downloaded file without extension.
|
|
469
|
-
*/
|
|
470
|
-
'fileName': string;
|
|
471
496
|
/**
|
|
472
497
|
* List of filters that will be used instead of the default dashboard filters.
|
|
473
498
|
*/
|
|
474
499
|
'dashboardFiltersOverride'?: Array<ExportDashboardFilter>;
|
|
500
|
+
/**
|
|
501
|
+
* 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.
|
|
502
|
+
*/
|
|
503
|
+
'dashboardParametersOverride'?: Array<ExportParameterValue>;
|
|
475
504
|
/**
|
|
476
505
|
* Map of tab-specific filter overrides. Key is tabId, value is list of filters for that tab.
|
|
477
506
|
*/
|
|
478
507
|
'dashboardTabsFiltersOverrides'?: {
|
|
479
508
|
[key: string]: Array<ExportDashboardFilter>;
|
|
480
509
|
};
|
|
481
|
-
/**
|
|
482
|
-
* List of widget identifiers to be exported. Note that only one widget is currently supported.
|
|
483
|
-
*/
|
|
484
|
-
'widgetIds'?: Array<string>;
|
|
485
|
-
'settings'?: ExportDashboardExportSettings;
|
|
486
|
-
/**
|
|
487
|
-
* 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.
|
|
488
|
-
*/
|
|
489
|
-
'dashboardParametersOverride'?: Array<ExportParameterValue>;
|
|
490
510
|
/**
|
|
491
511
|
* 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.
|
|
492
512
|
*/
|
|
493
513
|
'dashboardTabsParametersOverrides'?: {
|
|
494
514
|
[key: string]: Array<ExportParameterValue>;
|
|
495
515
|
};
|
|
516
|
+
/**
|
|
517
|
+
* Filename of downloaded file without extension.
|
|
518
|
+
*/
|
|
519
|
+
'fileName': string;
|
|
520
|
+
/**
|
|
521
|
+
* Requested tabular export type.
|
|
522
|
+
*/
|
|
523
|
+
'format': ExportDashboardTabularExportRequestFormatEnum;
|
|
524
|
+
'settings'?: ExportDashboardExportSettings;
|
|
525
|
+
/**
|
|
526
|
+
* List of widget identifiers to be exported. Note that only one widget is currently supported.
|
|
527
|
+
*/
|
|
528
|
+
'widgetIds'?: Array<string>;
|
|
496
529
|
}
|
|
497
530
|
export type ExportDashboardTabularExportRequestFormatEnum = 'XLSX' | 'PDF';
|
|
498
531
|
/**
|
|
499
532
|
* @type ExportDateFilter
|
|
500
533
|
* Abstract filter definition type for dates.
|
|
501
534
|
*/
|
|
502
|
-
export type ExportDateFilter = ExportAbsoluteDateFilter | ExportAllTimeDateFilter | ExportRelativeDateFilter;
|
|
535
|
+
export type ExportDateFilter = ExportAbsoluteDateFilter | ExportAbsoluteGranularityDateFilter | ExportAllTimeDateFilter | ExportRelativeDateFilter;
|
|
503
536
|
export interface ExportDateValue {
|
|
504
537
|
'value': string;
|
|
505
538
|
}
|
|
@@ -515,6 +548,10 @@ export interface ExportExecutionSettings {
|
|
|
515
548
|
* Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used.
|
|
516
549
|
*/
|
|
517
550
|
'timestamp'?: string;
|
|
551
|
+
/**
|
|
552
|
+
* 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.
|
|
553
|
+
*/
|
|
554
|
+
'timezone'?: string;
|
|
518
555
|
}
|
|
519
556
|
export interface ExportExportResponse {
|
|
520
557
|
'exportResult': string;
|
|
@@ -523,21 +560,41 @@ export interface ExportExportResponse {
|
|
|
523
560
|
* @type ExportFilterDefinition
|
|
524
561
|
* Abstract filter definition type
|
|
525
562
|
*/
|
|
526
|
-
export type ExportFilterDefinition = ExportAbsoluteDateFilter | ExportAllTimeDateFilter | ExportComparisonMeasureValueFilter | ExportCompoundMeasureValueFilter | ExportInlineFilterDefinition | ExportMatchAttributeFilter | ExportNegativeAttributeFilter | ExportPositiveAttributeFilter | ExportRangeMeasureValueFilter | ExportRankingFilter | ExportRelativeDateFilter;
|
|
563
|
+
export type ExportFilterDefinition = ExportAbsoluteDateFilter | ExportAbsoluteGranularityDateFilter | ExportAllTimeDateFilter | ExportComparisonMeasureValueFilter | ExportCompoundMeasureValueFilter | ExportInlineFilterDefinition | ExportMatchAttributeFilter | ExportNegativeAttributeFilter | ExportPositiveAttributeFilter | ExportRangeMeasureValueFilter | ExportRankingFilter | ExportRelativeDateFilter;
|
|
527
564
|
/**
|
|
528
565
|
* @type ExportFilterDefinitionForSimpleMeasure
|
|
529
566
|
* Abstract filter definition type for simple metric.
|
|
530
567
|
*/
|
|
531
568
|
export type ExportFilterDefinitionForSimpleMeasure = ExportAttributeFilter | ExportDateFilter;
|
|
532
|
-
export interface
|
|
533
|
-
'short'?: number;
|
|
569
|
+
export interface ExportGetImageExport202ResponseInner {
|
|
534
570
|
'char'?: string;
|
|
571
|
+
'direct'?: boolean;
|
|
572
|
+
'double'?: number;
|
|
573
|
+
'float'?: number;
|
|
535
574
|
'int'?: number;
|
|
536
575
|
'long'?: number;
|
|
537
|
-
'
|
|
576
|
+
'readOnly'?: boolean;
|
|
577
|
+
'short'?: number;
|
|
578
|
+
}
|
|
579
|
+
export interface ExportGetSlidesExport202ResponseInner {
|
|
580
|
+
'char'?: string;
|
|
581
|
+
'direct'?: boolean;
|
|
538
582
|
'double'?: number;
|
|
583
|
+
'float'?: number;
|
|
584
|
+
'int'?: number;
|
|
585
|
+
'long'?: number;
|
|
586
|
+
'readOnly'?: boolean;
|
|
587
|
+
'short'?: number;
|
|
588
|
+
}
|
|
589
|
+
export interface ExportGetSlidesExport202ResponseInner1 {
|
|
590
|
+
'char'?: string;
|
|
539
591
|
'direct'?: boolean;
|
|
592
|
+
'double'?: number;
|
|
593
|
+
'float'?: number;
|
|
594
|
+
'int'?: number;
|
|
595
|
+
'long'?: number;
|
|
540
596
|
'readOnly'?: boolean;
|
|
597
|
+
'short'?: number;
|
|
541
598
|
}
|
|
542
599
|
export interface ExportIdentifierRef {
|
|
543
600
|
'identifier'?: ExportIdentifierRefIdentifier;
|
|
@@ -546,31 +603,31 @@ export interface ExportIdentifierRefIdentifier {
|
|
|
546
603
|
'id': string;
|
|
547
604
|
'type': ExportIdentifierRefIdentifierTypeEnum;
|
|
548
605
|
}
|
|
549
|
-
export type ExportIdentifierRefIdentifierTypeEnum = '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';
|
|
606
|
+
export type ExportIdentifierRefIdentifierTypeEnum = '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';
|
|
550
607
|
/**
|
|
551
608
|
* Export request object describing the export properties and metadata for image exports.
|
|
552
609
|
*/
|
|
553
610
|
export interface ExportImageExportRequest {
|
|
554
611
|
/**
|
|
555
|
-
*
|
|
612
|
+
* Dashboard identifier
|
|
556
613
|
*/
|
|
557
|
-
'
|
|
614
|
+
'dashboardId': string;
|
|
558
615
|
/**
|
|
559
616
|
* File name to be used for retrieving the image document.
|
|
560
617
|
*/
|
|
561
618
|
'fileName': string;
|
|
562
619
|
/**
|
|
563
|
-
*
|
|
564
|
-
*/
|
|
565
|
-
'dashboardId': string;
|
|
566
|
-
/**
|
|
567
|
-
* List of widget identifiers to be exported. Note that only one widget is currently supported.
|
|
620
|
+
* Requested resulting file type.
|
|
568
621
|
*/
|
|
569
|
-
'
|
|
622
|
+
'format': ExportImageExportRequestFormatEnum;
|
|
570
623
|
/**
|
|
571
624
|
* Metadata definition in free-form JSON format.
|
|
572
625
|
*/
|
|
573
626
|
'metadata'?: object | null;
|
|
627
|
+
/**
|
|
628
|
+
* List of widget identifiers to be exported. Note that only one widget is currently supported.
|
|
629
|
+
*/
|
|
630
|
+
'widgetIds': Array<string>;
|
|
574
631
|
}
|
|
575
632
|
export type ExportImageExportRequestFormatEnum = 'PNG';
|
|
576
633
|
/**
|
|
@@ -580,12 +637,12 @@ export interface ExportInlineFilterDefinition {
|
|
|
580
637
|
'inline': ExportInlineFilterDefinitionInline;
|
|
581
638
|
}
|
|
582
639
|
export interface ExportInlineFilterDefinitionInline {
|
|
640
|
+
'applyOnResult'?: boolean;
|
|
583
641
|
/**
|
|
584
642
|
* MAQL query representing the filter.
|
|
585
643
|
*/
|
|
586
644
|
'filter': string;
|
|
587
645
|
'localIdentifier'?: string;
|
|
588
|
-
'applyOnResult'?: boolean;
|
|
589
646
|
}
|
|
590
647
|
/**
|
|
591
648
|
* Metric defined by the raw MAQL query.
|
|
@@ -606,10 +663,17 @@ export interface ExportMatchAttributeFilter {
|
|
|
606
663
|
'matchAttributeFilter': ExportMatchAttributeFilterMatchAttributeFilter;
|
|
607
664
|
}
|
|
608
665
|
export interface ExportMatchAttributeFilterMatchAttributeFilter {
|
|
666
|
+
'applyOnResult'?: boolean;
|
|
667
|
+
/**
|
|
668
|
+
* Indicates whether the filter match is evaluated in case-sensitive mode or not.
|
|
669
|
+
*/
|
|
670
|
+
'caseSensitive'?: boolean;
|
|
671
|
+
'label': ExportAfmIdentifier;
|
|
609
672
|
/**
|
|
610
673
|
* Literal used to limit label values.
|
|
611
674
|
*/
|
|
612
675
|
'literal': string;
|
|
676
|
+
'localIdentifier'?: string;
|
|
613
677
|
/**
|
|
614
678
|
* Requested match type.
|
|
615
679
|
*/
|
|
@@ -618,13 +682,6 @@ export interface ExportMatchAttributeFilterMatchAttributeFilter {
|
|
|
618
682
|
* Indicates whether the filter should negate the match.
|
|
619
683
|
*/
|
|
620
684
|
'negate'?: boolean;
|
|
621
|
-
/**
|
|
622
|
-
* Indicates whether the filter match is evaluated in case-sensitive mode or not.
|
|
623
|
-
*/
|
|
624
|
-
'caseSensitive'?: boolean;
|
|
625
|
-
'localIdentifier'?: string;
|
|
626
|
-
'applyOnResult'?: boolean;
|
|
627
|
-
'label': ExportAfmIdentifier;
|
|
628
685
|
}
|
|
629
686
|
export type ExportMatchAttributeFilterMatchAttributeFilterMatchTypeEnum = 'STARTS_WITH' | 'ENDS_WITH' | 'CONTAINS';
|
|
630
687
|
/**
|
|
@@ -636,11 +693,11 @@ export type ExportMeasureDefinition = ExportArithmeticMeasureDefinition | Export
|
|
|
636
693
|
* Metric is a quantity that is calculated from the data.
|
|
637
694
|
*/
|
|
638
695
|
export interface ExportMeasureItem {
|
|
696
|
+
'definition': ExportMeasureDefinition;
|
|
639
697
|
/**
|
|
640
698
|
* Local identifier of the metric. This can be used to reference the metric in other parts of the execution definition.
|
|
641
699
|
*/
|
|
642
700
|
'localIdentifier': string;
|
|
643
|
-
'definition': ExportMeasureDefinition;
|
|
644
701
|
}
|
|
645
702
|
/**
|
|
646
703
|
* @type ExportMeasureValueCondition
|
|
@@ -656,8 +713,8 @@ export type ExportMeasureValueFilter = ExportComparisonMeasureValueFilter | Expo
|
|
|
656
713
|
* (EXPERIMENTAL) Override for a catalog metric definition.
|
|
657
714
|
*/
|
|
658
715
|
export interface ExportMetricDefinitionOverride {
|
|
659
|
-
'item': ExportAfmObjectIdentifierCore;
|
|
660
716
|
'definition': ExportInlineMeasureDefinition;
|
|
717
|
+
'item': ExportAfmObjectIdentifierCore;
|
|
661
718
|
}
|
|
662
719
|
/**
|
|
663
720
|
* Filter able to limit element values by label and related selected negated elements.
|
|
@@ -666,14 +723,14 @@ export interface ExportNegativeAttributeFilter {
|
|
|
666
723
|
'negativeAttributeFilter': ExportNegativeAttributeFilterNegativeAttributeFilter;
|
|
667
724
|
}
|
|
668
725
|
export interface ExportNegativeAttributeFilterNegativeAttributeFilter {
|
|
669
|
-
'notIn': ExportAttributeFilterElements;
|
|
670
|
-
'localIdentifier'?: string;
|
|
671
726
|
'applyOnResult'?: boolean;
|
|
727
|
+
'label': ExportAfmIdentifier;
|
|
728
|
+
'localIdentifier'?: string;
|
|
729
|
+
'notIn': ExportAttributeFilterElements;
|
|
672
730
|
/**
|
|
673
731
|
* If true, indicates that the values in notInElements were filled free-form, otherwise they have been picked from existing elements.
|
|
674
732
|
*/
|
|
675
733
|
'usesArbitraryValues'?: boolean;
|
|
676
|
-
'label': ExportAfmIdentifier;
|
|
677
734
|
}
|
|
678
735
|
export interface ExportOver {
|
|
679
736
|
'attributes': Array<ExportIdentifierRef>;
|
|
@@ -682,6 +739,7 @@ export interface ExportOver {
|
|
|
682
739
|
* (EXPERIMENTAL) Parameter value for this execution.
|
|
683
740
|
*/
|
|
684
741
|
export interface ExportParameterItem {
|
|
742
|
+
[key: string]: any;
|
|
685
743
|
'parameter': ExportAfmObjectIdentifierParameter;
|
|
686
744
|
/**
|
|
687
745
|
* Value to use for this parameter instead of its default.
|
|
@@ -692,31 +750,32 @@ export interface ExportParameterItem {
|
|
|
692
750
|
* Parameter value override applied to the export. The (id, value) pair drives the execution; the title is FE-supplied for info-sheet display.
|
|
693
751
|
*/
|
|
694
752
|
export interface ExportParameterValue {
|
|
753
|
+
[key: string]: any;
|
|
695
754
|
/**
|
|
696
755
|
* Identifier of the workspace parameter (matches the parameter entity id).
|
|
697
756
|
*/
|
|
698
757
|
'id': string;
|
|
699
|
-
/**
|
|
700
|
-
* Value to use for this parameter when executing the export.
|
|
701
|
-
*/
|
|
702
|
-
'value': string;
|
|
703
758
|
/**
|
|
704
759
|
* Display title of the parameter as the client wants it rendered on the info sheet.
|
|
705
760
|
*/
|
|
706
761
|
'title': string;
|
|
762
|
+
/**
|
|
763
|
+
* Value to use for this parameter when executing the export.
|
|
764
|
+
*/
|
|
765
|
+
'value': string;
|
|
707
766
|
}
|
|
708
767
|
/**
|
|
709
768
|
* Custom CSS styles for the table. (PDF, HTML)
|
|
710
769
|
*/
|
|
711
770
|
export interface ExportPdfTableStyle {
|
|
712
|
-
/**
|
|
713
|
-
* CSS selector where to apply given properties.
|
|
714
|
-
*/
|
|
715
|
-
'selector': string;
|
|
716
771
|
/**
|
|
717
772
|
* List of CSS properties.
|
|
718
773
|
*/
|
|
719
774
|
'properties'?: Array<ExportPdfTableStyleProperty>;
|
|
775
|
+
/**
|
|
776
|
+
* CSS selector where to apply given properties.
|
|
777
|
+
*/
|
|
778
|
+
'selector': string;
|
|
720
779
|
}
|
|
721
780
|
/**
|
|
722
781
|
* CSS property.
|
|
@@ -748,11 +807,11 @@ export interface ExportPopDatasetMeasureDefinition {
|
|
|
748
807
|
'previousPeriodMeasure': ExportPopDatasetMeasureDefinitionPreviousPeriodMeasure;
|
|
749
808
|
}
|
|
750
809
|
export interface ExportPopDatasetMeasureDefinitionPreviousPeriodMeasure {
|
|
751
|
-
'measureIdentifier': ExportAfmLocalIdentifier;
|
|
752
810
|
/**
|
|
753
811
|
* Specification of which date data sets to use for determining the period to calculate the previous period for.
|
|
754
812
|
*/
|
|
755
813
|
'dateDatasets': Array<ExportPopDataset>;
|
|
814
|
+
'measureIdentifier': ExportAfmLocalIdentifier;
|
|
756
815
|
}
|
|
757
816
|
/**
|
|
758
817
|
* Combination of the date attribute to use and how many periods ago to calculate the PoP for.
|
|
@@ -771,11 +830,11 @@ export interface ExportPopDateMeasureDefinition {
|
|
|
771
830
|
'overPeriodMeasure': ExportPopDateMeasureDefinitionOverPeriodMeasure;
|
|
772
831
|
}
|
|
773
832
|
export interface ExportPopDateMeasureDefinitionOverPeriodMeasure {
|
|
774
|
-
'measureIdentifier': ExportAfmLocalIdentifier;
|
|
775
833
|
/**
|
|
776
834
|
* Attributes to use for determining the period to calculate the PoP for.
|
|
777
835
|
*/
|
|
778
836
|
'dateAttributes': Array<ExportPopDate>;
|
|
837
|
+
'measureIdentifier': ExportAfmLocalIdentifier;
|
|
779
838
|
}
|
|
780
839
|
/**
|
|
781
840
|
* @type ExportPopMeasureDefinition
|
|
@@ -788,14 +847,14 @@ export interface ExportPositiveAttributeFilter {
|
|
|
788
847
|
'positiveAttributeFilter': ExportPositiveAttributeFilterPositiveAttributeFilter;
|
|
789
848
|
}
|
|
790
849
|
export interface ExportPositiveAttributeFilterPositiveAttributeFilter {
|
|
850
|
+
'applyOnResult'?: boolean;
|
|
791
851
|
'in': ExportAttributeFilterElements;
|
|
852
|
+
'label': ExportAfmIdentifier;
|
|
792
853
|
'localIdentifier'?: string;
|
|
793
|
-
'applyOnResult'?: boolean;
|
|
794
854
|
/**
|
|
795
855
|
* If true, indicates that the values in inElements were filled free-form, otherwise they have been picked from existing elements.
|
|
796
856
|
*/
|
|
797
857
|
'usesArbitraryValues'?: boolean;
|
|
798
|
-
'label': ExportAfmIdentifier;
|
|
799
858
|
}
|
|
800
859
|
/**
|
|
801
860
|
* Condition that checks if the metric value is within a given range.
|
|
@@ -804,8 +863,8 @@ export interface ExportRangeCondition {
|
|
|
804
863
|
'range': ExportRangeConditionRange;
|
|
805
864
|
}
|
|
806
865
|
export interface ExportRangeConditionRange {
|
|
807
|
-
'operator': ExportRangeConditionRangeOperatorEnum;
|
|
808
866
|
'from': number;
|
|
867
|
+
'operator': ExportRangeConditionRangeOperatorEnum;
|
|
809
868
|
'to': number;
|
|
810
869
|
}
|
|
811
870
|
export type ExportRangeConditionRangeOperatorEnum = 'BETWEEN' | 'NOT_BETWEEN';
|
|
@@ -816,20 +875,20 @@ export interface ExportRangeMeasureValueFilter {
|
|
|
816
875
|
'rangeMeasureValueFilter': ExportRangeMeasureValueFilterRangeMeasureValueFilter;
|
|
817
876
|
}
|
|
818
877
|
export interface ExportRangeMeasureValueFilterRangeMeasureValueFilter {
|
|
878
|
+
'applyOnResult'?: boolean;
|
|
819
879
|
/**
|
|
820
880
|
* References to the attributes to be used when filtering.
|
|
821
881
|
*/
|
|
822
882
|
'dimensionality'?: Array<ExportAfmIdentifier>;
|
|
883
|
+
'from': number;
|
|
884
|
+
'localIdentifier'?: string;
|
|
885
|
+
'measure': ExportAfmIdentifier;
|
|
886
|
+
'operator': ExportRangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum;
|
|
887
|
+
'to': number;
|
|
823
888
|
/**
|
|
824
889
|
* A value that will be substituted for null values in the metric for the comparisons.
|
|
825
890
|
*/
|
|
826
891
|
'treatNullValuesAs'?: number;
|
|
827
|
-
'operator': ExportRangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum;
|
|
828
|
-
'from': number;
|
|
829
|
-
'to': number;
|
|
830
|
-
'localIdentifier'?: string;
|
|
831
|
-
'applyOnResult'?: boolean;
|
|
832
|
-
'measure': ExportAfmIdentifier;
|
|
833
892
|
}
|
|
834
893
|
export type ExportRangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum = 'BETWEEN' | 'NOT_BETWEEN';
|
|
835
894
|
/**
|
|
@@ -839,10 +898,12 @@ export interface ExportRankingFilter {
|
|
|
839
898
|
'rankingFilter': ExportRankingFilterRankingFilter;
|
|
840
899
|
}
|
|
841
900
|
export interface ExportRankingFilterRankingFilter {
|
|
901
|
+
'applyOnResult'?: boolean;
|
|
842
902
|
/**
|
|
843
903
|
* References to the attributes to be used when filtering.
|
|
844
904
|
*/
|
|
845
905
|
'dimensionality'?: Array<ExportAfmIdentifier>;
|
|
906
|
+
'localIdentifier'?: string;
|
|
846
907
|
/**
|
|
847
908
|
* References to the metrics to be used when filtering.
|
|
848
909
|
*/
|
|
@@ -851,16 +912,14 @@ export interface ExportRankingFilterRankingFilter {
|
|
|
851
912
|
* The type of ranking to use, TOP or BOTTOM.
|
|
852
913
|
*/
|
|
853
914
|
'operator': ExportRankingFilterRankingFilterOperatorEnum;
|
|
854
|
-
/**
|
|
855
|
-
* Number of top/bottom values to filter.
|
|
856
|
-
*/
|
|
857
|
-
'value': number;
|
|
858
915
|
/**
|
|
859
916
|
* When true, filter returns requested number of rows at most. Default is false.
|
|
860
917
|
*/
|
|
861
918
|
'strictLimitOfRows'?: boolean;
|
|
862
|
-
|
|
863
|
-
|
|
919
|
+
/**
|
|
920
|
+
* Number of top/bottom values to filter.
|
|
921
|
+
*/
|
|
922
|
+
'value': number;
|
|
864
923
|
}
|
|
865
924
|
export type ExportRankingFilterRankingFilterOperatorEnum = 'TOP' | 'BOTTOM';
|
|
866
925
|
/**
|
|
@@ -902,29 +961,29 @@ export interface ExportRawCustomOverride {
|
|
|
902
961
|
* Export request object describing the export properties and overrides for raw exports.
|
|
903
962
|
*/
|
|
904
963
|
export interface ExportRawExportRequest {
|
|
964
|
+
'customOverride'?: ExportRawCustomOverride;
|
|
905
965
|
/**
|
|
906
|
-
*
|
|
966
|
+
* Set column delimiter. (CSV)
|
|
907
967
|
*/
|
|
908
|
-
'
|
|
968
|
+
'delimiter'?: string;
|
|
909
969
|
'execution': ExportAFM;
|
|
970
|
+
'executionSettings'?: ExportExecutionSettings;
|
|
910
971
|
/**
|
|
911
972
|
* Filename of downloaded file without extension.
|
|
912
973
|
*/
|
|
913
974
|
'fileName': string;
|
|
914
|
-
'customOverride'?: ExportRawCustomOverride;
|
|
915
|
-
'executionSettings'?: ExportExecutionSettings;
|
|
916
975
|
/**
|
|
917
|
-
*
|
|
976
|
+
* Requested resulting file type.
|
|
918
977
|
*/
|
|
919
|
-
'
|
|
978
|
+
'format': ExportRawExportRequestFormatEnum;
|
|
920
979
|
}
|
|
921
980
|
export type ExportRawExportRequestFormatEnum = 'ARROW_FILE' | 'ARROW_STREAM' | 'CSV';
|
|
922
981
|
export interface ExportRelativeBoundedDateFilter {
|
|
923
|
-
'granularity': ExportRelativeBoundedDateFilterGranularityEnum;
|
|
924
982
|
'from'?: number;
|
|
983
|
+
'granularity': ExportRelativeBoundedDateFilterGranularityEnum;
|
|
925
984
|
'to'?: number;
|
|
926
985
|
}
|
|
927
|
-
export type ExportRelativeBoundedDateFilterGranularityEnum = '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';
|
|
986
|
+
export type ExportRelativeBoundedDateFilterGranularityEnum = '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';
|
|
928
987
|
/**
|
|
929
988
|
* 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.
|
|
930
989
|
*/
|
|
@@ -932,46 +991,57 @@ export interface ExportRelativeDateFilter {
|
|
|
932
991
|
'relativeDateFilter': ExportRelativeDateFilterRelativeDateFilter;
|
|
933
992
|
}
|
|
934
993
|
export interface ExportRelativeDateFilterRelativeDateFilter {
|
|
994
|
+
'applyOnResult'?: boolean;
|
|
995
|
+
'boundedFilter'?: ExportBoundedFilter;
|
|
996
|
+
'dataset': ExportAfmObjectIdentifierDataset;
|
|
935
997
|
/**
|
|
936
|
-
*
|
|
998
|
+
* 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.
|
|
937
999
|
*/
|
|
938
|
-
'
|
|
1000
|
+
'emptyValueHandling'?: ExportRelativeDateFilterRelativeDateFilterEmptyValueHandlingEnum;
|
|
939
1001
|
/**
|
|
940
1002
|
* 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\').
|
|
941
1003
|
*/
|
|
942
1004
|
'from': number;
|
|
943
1005
|
/**
|
|
944
|
-
*
|
|
1006
|
+
* Date granularity specifying particular date attribute in given dimension.
|
|
945
1007
|
*/
|
|
946
|
-
'
|
|
1008
|
+
'granularity': ExportRelativeDateFilterRelativeDateFilterGranularityEnum;
|
|
947
1009
|
'localIdentifier'?: string;
|
|
948
|
-
'applyOnResult'?: boolean;
|
|
949
|
-
'boundedFilter'?: ExportBoundedFilter;
|
|
950
1010
|
/**
|
|
951
|
-
*
|
|
1011
|
+
* 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, ...).
|
|
952
1012
|
*/
|
|
953
|
-
'
|
|
954
|
-
'dataset': ExportAfmObjectIdentifierDataset;
|
|
1013
|
+
'to': number;
|
|
955
1014
|
}
|
|
956
|
-
export type ExportRelativeDateFilterRelativeDateFilterGranularityEnum = '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';
|
|
957
1015
|
export type ExportRelativeDateFilterRelativeDateFilterEmptyValueHandlingEnum = 'INCLUDE' | 'EXCLUDE' | 'ONLY';
|
|
1016
|
+
export type ExportRelativeDateFilterRelativeDateFilterGranularityEnum = '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';
|
|
958
1017
|
/**
|
|
959
1018
|
* Additional settings.
|
|
960
1019
|
*/
|
|
961
1020
|
export interface ExportSettings {
|
|
1021
|
+
/**
|
|
1022
|
+
* Set column delimiter. (CSV)
|
|
1023
|
+
*/
|
|
1024
|
+
'delimiter'?: string;
|
|
962
1025
|
/**
|
|
963
1026
|
* If true, the export will contain the information about the export – exported date, filters, etc. Works only with `visualizationObject`. (XLSX, PDF)
|
|
964
1027
|
*/
|
|
965
1028
|
'exportInfo'?: boolean;
|
|
1029
|
+
/**
|
|
1030
|
+
* Grand totals position. Takes precedence over position specified in visualization.
|
|
1031
|
+
*/
|
|
1032
|
+
'grandTotalsPosition'?: ExportSettingsGrandTotalsPositionEnum;
|
|
966
1033
|
/**
|
|
967
1034
|
* Merge equal headers in neighbouring cells. (XLSX)
|
|
968
1035
|
*/
|
|
969
1036
|
'mergeHeaders'?: boolean;
|
|
970
1037
|
/**
|
|
971
|
-
*
|
|
972
|
-
* @deprecated
|
|
1038
|
+
* Set page orientation. (PDF)
|
|
973
1039
|
*/
|
|
974
|
-
'
|
|
1040
|
+
'pageOrientation'?: ExportSettingsPageOrientationEnum;
|
|
1041
|
+
/**
|
|
1042
|
+
* Set page size. (PDF)
|
|
1043
|
+
*/
|
|
1044
|
+
'pageSize'?: ExportSettingsPageSizeEnum;
|
|
975
1045
|
/**
|
|
976
1046
|
* Page size and orientation. (PDF)
|
|
977
1047
|
* @deprecated
|
|
@@ -993,25 +1063,14 @@ export interface ExportSettings {
|
|
|
993
1063
|
*/
|
|
994
1064
|
'pdfTopRightContent'?: string;
|
|
995
1065
|
/**
|
|
996
|
-
*
|
|
997
|
-
|
|
998
|
-
'pageSize'?: ExportSettingsPageSizeEnum;
|
|
999
|
-
/**
|
|
1000
|
-
* Set page orientation. (PDF)
|
|
1001
|
-
*/
|
|
1002
|
-
'pageOrientation'?: ExportSettingsPageOrientationEnum;
|
|
1003
|
-
/**
|
|
1004
|
-
* Set column delimiter. (CSV)
|
|
1005
|
-
*/
|
|
1006
|
-
'delimiter'?: string;
|
|
1007
|
-
/**
|
|
1008
|
-
* Grand totals position. Takes precedence over position specified in visualization.
|
|
1066
|
+
* Print applied filters on top of the document. (PDF/HTML when visualizationObject is given)
|
|
1067
|
+
* @deprecated
|
|
1009
1068
|
*/
|
|
1010
|
-
'
|
|
1069
|
+
'showFilters'?: boolean;
|
|
1011
1070
|
}
|
|
1012
|
-
export type ExportSettingsPageSizeEnum = 'A3' | 'A4' | 'LETTER';
|
|
1013
|
-
export type ExportSettingsPageOrientationEnum = 'PORTRAIT' | 'LANDSCAPE';
|
|
1014
1071
|
export type ExportSettingsGrandTotalsPositionEnum = 'pinnedBottom' | 'pinnedTop' | 'bottom' | 'top';
|
|
1072
|
+
export type ExportSettingsPageOrientationEnum = 'PORTRAIT' | 'LANDSCAPE';
|
|
1073
|
+
export type ExportSettingsPageSizeEnum = 'A3' | 'A4' | 'LETTER';
|
|
1015
1074
|
/**
|
|
1016
1075
|
* Metric defined by referencing a MAQL metric or an LDM fact object with aggregation.
|
|
1017
1076
|
*/
|
|
@@ -1019,7 +1078,6 @@ export interface ExportSimpleMeasureDefinition {
|
|
|
1019
1078
|
'measure': ExportSimpleMeasureDefinitionMeasure;
|
|
1020
1079
|
}
|
|
1021
1080
|
export interface ExportSimpleMeasureDefinitionMeasure {
|
|
1022
|
-
'item': ExportAfmObjectIdentifierCore;
|
|
1023
1081
|
/**
|
|
1024
1082
|
* Definition of aggregation type of the metric.
|
|
1025
1083
|
*/
|
|
@@ -1032,32 +1090,25 @@ export interface ExportSimpleMeasureDefinitionMeasure {
|
|
|
1032
1090
|
* Metrics can be filtered by attribute filters with the same interface as ones for global AFM. Note that only one DateFilter is allowed.
|
|
1033
1091
|
*/
|
|
1034
1092
|
'filters'?: Array<ExportFilterDefinitionForSimpleMeasure>;
|
|
1093
|
+
'item': ExportAfmObjectIdentifierCore;
|
|
1035
1094
|
}
|
|
1036
1095
|
export type ExportSimpleMeasureDefinitionMeasureAggregationEnum = 'SUM' | 'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'MEDIAN' | 'RUNSUM' | 'APPROXIMATE_COUNT';
|
|
1037
1096
|
/**
|
|
1038
1097
|
* Export request object describing the export properties and metadata for slides exports.
|
|
1039
1098
|
*/
|
|
1040
1099
|
export interface ExportSlidesExportRequest {
|
|
1041
|
-
/**
|
|
1042
|
-
* Requested resulting file type.
|
|
1043
|
-
*/
|
|
1044
|
-
'format': ExportSlidesExportRequestFormatEnum;
|
|
1045
|
-
/**
|
|
1046
|
-
* File name to be used for retrieving the pdf document.
|
|
1047
|
-
*/
|
|
1048
|
-
'fileName': string;
|
|
1049
1100
|
/**
|
|
1050
1101
|
* Dashboard identifier
|
|
1051
1102
|
*/
|
|
1052
1103
|
'dashboardId'?: string;
|
|
1053
1104
|
/**
|
|
1054
|
-
*
|
|
1105
|
+
* File name to be used for retrieving the pdf document.
|
|
1055
1106
|
*/
|
|
1056
|
-
'
|
|
1107
|
+
'fileName': string;
|
|
1057
1108
|
/**
|
|
1058
|
-
*
|
|
1109
|
+
* Requested resulting file type.
|
|
1059
1110
|
*/
|
|
1060
|
-
'
|
|
1111
|
+
'format': ExportSlidesExportRequestFormatEnum;
|
|
1061
1112
|
/**
|
|
1062
1113
|
* Metadata definition in free-form JSON format.
|
|
1063
1114
|
*/
|
|
@@ -1066,12 +1117,21 @@ export interface ExportSlidesExportRequest {
|
|
|
1066
1117
|
* Export template identifier.
|
|
1067
1118
|
*/
|
|
1068
1119
|
'templateId'?: string | null;
|
|
1120
|
+
/**
|
|
1121
|
+
* List of visualization ids to be exported. Note that only one visualization is currently supported.
|
|
1122
|
+
*/
|
|
1123
|
+
'visualizationIds'?: Array<string>;
|
|
1124
|
+
/**
|
|
1125
|
+
* List of widget identifiers to be exported. Note that only one widget is currently supported.
|
|
1126
|
+
*/
|
|
1127
|
+
'widgetIds'?: Array<string>;
|
|
1069
1128
|
}
|
|
1070
1129
|
export type ExportSlidesExportRequestFormatEnum = 'PDF' | 'PPTX';
|
|
1071
1130
|
/**
|
|
1072
1131
|
* A single pre-executed layer in a multi-layer tabular export.
|
|
1073
1132
|
*/
|
|
1074
1133
|
export interface ExportTabularExportExecution {
|
|
1134
|
+
'customOverride'?: ExportCustomOverride;
|
|
1075
1135
|
/**
|
|
1076
1136
|
* Execution result identifier for this layer.
|
|
1077
1137
|
*/
|
|
@@ -1080,26 +1140,37 @@ export interface ExportTabularExportExecution {
|
|
|
1080
1140
|
* Layer title used for the exported sheet or file name.
|
|
1081
1141
|
*/
|
|
1082
1142
|
'title'?: string;
|
|
1083
|
-
'customOverride'?: ExportCustomOverride;
|
|
1084
1143
|
}
|
|
1085
1144
|
/**
|
|
1086
1145
|
* Export request object describing the export properties and overrides for tabular exports.
|
|
1087
1146
|
*/
|
|
1088
1147
|
export interface ExportTabularExportRequest {
|
|
1089
|
-
|
|
1090
|
-
* Expected file format.
|
|
1091
|
-
*/
|
|
1092
|
-
'format': ExportTabularExportRequestFormatEnum;
|
|
1148
|
+
'customOverride'?: ExportCustomOverride;
|
|
1093
1149
|
/**
|
|
1094
1150
|
* Execution result identifier.
|
|
1095
1151
|
*/
|
|
1096
1152
|
'executionResult'?: string;
|
|
1153
|
+
/**
|
|
1154
|
+
* 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.
|
|
1155
|
+
*/
|
|
1156
|
+
'executions'?: Array<ExportTabularExportExecution>;
|
|
1097
1157
|
/**
|
|
1098
1158
|
* Filename of downloaded file without extension.
|
|
1099
1159
|
*/
|
|
1100
1160
|
'fileName': string;
|
|
1161
|
+
/**
|
|
1162
|
+
* Expected file format.
|
|
1163
|
+
*/
|
|
1164
|
+
'format': ExportTabularExportRequestFormatEnum;
|
|
1165
|
+
/**
|
|
1166
|
+
* Metadata definition in free-form JSON format.
|
|
1167
|
+
*/
|
|
1168
|
+
'metadata'?: object | null;
|
|
1169
|
+
/**
|
|
1170
|
+
* Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.
|
|
1171
|
+
*/
|
|
1172
|
+
'relatedDashboardId'?: string;
|
|
1101
1173
|
'settings'?: ExportSettings;
|
|
1102
|
-
'customOverride'?: ExportCustomOverride;
|
|
1103
1174
|
/**
|
|
1104
1175
|
* Visualization object identifier. Alternative to executionResult property.
|
|
1105
1176
|
*/
|
|
@@ -1112,32 +1183,20 @@ export interface ExportTabularExportRequest {
|
|
|
1112
1183
|
* Optional custom parameters to be applied when visualizationObject is given. Those parameters override the original parameters defined in the visualization.
|
|
1113
1184
|
*/
|
|
1114
1185
|
'visualizationObjectCustomParameters'?: Array<ExportParameterValue>;
|
|
1115
|
-
/**
|
|
1116
|
-
* Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.
|
|
1117
|
-
*/
|
|
1118
|
-
'relatedDashboardId'?: string;
|
|
1119
|
-
/**
|
|
1120
|
-
* Metadata definition in free-form JSON format.
|
|
1121
|
-
*/
|
|
1122
|
-
'metadata'?: object | null;
|
|
1123
|
-
/**
|
|
1124
|
-
* 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.
|
|
1125
|
-
*/
|
|
1126
|
-
'executions'?: Array<ExportTabularExportExecution>;
|
|
1127
1186
|
}
|
|
1128
1187
|
export type ExportTabularExportRequestFormatEnum = 'CSV' | 'XLSX' | 'HTML' | 'PDF';
|
|
1129
1188
|
/**
|
|
1130
1189
|
* Export request object describing the export properties and metadata for dashboard PDF exports.
|
|
1131
1190
|
*/
|
|
1132
1191
|
export interface ExportVisualExportRequest {
|
|
1133
|
-
/**
|
|
1134
|
-
* File name to be used for retrieving the pdf document.
|
|
1135
|
-
*/
|
|
1136
|
-
'fileName': string;
|
|
1137
1192
|
/**
|
|
1138
1193
|
* Dashboard identifier
|
|
1139
1194
|
*/
|
|
1140
1195
|
'dashboardId': string;
|
|
1196
|
+
/**
|
|
1197
|
+
* File name to be used for retrieving the pdf document.
|
|
1198
|
+
*/
|
|
1199
|
+
'fileName': string;
|
|
1141
1200
|
/**
|
|
1142
1201
|
* Metadata definition in free-form JSON format.
|
|
1143
1202
|
*/
|