-
Notifications
You must be signed in to change notification settings - Fork 3
/
apps.d.ts
2502 lines (2500 loc) · 93.3 KB
/
apps.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import { A as ApiCallOptions, D as DownloadableBlob } from './invoke-fetch-types-0Dw3a71T.js';
import './auth-types-PkN9CAF_.js';
type Analysis = "breakdown" | "changePoint" | "comparison" | "contribution" | "correlation" | "fact" | "mutualInfo" | "rank" | "spike" | "trend" | "values";
type AnalysisComposition = {
description?: {
long?: string;
short?: string;
};
/** Upper and lower bounds for items of specific classification types */
dims?: CompositionMinMax;
/** Upper and lower bounds for items of specific classification types */
geos?: CompositionMinMax;
/** Upper and lower bounds for items of specific classification types */
items?: CompositionMinMax;
/** Upper and lower bounds for items of specific classification types */
msrs?: CompositionMinMax;
/** Upper and lower bounds for items of specific classification types */
temporals?: CompositionMinMax;
};
type AnalysisDescriptor = {
compositions?: AnalysisComposition[];
id?: string;
/** Used for period-specific analyses to indicate the defined or available calendar period must be of type autoCalendar */
requiresAutoCalendarPeriod?: boolean;
/** Used for period-specific analyses to indicate the temporal dimension must be associated with one or more analysis periods */
requiresAvailableAnalysisPeriod?: boolean;
/** Used for period-specific analyses to indicate the measure must be associated with one or more analysis periods */
requiresDefinedAnalysisPeriod?: boolean;
/** If analysis can work with master items (default is true) */
supportsMasterItems?: boolean;
};
type AnalysisDescriptorResponse = {
data?: AnalysisDescriptor[];
links?: Links;
};
type AnalysisDetails = {
analysis?: Analysis;
analysisGroup?: AnalysisGroup;
title?: string;
};
type AnalysisGroup = "anomaly" | "brekadown" | "comparison" | "correl" | "fact" | "list" | "mutualInfo" | "rank";
type AnalysisModelItemField = {
/** classification defines the default role that attribute can play in an analysis */
classifications?: Classifications;
/** whether the field is hidden in business logic */
isHidden?: boolean;
/** populated only for fields */
name?: string;
simplifiedClassifications?: SimplifiedClassifications;
};
type AnalysisModelItemMasterItem = {
caption?: string;
/** classification defines the default role that attribute can play in an analysis */
classifications?: Classifications;
/** whether the master item is hidden in business logic */
isHidden?: boolean;
/** only available for master items */
libId?: string;
simplifiedClassifications?: SimplifiedClassifications;
};
type AnalysisModelResponse = {
data?: AnalysisModelResponseDetail[];
links?: Links;
};
type AnalysisModelResponseDetail = {
fields?: AnalysisModelItemField[];
/** set only if previous property is true, to indicate if the business logic passes validation */
isDefinedLogicalModelValid?: boolean;
/** if the analysis model is constructed based on a user-defined business-logic (as opposed to a default one) */
isLogicalModelEnabled?: boolean;
masterItems?: AnalysisModelItemMasterItem[];
};
/**
* Request payload can be of two types, using natural language query or consist of fields or master items and optional target analysis.
* In below examples, consider sales as a master item and product as field, so to get recommendations using sales and product,
* you can utilize below three approaches, also you can set language parameter in headers as part of accept-language.
* Examples:
* ```
* {
* 'text': 'show me sales by product'
* }
* ```
* ```
* {
* 'fields': [
* {
* 'name': 'product'
* }
* ],
* 'libItems': [
* {
* libId: 'NwQfJ'
* }
* ]
* }
* ```
* ```
* {
* 'fields': [
* {
* 'name': 'product'
* }
* ],
* 'libItems': [
* {
* 'libId': 'NwQfJ'
* }
* ],
* 'targetAnalysis': {
* 'id': 'rank-rank'
* }
* }
* ```
*/
type AnalysisRecommendRequest = RecommendNaturalLangQuery | RecommendItems;
type AnalysisRecommendationResponse = {
data?: AnalysisRecommendationResponseDetail[];
};
type AnalysisRecommendationResponseDetail = {
nluInfo?: PartialNluInfo[];
recAnalyses: RecommendedAnalysis[];
};
type AppAttributes = {
/** The description of the application */
description?: string;
/** Set custom locale instead of the system default */
locale?: string;
/** The name (title) of the application */
name?: string;
/** The space ID of the application */
spaceId?: string;
usage?: UsageEnum;
};
type AppContentList = {
/** Content list items. */
data?: AppContentListItem[];
/** Content library name. */
library?: string;
/** Content library relative listing path. Empty in case of root listed or representing actual subpath listed. */
subpath?: string;
};
type AppContentListItem = {
/** Unique content identifier. */
id?: string;
/** Unique content link. */
link?: string;
/** Content name. */
name?: string;
/** Content type. */
type?: string;
};
type AppObjectGenericType = "genericObject" | "genericBookmark" | "genericMeasure" | "genericDimension" | "genericVariable";
type AppUpdateAttributes = {
/** The description of the application. */
description?: string;
/** The name (title) of the application. */
name?: string;
};
/**
* Chart type given to current recommendation
*/
type ChartType = "barchart" | "combochart" | "distributionplot" | "kpi" | "linechart" | "map" | "scatterplot" | "table";
/**
* classification defines the default role that attribute can play in an analysis
*/
type Classifications = ("dimension" | "measure" | "temporal" | "city" | "address" | "boolean" | "country" | "date" | "email" | "geographical" | "geoPoint" | "geoPolygon" | "hour" | "latitude" | "monetary" | "ordinal" | "percentage" | "postalCode" | "quarter" | "stateProvince" | "timestamp" | "week" | "weekDay" | "year" | "yearDay")[];
/**
* Upper and lower bounds for items of specific classification types
*/
type CompositionMinMax = {
max?: number;
min?: number;
};
type CreateApp = {
attributes?: AppAttributes;
};
type DataModelMetadata = {
/** List of field descriptions. */
fields?: FieldMetadata[];
/** If set to true, the app has section access configured. */
has_section_access?: boolean;
is_direct_query_mode?: boolean;
reload_meta?: LastReloadMetadata;
/** Static memory usage for the app. */
static_byte_size?: number;
/** List of table descriptions. */
tables?: TableMetadata[];
/** Profiling data of the tables in the app. */
tables_profiling_data?: TableProfilingData[];
usage?: UsageEnum;
};
/**
* An error object.
*/
type Error = {
/** The error code. */
code: string;
/** A human-readable explanation specific to this occurrence of the problem. */
detail?: string;
/** Additional properties relating to the error. */
meta?: unknown;
/** References to the source of the error. */
source?: {
/** The URI query parameter that caused the error. */
parameter?: string;
/** A JSON Pointer to the property that caused the error. */
pointer?: string;
};
/** Summary of the problem. */
title: string;
};
type Errors = {
errors?: Error[];
};
type EvaluatorError = {
errors?: {
code?: string;
status?: number;
title?: string;
}[];
};
type FieldAttrType = "U" | "A" | "I" | "R" | "F" | "M" | "D" | "T" | "TS" | "IV";
/**
* Sets the formatting of a field.
* The properties of _qFieldAttributes_ and the formatting mechanism are described below.
*
* ### Formatting mechanism
* The formatting mechanism depends on the type set in _qType,_ as shown below:
* <div class=note>In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.</div>
*
* ### Type is DATE, TIME, TIMESTAMP or INTERVAL
* The following applies:
* * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ .
* * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ).
* * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used.
*
* ### Type is INTEGER
* The following applies:
* * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ).
* * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used .
*
* ### Type is REAL
* The following applies:
* * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ).
* * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used.
* * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used.
* * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used.
*
* ### Type is FIX
* The following applies:
* * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ).
* * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used.
*
* ### Type is MONEY
* The following applies:
* * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ).
* * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ).
*
* ### Type is ASCII
* No formatting, _qFmt_ is ignored.
*/
type FieldAttributes = {
/** Defines the decimal separator.
* Example: **.** */
Dec?: string;
/** Defines the format pattern that applies to _qText_ .
* Is used in connection to the type of the field (parameter **qType** ).
* For more information, see _Formatting mechanism_.
* Example: _YYYY-MM-DD_ for a date. */
Fmt?: string;
/** Defines the thousand separator (if any).
* Is used if **qUseThou** is set to 1.
* Example: **,** */
Thou?: string;
Type?: FieldAttrType;
/** Defines whether or not a thousands separator must be used.
* Default is 0. */
UseThou?: number;
/** Number of decimals.
* Default is 10. */
nDec?: number;
};
type FieldInTableProfilingData = {
/** Average of all numerical values. NaN otherwise. */
Average?: number;
/** Average string length of textual values. 0 otherwise. */
AvgStringLen?: number;
/** Number of distinct numeric values */
DistinctNumericValues?: number;
/** Number of distinct text values */
DistinctTextValues?: number;
/** Number of distinct values */
DistinctValues?: number;
/** Number of empty strings */
EmptyStrings?: number;
/** List of tags related to the field. */
FieldTags?: string[];
/** For textual values the first sorted string. */
FirstSorted?: string;
/** The .01, .05, .1, .25, .5, .75, .9, .95, .99 fractiles. Array of NaN otherwise. */
Fractiles?: number[];
FrequencyDistribution?: FrequencyDistributionData;
/** Kurtosis of the numerical values. NaN otherwise. */
Kurtosis?: number;
/** For textual values the last sorted string. */
LastSorted?: string;
/** Maximum value of numerical values. NaN otherwise. */
Max?: number;
/** Maximum string length of textual values. 0 otherwise. */
MaxStringLen?: number;
/** Median of all numerical values. NaN otherwise. */
Median?: number;
/** Minimum value of numerical values. NaN otherwise. */
Min?: number;
/** Minimum string length of textual values. 0 otherwise. */
MinStringLen?: number;
/** Three most frequent values and their frequencies */
MostFrequent?: SymbolFrequency[];
/** Name of the field. */
Name?: string;
/** Number of negative values */
NegValues?: number;
/** Number of null values */
NullValues?: number;
/** Sets the formatting of a field.
* The properties of _qFieldAttributes_ and the formatting mechanism are described below.
*
* ### Formatting mechanism
* The formatting mechanism depends on the type set in _qType,_ as shown below:
* <div class=note>In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.</div>
*
* ### Type is DATE, TIME, TIMESTAMP or INTERVAL
* The following applies:
* * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ .
* * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ).
* * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used.
*
* ### Type is INTEGER
* The following applies:
* * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ).
* * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used .
*
* ### Type is REAL
* The following applies:
* * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ).
* * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used.
* * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used.
* * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used.
*
* ### Type is FIX
* The following applies:
* * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ).
* * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used.
*
* ### Type is MONEY
* The following applies:
* * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ).
* * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ).
*
* ### Type is ASCII
* No formatting, _qFmt_ is ignored. */
NumberFormat?: FieldAttributes;
/** Number of numeric values */
NumericValues?: number;
/** Number of positive values */
PosValues?: number;
/** Skewness of the numerical values. NaN otherwise. */
Skewness?: number;
/** Standard deviation of numerical values. NaN otherwise. */
Std?: number;
/** Sum of all numerical values. NaN otherwise. */
Sum?: number;
/** Squared sum of all numerical values. NaN otherwise. */
Sum2?: number;
/** Sum of all characters in strings in the field */
SumStringLen?: number;
/** Number of textual values */
TextValues?: number;
/** Number of zero values for numerical values */
ZeroValues?: number;
};
type FieldMetadata = {
/** If set to true, the field has one and only one selection (not 0 and not more than 1).
* If this property is set to true, the field cannot be cleared anymore and no more selections can be performed in that field.
* The default value is false. */
always_one_selected?: boolean;
/** Static RAM memory used in bytes. */
byte_size?: number;
/** Number of distinct field values. */
cardinal?: number;
/** Field comment. */
comment?: string;
/** If set to true, only distinct field values are shown.
* The default value is false. */
distinct_only?: boolean;
/** Hash of the data in the field. If the data in a reload is the same, the hash will be consistent. */
hash?: string;
/** If set to true, the field is hidden.
* The default value is false. */
is_hidden?: boolean;
/** If set to true, the field is locked.
* The default value is false. */
is_locked?: boolean;
/** Is set to true if the value is a numeric.
* The default value is false. */
is_numeric?: boolean;
/** If set to true, the field is semantic.
* The default value is false. */
is_semantic?: boolean;
/** If set to true, the field is a system field.
* The default value is false. */
is_system?: boolean;
/** Name of the field. */
name?: string;
/** List of table names. */
src_tables?: string[];
/** Gives information on a field. For example, it can return the type of the field.
* Examples: key, text, ASCII. */
tags?: string[];
/** Total number of field values. */
total_count?: number;
};
type FieldOverride = {
classifications?: string[];
defaultAggregation?: string;
};
type FileData = BodyInit;
type Filter = {
readonly createdAt?: string;
/** The filter description. */
description?: string;
filterType?: FilterType;
filterV1_0?: FilterV10;
filterVersion?: "filter-1.0" | "filter-2.0";
/** The filter ID (bookmarkId). */
readonly id?: string;
/** The filter name. */
name?: string;
/** The user that owns the filter, if missing the same as the request user. */
ownerId?: string;
readonly updatedAt?: string;
};
/**
* Error occured during the Filter creation.
*/
type FilterError = {
/** The unique code for the error
*
* - "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
* - "REP-400008" Selections error.
* - "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
* - "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
* - "REP-401001" Unauthorized, bad JWT.
* - "REP-403000" Forbidden. The client does not have access rights to the content.
* - "REP-403001" App forbidden, the user does not have read permission on the app.
* - "REP-403002" Chart type not supported.
* - "REP-404000" Not found. The server can not find the requested resource.
* - "REP-409043" Filter name conflict. The filter name must be unique.
* - "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
* - "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
* - "REP-429016" Exceeded max session tenant quota per day.
* - "REP-500000" Fail to resolve resource.
* - "REP-503005" Engine unavailable, qix-sessions error no engines available.
* - "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
* - "REP-504042" Context deadline exceeded applying selections of the Filter.
* - "REP-500031" Error creating bookmark.
* - "REP-404032" Bookmark not found after creating the bookmark.
* - "REP-500033" Error destroying bookmark.
* - "REP-404033" Bookmark not found destroying the bookmark.
* - "REP-409043" Dupliacate bookmark name.
* - "REP-429034" Filters quota exceeded.
* - "REP-400044" Missing or renamed field.
* - "REP-403049" Report filter access not allowed. */
code: string;
/** A summary in english explaining what went wrong. */
title: string;
};
/**
* Errors occured during the Filter creation.
*/
type FilterErrors = {
errors: FilterError[];
};
type FilterField = {
/** Gets the resource description. */
description?: string;
name: string;
overrideValues?: boolean;
selectExcluded?: boolean;
/** The filter values. */
values?: FilterFieldValue[];
};
type FilterFieldValue = {
valueAsNumber?: Float64;
valueAsText?: string;
valueType?: "string" | "number" | "evaluate" | "search";
};
type FilterItemPatch = {
/** The filter description. */
description?: string;
filterV1_0?: FilterV10;
filterVersion?: "filter-1.0" | "filter-2.0";
/** The filter name. */
name?: string;
/** The user that owns the filter, if missing the same as the request user. */
ownerId?: string;
};
type FilterList = {
/** a list of filters containing all the filters properties (like name,description...) except the filter definition (like FilterV1_0) */
data: FilterListItem[];
links: LinksResponse;
};
type FilterListItem = {
readonly createdAt?: string;
/** The filter description. */
readonly description?: string;
filterType?: FilterType;
filterV1_0?: FilterV10;
readonly filterVersion?: "filter-1.0" | "filter-2.0";
/** The filter ID (bookmarkId) */
readonly id?: string;
/** The filter name. */
readonly name?: string;
/** The user that owns the filter, if missing the same as the request user. */
readonly ownerId?: string;
readonly updatedAt?: string;
};
type FilterRequest = {
/** The App ID. */
appId?: string;
/** The filter description. */
description?: string;
filterType: FilterType;
filterV1_0?: FilterV10;
filterVersion: "filter-1.0" | "filter-2.0";
/** The filter name. */
name: string;
/** The user that owns the filter, if missing the same as the request user. */
ownerId?: string;
};
type FilterType = "REP" | "SUB";
type FilterV10 = {
/** Map of fields to apply by state. Maximum number of states allowed is 125. Maximum number of fields allowed is 125 and maximum number of overall field values allowed is 150000. */
fieldsByState?: unknown;
/** The filter variables. */
variables?: FilterVariable[];
};
type FilterVariable = {
evaluate?: boolean;
name: string;
value?: string;
};
type FiltersCount = {
/** The total number of filters. */
readonly total?: number;
};
type Float64 = number;
type FrequencyDistributionData = {
/** Bins edges. */
BinsEdges?: number[];
/** Bins frequencies. */
Frequencies?: number[];
/** Number of bins. */
NumberOfBins?: number;
};
type HardwareMeta = {
/** Number of logical cores available. */
logical_cores?: number;
/** RAM available. */
total_memory?: number;
};
type Href = {
href?: string;
};
/**
* Contains dynamic JSON data specified by the client.
*/
type JsonObject = unknown;
type LastReloadMetadata = {
/** Number of CPU milliseconds it took to reload the app. */
cpu_time_spent_ms?: number;
/** Maximum number of bytes used during full reload of the app. */
fullReloadPeakMemoryBytes?: number;
hardware?: HardwareMeta;
/** Maximum number of bytes used during partial reload of the app. */
partialReloadPeakMemoryBytes?: number;
/** Maximum number of bytes used during reload of the app. */
peak_memory_bytes?: number;
};
type LineageInfoRest = {
/** A string indicating the origin of the data:
* * [filename]: the data comes from a local file.
* * INLINE: the data is entered inline in the load script.
* * RESIDENT: the data comes from a resident table. The table name is listed.
* * AUTOGENERATE: the data is generated from the load script (no external table of data source).
* * Provider: the data comes from a data connection. The connector source name is listed.
* * [webfile]: the data comes from a web-based file.
* * STORE: path to QVD or TXT file where data is stored.
* * EXTENSION: the data comes from a Server Side Extension (SSE). */
discriminator?: string;
/** The LOAD and SELECT script statements from the data load script. */
statement?: string;
};
type LinkResponse = {
href?: string;
};
type Links = {
next?: Href;
prev?: Href;
self?: Href;
};
type LinksResponse = {
next: LinkResponse;
prev: LinkResponse;
self: LinkResponse;
};
type Log = {
/** Provides a link to download the log file. */
log?: string;
};
type NavigationLink = {
href?: string;
};
type NavigationLinks = {
next?: NavigationLink;
prev?: NavigationLink;
};
/**
* Application attributes and user privileges.
*/
type NxApp = {
/** App attributes. This structure can also contain extra user-defined attributes. */
attributes?: NxAttributes;
/** Object create privileges. Hints to the client what type of objects the user is allowed to create. */
create?: NxAppCreatePrivileges[];
/** Application privileges.
* Hints to the client what actions the user is allowed to perform.
* Could be any of:
* * read
* * create
* * update
* * delete
* * reload
* * import
* * publish
* * duplicate
* * export
* * exportdata
* * change_owner
* * change_space */
privileges?: string[];
};
type NxAppCreatePrivileges = {
/** Is set to true if the user has privileges to create the resource. */
canCreate?: boolean;
/** Type of resource. For example, sheet, story, bookmark, etc. */
resource?: string;
};
/**
* Application object attributes and user privileges.
*/
type NxAppObject = {
/** App object attributes. This structure can also contain extra user-defined attributes. */
attributes?: NxObjectAttributes;
/** Application object privileges.
* Hints to the client what actions the user is allowed to perform.
* Could be any of:
* * read
* * create
* * update
* * delete
* * publish
* * exportdata
* * change_owner */
privileges?: string[];
};
/**
* App attributes. This structure can also contain extra user-defined attributes.
*/
type NxAttributes = {
/** The date and time when the app was created. */
createdDate?: string;
/** Contains dynamic JSON data specified by the client. */
custom?: JsonObject;
/** App description. */
description?: string;
/** The dynamic color of the app. */
dynamicColor?: string;
/** If set to true, the app is encrypted. */
encrypted?: boolean;
/** If set to true, the app has section access configured, */
hasSectionAccess?: boolean;
/** The App ID. */
id?: string;
/** True if the app is a Direct Query app, false if not */
isDirectQueryMode?: boolean;
/** Date and time of the last reload of the app. */
lastReloadTime?: string;
/** The date and time when the app was modified. */
modifiedDate?: string;
/** App name. */
name?: string;
/** The Origin App ID for published apps. */
originAppId?: string;
/** @deprecated
* Deprecated. Use the Users API to fetch user metadata. */
owner?: string;
/** Identifier of the app owner. */
ownerId?: string;
/** The date and time when the app was published, empty if unpublished. */
publishTime?: string;
/** True if the app is published on-prem, distributed in QCS, false if not. */
published?: boolean;
/** App thumbnail. */
thumbnail?: string;
usage?: UsageEnum;
};
/**
* App object attributes. This structure can also contain extra user-defined attributes.
*/
type NxObjectAttributes = {
/** True if the object is approved. */
approved?: boolean;
/** The date and time when the object was created. */
createdAt?: string;
/** Object description. */
description?: string;
genericType?: AppObjectGenericType;
/** The object Id. */
id?: string;
/** Object name. */
name?: string;
/** The type of the object. */
objectType?: string;
/** The object owner's Id. */
ownerId?: string;
/** The date and time when the object was published, empty if unpublished. */
publishedAt?: string;
/** The date and time when the object was modified. */
updatedAt?: string;
};
type NxPatch = {
Op?: NxPatchOperationType;
/** Path to the property to add, remove or replace. */
Path?: string;
/** This parameter is not used in a remove operation.
* Corresponds to the value of the property to add or to the new value of the property to update.
* Examples:
* "false", "2", "\"New title\"" */
Value?: string;
};
type NxPatchOperationType = "add" | "remove" | "replace";
/**
* Contains break down of the asked question in the form of tokens with their classification.
*/
type PartialNluInfo = {
/** Qlik sense application field selected for given token or phrase */
fieldName?: string;
/** Filter value found from query */
fieldValue?: string;
/** Role of the token or phrase from query */
role?: "dimension" | "measure" | "date";
/** Matching token or phrase from query */
text?: string;
/** Type of token from query */
type?: "field" | "filter" | "master_dimension" | "master_measure" | "custom_analysis";
};
type PatchFilter = PatchFilterItem[];
type PatchFilterItem = {
/** operation (replace). */
op: "replace";
/** A JSON Pointer path (/). */
path: "/filter";
/** The value to be used for this operation. The properties that cannot be patched include id, filterType, appId */
value: {
Filter?: FilterItemPatch;
};
};
type PublishApp = {
attributes?: AppUpdateAttributes;
data?: PublishData;
/** The original is moved instead of copied. The current published state of all objects is kept. */
moveApp?: boolean;
/** If app is moved, originAppId needs to be provided. */
originAppId?: string;
/** The managed space ID where the app will be published. */
spaceId?: string;
};
type PublishData = "source" | "target";
/**
* structure for providing fields in recommendation request, user can retrieve the fields using insight-analyses/model endpoint
*/
type RecommendFieldItem = {
name?: string;
overrides?: FieldOverride;
};
type RecommendItems = {
fields?: RecommendFieldItem[];
libItems?: RecommendMasterItem[];
targetAnalysis?: {
/** id of the target analysis, returned by the GET insight-analyses endpoint */
id?: string;
};
};
/**
* structure for providing master items in recommendation request, user can retrieve the libId of master item using insight-analyses/model endpoint
*/
type RecommendMasterItem = {
libId?: string;
overrides?: {
format?: NumberFormat;
};
};
type RecommendNaturalLangQuery = {
/** The NL query. */
text: string;
};
type RecommendedAnalysis = RecommendedAnalysisCore & {
/** part analyses (only for macro analyses) */
parts?: RecommendedAnalysisCore[];
};
type RecommendedAnalysisCore = {
analysis?: AnalysisDetails;
/** Chart type given to current recommendation */
chartType?: ChartType;
/** (chart options + hypercube definition) */
options?: unknown;
/** percentage of selected items in the analysis to the overall items passed to the endpoint */
relevance?: number;
};
type ReloadIncludeFile = {
/** The connection name. */
connection?: string;
/** File location within the connection. */
path?: string;
/** File QRI resource identifier. */
qri?: string;
};
type ReloadListMetadata = {
/** Array of ReloadMeta. */
data?: ReloadMeta[];
};
type ReloadMeta = {
/** A Base64-encoded hash value of the new section access database. */
accessDbHash?: string;
/** A Base64-encoded hash value of the new app database. */
appDbHash?: string;
/** Duration of reload (ms). */
duration?: number;
/** Time when reload ended. */
endTime?: string;
/** Files brought into the script via include/mustInclude macros. */
includeFiles?: ReloadIncludeFile[];
/** True if the reload is a partial reload. */
isPartialReload?: boolean;
loadDataFilesBytes?: number;
loadExternalBytes?: number;
loadFilesBytes?: number;
/** Reload identifier. */
reloadId?: string;
/** If greater than or equal 0, defines max number of rows loaded from a data source. */
rowLimit?: number;
/** Set to true to skip Store statements.
* The default value is false. */
skipStore?: boolean;
/** List of external loaded or stored statements. */
statements?: ReloadStatements[];
storeDataFilesBytes?: number;
storeFilesBytes?: number;
/** A Base64-encoded hash value of all fields stored via the store statements. */
storeHash?: string;
/** true if the reload was successful. */
success?: boolean;
};
type ReloadStatements = {
/** The connecton name. */
connection?: string;
/** Connection ID. */
connectionId?: string;
/** Data loaded from the network (bytes). */
dataSize?: number;
/** Duration of data generation (ms). */
duration?: number;
/** Label of the resource level node in lineage. */
label?: string;
/** Number of fields loaded. */
nbrOfFields?: number;
/** Number of rows loaded. */
nbrOfRows?: number;
/** Partial load operation. e.g. add/replace/update/merge. n/a when not in partial load mode. */
partialReloadOperation?: string;
/** Resource Identifier. */
qri?: string;
/** Name of the source table in lineage. */
tableName?: string;
/** Type of statement, e.g. Store/Load. */
type?: string;
};
type RepublishApp = {
attributes?: AppUpdateAttributes;
/** Validate that source app is same as originally published. */
checkOriginAppId?: boolean;
data?: PublishData;
/** The target ID to be republished. */
targetId?: string;
};
type ScriptLogList = {
/** Array of scriptLogMeta. */
data?: ScriptLogMeta[];
};
type ScriptLogMeta = {
/** Duration of reload (ms). */
duration?: number;
/** Time when reload ended. */
endTime?: string;
links?: Log;
/** Reload identifier. */
reloadId?: string;
/** True if the reload was successful. */
success?: boolean;
};
type ScriptMeta = {
/** Script version last modification time. */
modifiedTime?: string;
/** User last modifying script version. */
modifierId?: string;
/** Script id. */
scriptId?: string;
/** Script size. */
size?: number;
/** Description of this script version */
versionMessage?: string;
};
type ScriptMetaList = {
links?: NavigationLinks;
/** Script versions metadata. */
scripts?: ScriptMeta[];
};
type ScriptVersion = {
/** Script text. */
script?: string;
/** Description of this script version */
versionMessage?: string;
};
type SimplifiedClassifications = ("dimension" | "measure" | "temporal" | "geographical")[];
type SymbolFrequency = {
/** Frequency of the above symbol in the field */
Frequency?: number;
Symbol?: SymbolValue;
};
type SymbolValue = {
/** Numeric value of the symbol. NaN otherwise. */
Number?: number;
/** String value of the symbol. This parameter is optional and present only if Symbol is a string. */
Text?: string;
};
type TableMetadata = {
/** Static RAM memory used in bytes. */
byte_size?: number;
/** Table comment. */
comment?: string;
/** If set to true, the table is loose due to circular connection.
* The default value is false. */
is_loose?: boolean;
/** If set to true, the table is semantic.
* The default value is false. */
is_semantic?: boolean;
/** If set to true, the table is a system table.
* The default value is false. */
is_system?: boolean;
/** Name of the table. */
name?: string;
/** Number of fields. */
no_of_fields?: number;
/** Number of key fields. */
no_of_key_fields?: number;
/** Number of rows. */
no_of_rows?: number;
};
type TableProfilingData = {
/** Field values profiling info */
FieldProfiling?: FieldInTableProfilingData[];
/** Number of rows in the table. */
NoOfRows?: number;
};
type UpdateApp = {
attributes?: AppUpdateAttributes;
};
type UpdateOwner = {
ownerId?: string;
};
type UpdateSpace = {
spaceId?: string;
};
type UsageEnum = "ANALYTICS" | "DATA_PREPARATION" | "DATAFLOW_PREP" | "SINGLE_TABLE_PREP";
type UserPrivileges = "can_create_app" | "can_import_app" | "can_create_session_app";
type Classification = {
absoluteDiff?: number;
diff?: number;