-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathjsonrpcapi.json
14648 lines (14648 loc) · 713 KB
/
jsonrpcapi.json
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
{
"services": {
"Field": {
"description": "This class describes all the methods that apply at field level.\nThe handle member in the JSON request for all methods listed in this section is the handle of the field.",
"methods": {
"GetCardinal": {
"description": "Retrieves the number of distinct values in a field.",
"responses": [
{
"name": "qReturn",
"description": "<cardinal value>",
"type": "integer",
"format": "int32",
"required": true
}
],
"x-qlik-see-also": [
"[Get the number of distinct values of a field](#csh-get-number-distinct-values-field)"
]
},
"GetAndMode": {
"description": "Returns the AND mode status of a field.",
"responses": [
{
"name": "qReturn",
"description": "<true or false>\n<div class=note>The field is in AND mode if **qReturn** is set to true. </div>",
"type": "boolean",
"required": true
}
],
"x-qlik-see-also": [
"[SetAndMode method](#services-Field-SetAndMode)",
"[Select values in a field](#csh-select-values-in-field)"
]
},
"SelectValues": {
"description": "Selects some values in a field, by entering the values to select.",
"parameters": [
{
"name": "qFieldValues",
"description": "List of the values to select.",
"type": "array",
"required": true,
"schema": {
"$ref": "#/definitions/FieldValue"
}
},
{
"name": "qToggleMode",
"description": "The default value is false.",
"type": "boolean"
},
{
"name": "qSoftLock",
"description": "Set to true to ignore locks; in that case, locked fields can be selected.\nThe default value is false.",
"type": "boolean"
}
],
"responses": [
{
"name": "qReturn",
"description": "true/false\n<div class=note>The operation is successful if qReturn is set to true.</div>",
"type": "boolean",
"required": true
}
],
"x-qlik-see-also": [
"[Select values in a field](#csh-select-values-in-field)"
]
},
"Select": {
"description": "Selects field values matching a search string.",
"parameters": [
{
"name": "qMatch",
"description": "String to search for.\nCan contain wild cards or numeric search criteria.",
"type": "string",
"required": true
},
{
"name": "qSoftLock",
"description": "Set to true to ignore locks; in that case, locked fields can be selected.\nThe default value is false.",
"type": "boolean"
},
{
"name": "qExcludedValuesMode",
"description": "Include excluded values in search.",
"type": "integer",
"format": "int32"
}
],
"responses": [
{
"name": "qReturn",
"description": "true/false\n<div class=note>The operation is successful if qReturn is set to true.</div>",
"type": "boolean",
"required": true
}
]
},
"ToggleSelect": {
"description": "Toggle selects field values matching a search string.",
"parameters": [
{
"name": "qMatch",
"description": "String to search for.\nCan contain wild cards or numeric search criteria.",
"type": "string",
"required": true
},
{
"name": "qSoftLock",
"description": "Set to true to ignore locks; in that case, locked fields can be selected.\nThe default value is false.",
"type": "boolean"
},
{
"name": "qExcludedValuesMode",
"description": "Include excluded values in search.",
"type": "integer",
"format": "int32"
}
],
"responses": [
{
"name": "qReturn",
"description": "true/false\n<div class=note>The operation is successful if qReturn is set to true.</div>",
"type": "boolean",
"required": true
}
],
"x-qlik-see-also": [
"[Toggle select values of a field](#csh-toggle-select-values-of-a-field)"
]
},
"ClearAllButThis": {
"description": "Maintains the selections in the current field while clearing the selections in the other fields.",
"parameters": [
{
"name": "qSoftLock",
"description": "Set to true to ignore locks; in that case, locked fields can be selected.\nThe default value is false.",
"type": "boolean"
}
],
"responses": [
{
"name": "qReturn",
"description": "true/false\n<div class=note>The operation is successful if qReturn is set to true.</div>",
"type": "boolean",
"required": true
}
],
"x-qlik-see-also": [
"[Clear the selections in all fields except the current field](#csh-clear-selections-in-all-fields-except-current-field)"
]
},
"SelectPossible": {
"description": "Selects all possible values in a specific field.",
"parameters": [
{
"name": "qSoftLock",
"description": "Set to true to ignore locks; in that case, locked fields can be selected.\nThe default value is false.",
"type": "boolean"
}
],
"responses": [
{
"name": "qReturn",
"description": "true/false\n<div class=note>The operation is successful if qReturn is set to true.</div>",
"type": "boolean",
"required": true
}
],
"x-qlik-see-also": [
"[Select all possible values of a field](#csh-select-all-possible-values-field)"
]
},
"SelectExcluded": {
"description": "Inverts the current selections.",
"parameters": [
{
"name": "qSoftLock",
"description": "Set to true to ignore locks; in that case, locked fields can be selected.\nThe default value is false.",
"type": "boolean"
}
],
"responses": [
{
"name": "qReturn",
"description": "true/false\n<div class=note>The operation is successful if qReturn is set to true.</div>",
"type": "boolean",
"required": true
}
],
"x-qlik-see-also": [
"[Invert the current selections](#csh-invert-current-selections)"
]
},
"SelectAll": {
"description": "Selects all values of a field. Excluded values are also selected.",
"parameters": [
{
"name": "qSoftLock",
"description": "Set to true to ignore locks; in that case, locked fields can be selected.\nThe default value is false.",
"type": "boolean"
}
],
"responses": [
{
"name": "qReturn",
"description": "true/false\n<div class=note>The operation is successful if qReturn is set to true.</div>",
"type": "boolean",
"required": true
}
],
"x-qlik-see-also": [
"[Select all values of a field](#csh-select-all-values-field)",
"[Create and apply a bookmark](#csh-create-and-apply-bookmark)",
"[Clear the selections of a specific field](#csh-clear-selections-specific-field)"
]
},
"Lock": {
"description": "Locks all selected values of a specific field.",
"responses": [
{
"name": "qReturn",
"description": "<true/false>\n<div class=note>The operation is successful if **Return** is set to true. </div>",
"type": "boolean",
"required": true
}
]
},
"Unlock": {
"description": "Unlocks all selected values of a specific field if the target (or handle ) is a field.",
"responses": [
{
"name": "qReturn",
"description": "<true/false>\n<div class=note>The operation is successful if **Return** is set to true. </div>",
"type": "boolean",
"required": true
}
]
},
"GetNxProperties": {
"description": "Gets the properties of a field.\n\n<div class=note>The property _OneAndOnlyOne_ is set to true if one and only value has been selected in the field prior setting the property. </div>",
"responses": [
{
"name": "qProperties",
"description": "Information about the properties of the field.",
"type": "object",
"required": true,
"schema": {
"$ref": "#/definitions/NxFieldProperties"
}
}
],
"x-qlik-see-also": [
"[Get the properties of a field](#csh-get-properties-field)"
]
},
"SetNxProperties": {
"description": "Sets some properties to a field.",
"parameters": [
{
"name": "qProperties",
"description": "Information about the properties of the field.",
"type": "object",
"required": true,
"schema": {
"$ref": "#/definitions/NxFieldProperties"
}
}
],
"x-qlik-see-also": [
"[Set the properties of a field](#csh-set-properties-field)"
]
},
"SetAndMode": {
"description": "Sets a field in the AND mode.",
"parameters": [
{
"name": "qAndMode",
"description": "Specifies if the AND mode applies to the field.\nSet this parameter to true to enter the AND mode.",
"type": "boolean",
"required": true
}
],
"x-qlik-see-also": [
"[GetAndMode method](#services-Field-GetAndMode)"
]
},
"SelectAlternative": {
"description": "Selects all alternatives values in a specific field.\n<div class=note>In a field that contains at least one selected value, the values that are neither selected nor excluded are alternatives values.</div>",
"parameters": [
{
"name": "qSoftLock",
"description": "Set to true to ignore locks; in that case, locked fields can be selected.\nThe default value is false.",
"type": "boolean"
}
],
"responses": [
{
"name": "qReturn",
"description": "true/false\n<div class=note>The operation is successful if qReturn is set to true.</div>",
"type": "boolean",
"required": true
}
],
"x-qlik-see-also": [
"[Select all alternative values of a field](#csh-select-alternative-values-field)"
]
},
"LowLevelSelect": {
"description": "Selects some values in a field, by entering the element numbers related to the values to select.",
"parameters": [
{
"name": "qValues",
"description": "Indexes (or element numbers) of the values to select.",
"type": "array",
"required": true,
"items": {
"type": "integer",
"format": "int32"
}
},
{
"name": "qToggleMode",
"description": "Set to true to keep any selections present in the list object.\nIf this parameter is set to false, selections made before accepting the list object search become alternative.",
"type": "boolean",
"required": true
},
{
"name": "qSoftLock",
"description": "Set to true to ignore locks; in that case, locked fields can be selected.\nThe default value is false.",
"type": "boolean"
}
],
"responses": [
{
"name": "qReturn",
"description": "true/false\n<div class=note>The operation is successful if qReturn is set to true.</div>",
"type": "boolean",
"required": true
}
]
},
"Clear": {
"description": "Clears the selections in a specific field.",
"responses": [
{
"name": "qReturn",
"description": "<true/false>\n<div class=note>The operation is successful if **qReturn** is set to true. </div>",
"type": "boolean",
"required": true
}
]
}
}
},
"Variable": {
"description": "This class describes all the methods that apply at variable level.\n<div class=note>Methods in this class are deprecated. Use methods in the _GenericVariableClass_ instead. </div>\nThe _handle_ member in the JSON request for all methods listed in this section is the handle of the variable.",
"methods": {
"GetContent": {
"description": "Returns the calculated value of a variable.",
"deprecated": true,
"responses": [
{
"name": "qContent",
"description": "Information about the calculated value.",
"type": "object",
"required": true,
"schema": {
"$ref": "#/definitions/AlfaNumString"
}
}
],
"x-qlik-deprecation-description": "Use _GenericVariable::GetProperties_ method instead"
},
"GetRawContent": {
"description": "Returns the raw value of a variable.",
"deprecated": true,
"responses": [
{
"name": "qReturn",
"description": "<Definition of the variable>",
"type": "string",
"required": true
}
],
"x-qlik-deprecation-description": "Use _GenericVariable::GetProperties_ method instead"
},
"SetContent": {
"description": "Sets a value to a variable.",
"deprecated": true,
"parameters": [
{
"name": "qContent",
"description": "Value of the variable.",
"type": "string",
"required": true
},
{
"name": "qUpdateMRU",
"description": "If set to true, the value is added to the Most Recently Used (MRU) list.",
"type": "boolean",
"required": true
}
],
"responses": [
{
"name": "qReturn",
"description": "true/false\n<div class=note>The operation is successful if qReturn is set to true.</div>",
"type": "boolean",
"required": true
}
],
"x-qlik-deprecation-description": "Use _GenericVariable::SetProperties_ method instead"
},
"ForceContent": {
"description": "Sets the value of a dual variable overriding any input constraints.",
"deprecated": true,
"parameters": [
{
"name": "qs",
"description": "String representation of a dual value.\nSet this parameter to \"\", if the string representation is to be Null.",
"type": "string",
"required": true
},
{
"name": "qd",
"description": "Numeric representation of a dual value.",
"type": "number",
"format": "double",
"required": true
}
],
"x-qlik-deprecation-description": "Use _GenericVariable::SetProperties_ method instead"
},
"GetNxProperties": {
"description": "Gets the properties of a variable.",
"deprecated": true,
"responses": [
{
"name": "qProperties",
"description": "Information about the properties of the variable.",
"type": "object",
"required": true,
"schema": {
"$ref": "#/definitions/NxVariableProperties"
}
}
],
"x-qlik-deprecation-description": "Use _GetProperties_ method instead",
"x-qlik-see-also": [
"[Get the properties of a variable](#csh-get-properties-variable)"
]
},
"SetNxProperties": {
"description": "Sets some properties to a variable.",
"deprecated": true,
"parameters": [
{
"name": "qProperties",
"description": "Information about the properties of the variable",
"type": "object",
"required": true,
"schema": {
"$ref": "#/definitions/NxVariableProperties"
}
}
],
"x-qlik-deprecation-description": "Use _SetProperties_ method instead"
}
}
},
"GenericObject": {
"description": "This class describes all the methods that apply at generic object level.\nThe _handle_ member in the JSON request for all methods listed in this section is the handle of the generic object.",
"methods": {
"GetLayout": {
"description": "Evaluates an object and displays its properties including the dynamic properties.\nIf the member _delta_ is set to true in the request object, only the delta is evaluated. A _GetLayout_ call on a generic object, returns up to one level down in the hierarchy.\n\n### Example:\n_A_ is a generic object and is the parent of the objects B and C. _B_ is the parent of the objects D and E.\n<br><br>\nA _GetLayout_ call on A returns information on the objects A, B and C.\nA _GetLayout_ call on B returns information on the objects B, D and E.\nA _GetLayout_ call on C returns information on the object C.\n\n<div class=note>\nIn addition to the parameters displayed above, the **GetLayout** method can return other properties according to what is defined in the generic object.\nFor example, if **qHyperCubeDef** is defined in the generic object, the **GetLayout** method returns the properties described in _HyperCube_.\n</div>",
"responses": [
{
"name": "qLayout",
"description": "Information on the object.",
"type": "object",
"required": true,
"schema": {
"$ref": "#/definitions/GenericObjectLayout"
}
}
],
"x-qlik-see-also": [
"[Get the layout of a bookmark](#csh-get-layout-bookmark)",
"[List the dimensions in an app](#csh-list-dimensions-in-app)",
"[List the fields in an app](#csh-list-fields-in-app)",
"[List the measures in an app](#csh-list-measures-in-app)",
"[Get the delta of the layout](#csh-get-delta-layout)",
"[Get the layout of a generic object](#csh-get-layout-generic-object)"
]
},
"GetListObjectData": {
"description": "Retrieves the values of a list object.\nA data set is returned.",
"parameters": [
{
"name": "qPath",
"description": "Path to the definition of the object to be selected.\nFor example, _/qListObjectDef_ .",
"type": "string",
"required": true
},
{
"name": "qPages",
"description": "Array of pages you are interested in.",
"type": "array",
"required": true,
"schema": {
"$ref": "#/definitions/NxPage"
}
}
],
"responses": [
{
"name": "qDataPages",
"description": "A data set.",
"type": "array",
"required": true,
"schema": {
"$ref": "#/definitions/NxDataPage"
}
}
],
"x-qlik-see-also": [
"[Get the values of a list object](#csh-get-values-listbox)"
]
},
"GetHyperCubeData": {
"description": "Retrieves the calculated data for a chart, a table, or a scatter plot. It is possible to retrieve specific pages of data.\n<div class=note>This method works for a hypercube in DATA_MODE_STRAIGHT.</div>\nA data set is returned.",
"parameters": [
{
"name": "qPath",
"description": "Path to the definition of the object to be selected.\nFor example, _/qHyperCubeDef_ .",
"type": "string",
"required": true
},
{
"name": "qPages",
"description": "Array of pages to retrieve.",
"type": "array",
"required": true,
"schema": {
"$ref": "#/definitions/NxPage"
}
}
],
"responses": [
{
"name": "qDataPages",
"description": "A data set",
"type": "array",
"required": true,
"schema": {
"$ref": "#/definitions/NxDataPage"
}
}
],
"x-qlik-see-also": [
"[Add attribute expressions to a measure](#csh-add-attribute-expressions-to-measure)",
"[Get the values of a chart, a table or a scatter plot](#csh-get-values-chart-table)"
]
},
"GetHyperCubeReducedData": {
"description": "Reduces the data of a bar chart, a line chart or a scatter plot chart and retrieves them.\nThe reduction is dependent on the zoom factor (parameter _qZoomFactor_ ) and on the reduction mode.\n<div class=note>This method can be used to create mini charts.</div>\n\n### Bar chart or line chart data reduction\nFor the data reduction to happen, the following conditions must be fulfilled:\n* The values cannot fit in the defined page (parameter _qPages_ ).\n* The zoom factor is not 0 (parameter _qZoomFactor_ ).\n* The reduction mode must be set to D1.\n\nThe reduction algorithm keeps the shape of the visualizations and works whatever the number of dimensions in the chart. The global profile of the chart is reduced, and not only a specific dimension. A visualization that has been reduced contains fewer values but its shape is the same. Data of all types can be reduced. Therefore it is hard to relate the values before and after a reduction especially when reducing string values.\n\n### Example\nIf you have a chart with 1 million data, and you have set the zoom factor to 5, the _GetHyperCubeReducedData_ method reduces the chart and retrieves 200 000 data.\n\n### Scatter plot chart data reduction\nThe reduction mode must be set to C.\nThis reduction mechanism follows the 2D K-Means algorithm. Data are reduced into a number of clusters. Each data is assigned to a specific centroid.\nThe number of centroids can be defined in the parameter _qZoomFactor_.\n\n### Scatter plot chart resolution reduction\nThe reduction mode must be set to S.\nThe resolution is reduced according to the zoom factor (parameter _qZoomFactor_ ).\n\n### Example\nIf you have a scatter plot chart and the zoom factor is set to 2, the scatter plot chart resolution is reduced by 4.",
"parameters": [
{
"name": "qPath",
"description": "Path to the definition of the object to be selected.\nFor example, _/qHyperCubeDef_ .",
"type": "string",
"required": true
},
{
"name": "qPages",
"description": "Array of pages.",
"type": "array",
"required": true,
"schema": {
"$ref": "#/definitions/NxPage"
}
},
{
"name": "qZoomFactor",
"description": "Defines the zoom factor.\nIf set to -1, the engine decides of the zoom factor.\n* If the reduction mode is _D1_ or _S_ , the zoom factor is 2ⁿ. If the zoom factor is 5, the data are reduced by a factor 32.\n* If the reduction mode is _C_ , the zoom factor defines the number of centroids.",
"type": "integer",
"format": "int32",
"required": true
},
{
"name": "qReductionMode",
"description": "Defines the reduction mode.\n\nOne of:\n* N or DATA_REDUCTION_NONE\n* D1 or DATA_REDUCTION_ONEDIM\n* S or DATA_REDUCTION_SCATTERED\n* C or DATA_REDUCTION_CLUSTERED\n* ST or DATA_REDUCTION_STACKED",
"type": "string",
"required": true,
"items": {
"enum": [
"DATA_REDUCTION_NONE",
"DATA_REDUCTION_ONEDIM",
"DATA_REDUCTION_SCATTERED",
"DATA_REDUCTION_CLUSTERED",
"DATA_REDUCTION_STACKED"
]
}
}
],
"responses": [
{
"name": "qDataPages",
"description": "A data set.",
"type": "array",
"required": true,
"schema": {
"$ref": "#/definitions/NxDataPage"
}
}
],
"x-qlik-see-also": [
"[Reduce the values of a chart](#csh-reduce-values-chart)"
]
},
"GetHyperCubePivotData": {
"description": "Retrieves the values of a pivot table. It is possible to retrieve specific pages of data.\n<div class=note>This method works for a hypercube in DATA_MODE_PIVOT.</div>",
"parameters": [
{
"name": "qPath",
"description": "Path to the definition of the object to be selected.\nFor example, _/qHyperCubeDef_ .",
"type": "string",
"required": true
},
{
"name": "qPages",
"description": "Array of pages to retrieve.",
"type": "array",
"required": true,
"schema": {
"$ref": "#/definitions/NxPage"
}
}
],
"responses": [
{
"name": "qDataPages",
"description": "A data set.",
"type": "array",
"required": true,
"schema": {
"$ref": "#/definitions/NxPivotPage"
}
}
],
"x-qlik-see-also": [
"[Get the values of a pivot table](#csh-get-values-pivot-table)",
"[Sort by the values of a measure in a pivot table](#csh-sort-by-values-of-measure-in-pivot)"
]
},
"GetHyperCubeStackData": {
"description": "Retrieves the values of a stacked pivot table. It is possible to retrieve specific pages of data.\n<div class=note>This method works for a hypercube in DATA_MODE_PIVOT_STACK.</div>",
"parameters": [
{
"name": "qPath",
"description": "Path to the definition of the object to be selected.\nFor example, _/qHyperCubeDef_ .",
"type": "string",
"required": true
},
{
"name": "qPages",
"description": "Array of pages to retrieve.",
"type": "array",
"required": true,
"schema": {
"$ref": "#/definitions/NxPage"
}
},
{
"name": "qMaxNbrCells",
"description": "Maximum number of cells at outer level.\nThe default value is 10 000.",
"type": "integer",
"format": "int32"
}
],
"responses": [
{
"name": "qDataPages",
"description": "A data set.",
"type": "array",
"required": true,
"schema": {
"$ref": "#/definitions/NxStackPage"
}
}
],
"x-qlik-see-also": [
"[Get the values of a stacked table](#csh-get-values-stacked-table)",
"[Sort by the values of a measure in a stacked pivot table](#csh-sort-by-values-of-measure-in-stacked-pivot)"
]
},
"GetHyperCubeContinuousData": {
"description": "Retrieves and packs compressed hypercube and axis data. It is possible to retrieve specific pages of data.\n<div class=note>Binning is done on the time stamp data as well as the date. This means that you can zoom in to a level of granularity as low as seconds.</div>",
"parameters": [
{
"name": "qPath",
"description": "Path to the definition of the object.\nFor example, _/qHyperCubeDef_ .",
"type": "string",
"required": true
},
{
"name": "qOptions",
"description": "Defines the data to return.",
"type": "object",
"required": true,
"schema": {
"$ref": "#/definitions/NxContinuousDataOptions"
}
},
{
"name": "qReverseSort",
"description": "If set to true the returned data pages are reverse sorted.\nOptional.",
"type": "boolean"
}
],
"responses": [
{
"name": "qDataPages",
"description": "Array of pages to retrieve.\nThe dimension values and the measure values.",
"type": "array",
"required": true,
"schema": {
"$ref": "#/definitions/NxDataPage"
}
},
{
"name": "qAxisData",
"description": "List of x-axis data including name, ticks and tags.\nOnly days are returned, not time.",
"type": "object",
"required": true,
"schema": {
"$ref": "#/definitions/NxAxisData"
}
}
]
},
"GetHyperCubeTreeData": {
"description": "Retrieves data for nodes in a tree structure. It is possible to retrieve specific pages of data.\n<div class=note>This method works for a treedata object or a hypercube in DATA_MODE_TREE.</div>",
"parameters": [
{
"name": "qPath",
"description": "Path to the definition of the object to be selected.",
"type": "string",
"required": true
},
{
"name": "qNodeOptions",
"description": "Specifies all the paging filters needed to define the tree to be fetched. If left out the complete tree is returned.",
"type": "object",
"schema": {
"$ref": "#/definitions/NxTreeDataOption"
}
}
],
"responses": [
{
"name": "qNodes",
"description": "Represents the nodes and dimensions of the defined tree.",
"type": "array",
"required": true,
"schema": {
"$ref": "#/definitions/NxTreeNode"
}
}
],
"x-qlik-stability": "experimental"
},
"GetHyperCubeBinnedData": {
"description": "This method supports data binning.\nWhen a generic object with two or three measures and one dimension contains a lot of data, groups of points (for example, cells) can be rendered instead of points.\nA zone of interest can be refined (for zooming in) up to a maximum refinement level (set in the _qQueryLevel_ parameter) or coarsened (for zoom out).\nThe grid of cells is adaptive (not static), meaning that it adapts to different length scales.\nThe _GetHyperCubeBinnedData_ method gives information about the adaptive grid and the values of the generic object.\nThe number of points in a cell and the coordinates (expressed in the measure range) of each cell are returned.\nDimension values and measure values are rendered at point level (highest detailed level).\n<div class=note>The generic object should contain two or three measures and one dimension. When the refinement is high, the first two measures are represented on the x-axis and on the y-axis, while the third measure is visualized as color or point size.</div>\n\n### Adaptive Grid\nMore details about the properties of the adaptive grid are given in this paragraph.\nWhen the refinement is not the highest (cells are rendered), information about the adaptive grid is returned through several arrays.\nThe first array contains the following properties:\n<table>\n<tr>\n<th>Name</th>\n<th>Description</th>\n<th>Type</th>\n</tr>\n<tr>\n<td>qNum</td>\n<td>Maximum number of points that a cell can contain.</td>\n<td>String</td>\n</tr>\n<tr>\n<td>qElemNumber</td>\n<td>Is set to 0.</td>\n<td>Boolean</td>\n</tr>\n<tr>\n<td>qState</td>\n<td>The default value is L.</td>\n<td>One of:\n<ul>\n<li>L for Locked</li>\n<li>S for Selected</li>\n<li>O for Optional</li>\n<li>D for Deselected</li>\n<li>A for Alternative</li>\n<li>X for eXcluded</li>\n<li>XS for eXcluded Selected</li>\n<li>XL for eXcluded Locked</li>\n</ul>\n</td>\n</tr>\n</table>\n\nThe next arrays give the coordinates of each cell in the page.\nEach array contains the following properties:\n<table>\n<tr>\n<th>Name</th>\n<th>Description</th>\n<th>Type</th>\n</tr>\n<tr>\n<td>qText</td>\n<td>Coordinates of a cell in the measure range.<br>“qText”: “[[<left>, <top>, <right>, <bottom>], [<left>, <top>, <right>, <bottom>], .... [<left>, <top>, <right>, <bottom>]]<br>Where:<br>< <i>left</i> >, <i>< top</i> >, < <i>right</i> > and < <i>bottom</i> > are the coordinates of the cell in the measure range.</td>\n<td>String</td>\n</tr>\n<tr>\n<td>qNum</td>\n<td>Number of points in the cell.</td>\n<td>Double precision floating point</td>\n</tr>\n<tr>\n<td>qElemNumber</td>\n<td>Unique identifier for each cell, calculated by the engine during the construction of the grid.<br>This element number is not stored in the database and can have a positive or a negative value.</td>\n<td>Integer</td>\n</tr>\n<tr>\n<td>qState</td>\n<td>The default value is L.</td>\n<td>One of:\n<ul>\n<li>L for Locked</li>\n<li>S for Selected</li>\n<li>O for Optional</li>\n<li>D for Deselected</li>\n<li>A for Alternative</li>\n<li>X for eXcluded</li>\n<li>XS for eXcluded Selected</li>\n<li>XL for eXcluded Locked</li>\n</ul>\n</td>\n</tr>\n</table>\n\n<div class=note>Cells are represented as rectangles.</div>\n\n### Dimension values and measures values\nMore details about the properties, when dimension and measure values are returned, are given in this paragraph.\nWhen the refinement is high, points are rendered (not cells) and dimension and measure values for each cell are returned.\nThe first array is empty because no information on the adaptive grid is needed.\nThe next arrays bring information about the dimension and the measure values.\n<table>\n<tr>\n<th>Name</th>\n<th>Description</th>\n<th>Type</th>\n</tr>\n<tr>\n<td>qText</td>\n<td>Text value of the dimension or the measure.</td>\n<td>String</td>\n</tr>\n<tr>\n<td>qNum</td>\n<td>Numerical value of the dimension or the measure.<br>Is set to 0 if the value is only text.</td>\n<td>Double precision floating point</td>\n</tr>\n<tr>\n<td>qElemNumber</td>\n<td>Unique identifier for each cell, calculated by the engine during the construction of the grid.<br>This element number is not stored in the database and can have a positive or a negative value.</td>\n<td>Integer</td>\n</tr>\n<tr>\n<td>qState</td>\n<td>The default value is L.</td>\n<td>One of:\n<ul>\n<li>L for Locked</li>\n<li>S for Selected</li>\n<li>O for Optional</li>\n<li>D for Deselected</li>\n<li>A for Alternative</li>\n<li>X for eXcluded</li>\n<li>XS for eXcluded Selected</li>\n<li>XL for eXcluded Locked</li>\n</ul>\n</td>\n</tr>\n</table>",
"parameters": [
{
"name": "qPath",
"description": "Path to the definition of the object.\nFor example, _/qHyperCubeDef_ .",
"type": "string",
"required": true
},
{
"name": "qPages",
"description": "Array of pages to retrieve.\nSince the generic object contains two measures and one dimension, _qWidth_ should be set to 3.\nIf the value of a measure is Null, the value cannot be rendered. Therefore, the number of elements rendered in a page can be less than the number defined in the property _qHeight_ .",
"type": "array",
"required": true,
"schema": {
"$ref": "#/definitions/NxPage"
}
},
{
"name": "qViewport",
"description": "Defines the canvas and the zoom level.\nThis parameter is not yet used and is optional.",
"type": "object",
"required": true,
"schema": {
"$ref": "#/definitions/NxViewPort"
}
},
{
"name": "qDataRanges",
"description": "Range of the data to render.\nThis range applies to the measure values.\nThe lowest and highest values of a measure can be retrieved by using the _GetLayout method_ (in _/qHyperCube/qMeasureInfo_ ).",
"type": "array",
"required": true,
"schema": {
"$ref": "#/definitions/NxDataAreaPage"
}
},
{
"name": "qMaxNbrCells",
"description": "Maximum number of cells in the grid.",
"type": "integer",
"format": "int32",
"required": true
},
{
"name": "qQueryLevel",
"description": "Level of details. The higher the level, the more detailed information you get (zoom-in).\nWhen the number of points to render falls below a certain threshold, the values are no longer rendered as cells but as points.\nThe query level should be no greater than 20.",
"type": "integer",
"format": "int32",
"required": true
},
{
"name": "qBinningMethod",
"description": "Selects the algorithm.\nThe default value is 0.\nOne of:\n* 0: Adaptive grid\n* 1: Hexagonal grid\n* 2: Uniform grid",
"type": "integer",
"format": "int32",
"required": true
}
],
"responses": [
{
"name": "qDataPages",
"description": "Information about the data set.\nDepending on the refinement level, the information is about:\n* The adaptive grid. Occurs when cells are rendered and not points.\nor\n* The dimension values and the measure values. Occurs when the level of detail is high (points are rendered).",
"type": "array",
"required": true,
"schema": {
"$ref": "#/definitions/NxDataPage"
}
}
],
"x-qlik-see-also": [
"[Get the adaptive grid and the values of a generic object](#csh-get-adaptive-grid-values-generic-object)"
]
},
"ApplyPatches": {
"description": "Applies a patch to the properties of an object. Allows an update to some of the properties.\nIt is possible to apply a patch to the properties of a generic object, that is not persistent. Such a patch is called a soft patch.\nIn that case, the result of the operation on the properties (add, remove or delete) is not shown when doing _GetProperties_ , and only a _GetLayout_ call shows the result of the operation.\nProperties that are not persistent are called soft properties. Once the engine session is over, soft properties are cleared.\n<div class=note>Soft properties apply only to generic objects.</div>",
"parameters": [
{
"name": "qPatches",
"description": "Array of patches.",
"type": "array",
"required": true,
"schema": {
"$ref": "#/definitions/NxPatch"
}
},
{
"name": "qSoftPatch",
"description": "If set to true, it means that the properties to be applied are not persistent. The patch is a soft patch.\nThe default value is false.",
"type": "boolean"
}
],
"x-qlik-see-also": [
"[Add some properties to an object](#csh-add-properties)",
"[Remove some properties](#csh-remove-properties)",
"[Update some properties of an object](#csh-update-properties)"
]
},
"ClearSoftPatches": {
"description": "Clears the soft properties of a generic object.\nFor more information on how to add soft properties to a generic object, see _ApplyPatches Method_.",
"x-qlik-see-also": [
"[Remove a soft patch or soft properties](#csh-remove-soft-patch)"
]
},
"SetProperties": {
"description": "Sets some properties for a generic object.\n<div class=note>The properties depends on the generic object type, see [properties](genericobject-property.html).</div>",
"parameters": [
{
"name": "qProp",
"description": "Information about the generic object.",
"type": "object",
"required": true,
"schema": {
"$ref": "#/definitions/GenericObjectProperties"
}
}
],
"x-qlik-see-also": [
"[Set the properties of a bookmark](#csh-set-properties-bookmark)",
"[Set the properties of an object](#csh-set-properties)",
"[SetFullPropertyTree method](#services-GenericObject-SetFullPropertyTree)"
]
},
"GetProperties": {
"description": "Returns the identifier, the type and the properties of the object.\nBecause it is not mandatory to set all properties when you define an object, the _GetProperties_ method may show properties that were not set. In that case, default values are given.\nIf the object contains some soft properties, the soft properties are not returned by the _GetProperties_ method. Use the _GetEffectiveProperties method_ instead.\nIf the object is linked to another object, the properties of the linking object are not returned by the _GetProperties_ method. Use the _GetEffectiveProperties method_ instead.\n<div class=note>The properties depends on the generic object type, see [properties](genericobject-layout.html).</div>\n<div class=note>If the member delta is set to true in the request object, only the delta is retrieved.</div>",
"responses": [
{
"name": "qProp",
"description": "Information about the generic object.",
"type": "object",
"required": true,
"schema": {
"$ref": "#/definitions/GenericObjectProperties"
}
}
],
"x-qlik-see-also": [
"[Set the properties of a bookmark](#csh-set-properties-bookmark)",
"[Get the delta of properties](#csh-get-delta-properties)",
"[Get the properties of an object](#csh-get-properties)",
"[Set the properties of an object](#csh-set-properties)"
]
},
"GetEffectiveProperties": {
"description": "Returns the identifier, the type and the properties of the object.\nIf the object contains some soft properties, the soft properties are returned.\nIf the object is linked to another object, the properties of the linking object are returned.\nGetEffectiveProperties method\nReturns the identifier, the type and the properties of the object.\nIf the object contains some soft properties, the soft properties are returned.\nIf the object is linked to another object, the properties of the linking object are returned.",
"responses": [
{
"name": "qProp",
"description": "Information about the generic object.",
"type": "object",
"required": true,
"schema": {
"$ref": "#/definitions/GenericObjectProperties"
}
}
],
"x-qlik-see-also": [
"[Get the properties of an object](#csh-get-properties)",
"[GetProperties method](#services-GenericObject-GetProperties)"
]
},
"SetFullPropertyTree": {
"description": "Sets the properties of:\n* A generic object.\n* The children of the generic object.\n* The bookmarks/embedded snapshots of the generic object.\n\n<div class=note>If the _SetFullPropertyTree method_ is asked to set some properties to a child that does not exist, it creates the child. </div> <div class=note>The type of an object cannot be updated.</div>",
"parameters": [
{
"name": "qPropEntry",
"description": "Information about the generic object entry.",
"type": "object",
"required": true,
"schema": {
"$ref": "#/definitions/GenericObjectEntry"
}
}
],
"x-qlik-see-also": [
"[Set the properties of an object](#csh-set-properties)"
]
},
"GetFullPropertyTree": {
"description": "Gets the properties of:\n* A generic object.\n* The children of the generic object.\n* The bookmarks/embedded snapshots of the generic object.",
"responses": [
{
"name": "qPropEntry",
"description": "Information about the properties.",
"type": "object",
"required": true,
"schema": {
"$ref": "#/definitions/GenericObjectEntry"
}
}
],
"x-qlik-see-also": [
"[Set the properties of an object](#csh-set-properties)"
]
},
"GetInfo": {
"description": "Returns the type and identifier of the object.",
"responses": [
{
"name": "qInfo",
"description": "{ \"qId\": \"<identifier>\", \"qType\": \"<type>\" }",
"type": "object",
"required": true,
"schema": {
"$ref": "#/definitions/NxInfo"
}
}
]
},
"ClearSelections": {
"description": "Clears the selections in a dimension of a visualization.",
"parameters": [
{
"name": "qPath",
"description": "Path to the definition of the visualization.\nFor example, _/qListObjectDef_ .",
"type": "string",
"required": true
},
{
"name": "qColIndices",
"description": "Array of dimension numbers or indexes. The selections are cleared in the specified dimensions.\nDimension numbers/indexes start from 0.\nIf this parameter is not set, all dimensions are cleared.",
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}