-
Notifications
You must be signed in to change notification settings - Fork 12
/
Copy pathapi-spec.json
18464 lines (18464 loc) · 723 KB
/
api-spec.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
{
"oappy": "0.0.1",
"info": {
"name": "enigma",
"go-package-name": "enigma",
"go-package-import-path": "github.com/qlik-oss/enigma-go/v4",
"version": "latest",
"description": "enigma-go is a library that helps you communicate with a Qlik Associative Engine.",
"license": "MIT"
},
"x-qlik-visibility": "public",
"x-qlik-stability": "locked",
"definitions": {
"AlfaNumString": {
"deprecated": true,
"x-qlik-deprecation-description": "This will be removed in a future version",
"type": "struct",
"entries": {
"IsNum": {
"description": "Is set to true if the value is a numeric.",
"type": "bool"
},
"String": {
"description": "Calculated value.",
"type": "string"
}
}
},
"AlternateStateData": {
"type": "struct",
"entries": {
"FieldItems": {
"description": "List of the selections.",
"type": "slice",
"items": {
"type": "#/definitions/BookmarkFieldItem"
}
},
"StateName": {
"description": "Name of the alternate state.\nDefault is current selections: $",
"type": "string"
}
}
},
"AppEntry": {
"type": "struct",
"entries": {
"FileSize": {
"type": "int"
},
"HasSectionAccess": {
"description": "If true the app has section access configured.",
"type": "bool"
},
"ID": {
"description": "Identifier of the app.",
"type": "string"
},
"LastReloadTime": {
"description": "Last reload time of the app.",
"type": "string"
},
"Meta": {
"description": "Meta data.",
"type": "#/definitions/NxMeta"
},
"Path": {
"description": "Path of the app.",
"type": "string"
},
"ReadOnly": {
"description": "Is set to true if the app is read-only.",
"type": "bool"
},
"Thumbnail": {
"description": "App thumbnail.",
"type": "#/definitions/StaticContentUrl"
},
"Title": {
"description": "Title of the app.",
"type": "string"
}
}
},
"AppObjectList": {
"description": "Lists the app objects. Is the layout for AppObjectListDef.\nAn app object is a generic object created at app level.",
"type": "struct",
"entries": {
"Items": {
"description": "Information about the list of dimensions.",
"type": "slice",
"items": {
"type": "#/definitions/NxContainerEntry"
}
}
}
},
"AppObjectListDef": {
"description": "Defines the list of objects in an app.\nAn app object is a generic object created at app level.",
"type": "struct",
"entries": {
"Data": {
"description": "Data that you want to include in the app list definition.\nYou need to enter the paths to the information you want to retrieve.",
"type": "https://golang.org/pkg/encoding/json/RawMessage"
},
"Type": {
"description": "Type of the app list.",
"type": "string"
}
}
},
"AppScript": {
"type": "struct",
"entries": {
"IsLocked": {
"description": "True if user is temporarily locked from modifying the script. Meta contains the ID of the last modifier. Only applicable to QCS.",
"type": "bool"
},
"Meta": {
"description": "Information about publishing and permissions.\nThis parameter is optional.",
"type": "#/definitions/NxMeta"
},
"Script": {
"description": "Script text.",
"type": "string"
}
}
},
"AppScriptMeta": {
"x-qlik-stability": "experimental",
"type": "struct",
"entries": {
"IsLocked": {
"description": "True if user is temporarily locked from modifying the script. Meta contains the ID of the last modifier. Only applicable to QCS.",
"type": "bool"
},
"Meta": {
"description": "Information about publishing and permissions.\nThis parameter is optional.",
"type": "#/definitions/NxMeta"
}
}
},
"ApplyGroupStateWarning": {
"x-qlik-stability": "experimental",
"type": "struct",
"entries": {
"State": {
"description": "Group state that could not be applied.",
"type": "#/definitions/GroupState"
},
"Type": {
"description": "Nature of the warning.\n\nOne of:\n\n• group_missing or GROUP_MISSING\n\n• group_not_applicable or GROUP_NOT_APPLICABLE\n\n• fielddef_missing or FIELDDEF_MISSING",
"type": "string"
}
}
},
"ApplyGroupStatesResult": {
"description": "Result of applying GroupState to multiple cyclic groups.",
"x-qlik-stability": "experimental",
"type": "struct",
"entries": {
"ApplySuccess": {
"description": "When true, the operation was successful.",
"type": "bool"
},
"Warnings": {
"description": "Lists which states failed to be applied and why.",
"type": "slice",
"items": {
"type": "#/definitions/ApplyGroupStateWarning"
}
}
}
},
"ArrayOfNxValuePoint": {
"type": "slice",
"items": {
"type": "#/definitions/NxPivotValuePoint"
}
},
"AssociationScore": {
"type": "struct",
"entries": {
"Field1Scores": {
"description": "Association information about the field FieldName1 defined in qFieldPairName .",
"type": "#/definitions/FieldScores"
},
"Field2Scores": {
"description": "Association information about the field FieldName2 defined in qFieldPairName .",
"type": "#/definitions/FieldScores"
},
"FieldPairName": {
"description": "Pair of fields.\n_\u003c FieldName1\u003e_ / \u003c FieldName2\u003e\nWhere:\n\u003c FieldName1 \u003e is a field in the table 1 (defined in qTable1 )\n\u003c FieldName2 \u003e is a field in the table 2 (defined in qTable2 )\nIf the field is a synthetic key, the name of the field is preceded by [Synthetic key]: .",
"type": "string"
},
"ScoreSummary": {
"description": "Flag used to interpret calculated scores.\nOne of the following values or sum of values that apply:\n\n• 0: The cardinal ratio cannot be zero but the symbol score and the row score can be zero.\n\n• -1: The fields do not have the same type.\n\n• -2: The number of rows of the field FieldName1 is zero.\n\n• -4: The number of distinct values of the field FieldName1 is zero.\n\n• -8: The number of rows of the field FieldName2 is zero.\n\n• -16: The number of distinct values of the field FieldName2 is zero.\n\nExample:\nThe number of rows of the field FieldName1 is zero, and the number of distinct values of the field FieldName2 is zero, then qScoreSummary is -18.",
"type": "int"
}
}
},
"BNFDef": {
"type": "struct",
"entries": {
"AggrFunc": {
"description": "If set to true, the definition is related to an aggregation function.\nThis parameter is optional. The default value is false.",
"type": "bool"
},
"Bnf": {
"description": "Array of token references that all together build up the definition of the current token.\nGenerally, if the array is not empty, the definition is a BNF rule (_qIsBnfRule_ is set to true). However, some BNF rules do have an empty array (_qIsBnfRule_ is set to true, but qBnf is empty).",
"type": "slice",
"items": {
"type": "int"
}
},
"BnfLiteral": {
"description": "If set to true, the definition specifies a literal token.\nThis parameter is optional. The default value is false.",
"type": "bool"
},
"ControlStatement": {
"description": "If set to true, the definition specifies a control statement.\nThis parameter is optional. The default value is false.",
"type": "bool"
},
"Depr": {
"description": "Indicates whether a script statement, a chart or a script function is deprecated (not recommended for use).\nIf set to true, the script statement or the function is not recommended for use in Qlik Sense.\nThis parameter is optional. The default value is false.",
"type": "bool"
},
"FG": {
"description": "Group of the function.\n\nOne of:\n\n• ALL or FUNC_GROUP_ALL\n\n• U or FUNC_GROUP_UNKNOWN\n\n• NONE or FUNC_GROUP_NONE\n\n• AGGR or FUNC_GROUP_AGGR\n\n• NUM or FUNC_GROUP_NUMERIC\n\n• RNG or FUNC_GROUP_RANGE\n\n• EXP or FUNC_GROUP_EXPONENTIAL_AND_LOGARITHMIC\n\n• TRIG or FUNC_GROUP_TRIGONOMETRIC_AND_HYPERBOLIC\n\n• FIN or FUNC_GROUP_FINANCIAL\n\n• MATH or FUNC_GROUP_MATH_CONSTANT_AND_PARAM_FREE\n\n• COUNT or FUNC_GROUP_COUNTER\n\n• STR or FUNC_GROUP_STRING\n\n• MAPP or FUNC_GROUP_MAPPING\n\n• RCRD or FUNC_GROUP_INTER_RECORD\n\n• CND or FUNC_GROUP_CONDITIONAL\n\n• LOG or FUNC_GROUP_LOGICAL\n\n• NULL or FUNC_GROUP_NULL\n\n• SYS or FUNC_GROUP_SYSTEM\n\n• FILE or FUNC_GROUP_FILE\n\n• TBL or FUNC_GROUP_TABLE\n\n• DATE or FUNC_GROUP_DATE_AND_TIME\n\n• NUMI or FUNC_GROUP_NUMBER_INTERPRET\n\n• FRMT or FUNC_GROUP_FORMATTING\n\n• CLR or FUNC_GROUP_COLOR\n\n• RNK or FUNC_GROUP_RANKING\n\n• GEO or FUNC_GROUP_GEO\n\n• EXT or FUNC_GROUP_EXTERNAL\n\n• PROB or FUNC_GROUP_PROBABILITY\n\n• ARRAY or FUNC_GROUP_ARRAY\n\n• LEG or FUNC_GROUP_LEGACY\n\n• DB or FUNC_GROUP_DB_NATIVE\n\n• WINDOW or FUNC_GROUP_WINDOW",
"type": "string"
},
"FGList": {
"description": "List of groups the function belongs to.",
"type": "slice",
"items": {
"type": "string"
}
},
"FieldFlag": {
"description": "If set to true, the definition is related to a field.\nThis parameter is optional. The default value is false.",
"type": "bool"
},
"HelpId": {
"description": "Reference identifier to a function described in the documentation. The identifier is stored in the definition of the token containing the function name.\nIs not used in Qlik Sense.",
"type": "int"
},
"IsBnfRule": {
"description": "If set to true, a list of related rule tokens is assigned to qBnf .\nThis parameter is optional. The default value is false.",
"type": "bool"
},
"MT": {
"description": "Type of the data.\n\nOne of:\n\n• N or NOT_META\n\n• D or META_DOC_NAME\n\n• R or META_RET_TYPE\n\n• V or META_DEFAULT_VALUE",
"type": "string"
},
"Name": {
"description": "Token name.\nOne of:\n\n• A rule name\n\n• An identifier\n\n• A literal value",
"type": "string"
},
"Nbr": {
"description": "Number of the current token definition.",
"type": "int"
},
"PNbr": {
"description": "Number of the parent rule definition.",
"type": "int"
},
"QvFunc": {
"description": "If set to true, the definition is related to a Qlik Sense function. It cannot be an aggregation function.\nThis parameter is optional. The default value is false.",
"type": "bool"
},
"ScriptStatement": {
"description": "If set to true, the definition specifies a script statement.\nThis parameter is optional. The default value is false.",
"type": "bool"
},
"Str": {
"description": "Literal string of the token.\nExamples: 'Round' and '('.",
"type": "string"
}
}
},
"Bookmark": {
"type": "struct",
"entries": {
"AlternateStateData": {
"type": "slice",
"items": {
"type": "#/definitions/AlternateStateData"
}
},
"ApplyAdditive": {
"type": "bool"
},
"ApplyInputFieldValues": {
"description": "When set to nil the default value is used, when set to point at a value that value is used (including golang zero values)",
"type": "bool",
"ref-type": "pointer"
},
"ApplyLayoutState": {
"type": "bool"
},
"FieldItems": {
"type": "slice",
"items": {
"type": "#/definitions/BookmarkFieldItem"
}
},
"ForAnnotations": {
"type": "bool"
},
"Groups": {
"type": "slice",
"items": {
"type": "#/definitions/GroupBookmarkData"
}
},
"Id": {
"type": "string"
},
"IncludeAllVariables": {
"type": "bool"
},
"IncludeScrollPosition": {
"type": "bool"
},
"IncludeSelectionState": {
"description": "When set to nil the default value is used, when set to point at a value that value is used (including golang zero values)",
"type": "bool",
"ref-type": "pointer"
},
"InfoText": {
"type": "string"
},
"InputFieldItems": {
"type": "slice",
"items": {
"type": "#/definitions/InputFieldItem"
}
},
"Name": {
"type": "string"
},
"Objects": {
"type": "slice",
"items": {
"type": "#/definitions/LayoutBookmarkData"
}
},
"ObjectsLayout": {
"type": "slice",
"items": {
"type": "#/definitions/ExtendedLayoutBookmarkData"
}
},
"Owner": {
"type": "string"
},
"RecallCount": {
"type": "int"
},
"SheetId": {
"type": "string"
},
"Show": {
"type": "#/definitions/CondDef"
},
"ShowPopupInfo": {
"type": "bool"
},
"UtcModifyTime": {
"type": "#/definitions/Float64"
},
"UtcRecallTime": {
"type": "#/definitions/Float64"
},
"VariableItems": {
"type": "slice",
"items": {
"type": "#/definitions/BookmarkVariableItem"
}
}
}
},
"BookmarkApplyAndVerifyResult": {
"x-qlik-stability": "experimental",
"type": "struct",
"entries": {
"ApplySuccess": {
"description": "Apply successfully or not *",
"type": "bool"
},
"GroupStateResult": {
"description": "Result of applying group states (if any).",
"type": "#/definitions/ApplyGroupStatesResult"
},
"Warnings": {
"description": "Field values verfication result *",
"type": "slice",
"items": {
"type": "#/definitions/BookmarkFieldVerifyWarning"
}
}
}
},
"BookmarkFieldItem": {
"type": "struct",
"entries": {
"AndMode": {
"description": "If set to true, selections within a list object are made in AND mode; If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in and-mode, all records that are associated with Customer 1 and Customer 2 are selected.\nThe default value is false; selections within a list object are made in OR mode. If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in or-mode, all records that are associated with either Customer 1 or Customer 2 are selected.\nThis parameter is not returned if set to false.",
"type": "bool"
},
"Def": {
"description": "Name and type of the field.",
"type": "#/definitions/FieldDefEx"
},
"ExcludedValues": {
"description": "List of excluded values.\nEither the list of selected values or the list of excluded values is displayed.",
"type": "slice",
"items": {
"type": "#/definitions/FieldValue"
}
},
"Locked": {
"description": "Indicates if the field is locked.\nDefault is false.",
"type": "bool"
},
"OneAndOnlyOne": {
"description": "If set to true, the field has always one selection (not 0 and not more than 1). If another value is selected, the previous one is unselected.\nThe default value is false. This parameter is not returned if set to false.",
"type": "bool"
},
"SelectInfo": {
"description": "Information on the selections criteria.",
"type": "#/definitions/SelectInfo"
},
"Values": {
"type": "slice",
"items": {
"type": "#/definitions/FieldValue"
}
}
}
},
"BookmarkFieldPage": {
"description": "Defines the range of the bookmark fields that are returned.",
"type": "struct",
"entries": {
"EndIndex": {
"description": "The end value of the range.",
"type": "int"
},
"StartIndex": {
"description": "The start value of the range.",
"type": "int"
}
}
},
"BookmarkFieldVerifyWarning": {
"x-qlik-stability": "experimental",
"type": "struct",
"entries": {
"Field": {
"description": "Field Name *",
"type": "string"
},
"MissingValues": {
"type": "slice",
"items": {
"type": "string"
}
},
"State": {
"description": "Alternate State *",
"type": "string"
},
"VerifyResult": {
"description": "Field/values verfication result *\nDefines result of ApplyAndVerify.\nOne of:\n\n• NOT_VERIFIED\n\n• FIELD_VALUE_MATCH_ALL\n\n• FIELD_MISSING\n\n• FIELD_VALUE_MISSING\n\n• STATE_MISSING",
"type": "string"
}
}
},
"BookmarkList": {
"description": "Lists the bookmarks. Is the layout for BookmarkListDef.",
"type": "struct",
"entries": {
"Items": {
"description": "Information about the list of bookmarks.",
"type": "slice",
"items": {
"type": "#/definitions/NxContainerEntry"
}
}
}
},
"BookmarkListDef": {
"description": "Defines the list of bookmarks.",
"type": "struct",
"entries": {
"Data": {
"description": "Data",
"type": "https://golang.org/pkg/encoding/json/RawMessage"
},
"IncludePatches": {
"description": "Include the bookmark patches. Patches can be very large and may make the list result unmanageable.",
"type": "bool"
},
"Type": {
"description": "Type of the list.",
"type": "string"
}
}
},
"BookmarkVariableItem": {
"type": "struct",
"entries": {
"Definition": {
"description": "The Reporting mode definition of the variable.",
"type": "string"
},
"Name": {
"description": "Name of the variable.",
"type": "string"
},
"Value": {
"description": "Value of the variable.",
"type": "#/definitions/FieldValue"
}
}
},
"CalendarStrings": {
"type": "struct",
"entries": {
"DayNames": {
"description": "List of short day names.",
"type": "slice",
"items": {
"type": "string"
}
},
"LongDayNames": {
"description": "List of long day names.",
"type": "slice",
"items": {
"type": "string"
}
},
"LongMonthNames": {
"description": "List of long month names.",
"type": "slice",
"items": {
"type": "string"
}
},
"MonthNames": {
"description": "List of short month names.",
"type": "slice",
"items": {
"type": "string"
}
}
}
},
"ChangeLists": {
"description": "ChangeLists list of changed and closed handles.",
"type": "struct",
"entries": {
"Changed": {
"description": "Changed list of changed object handles or nil",
"type": "slice",
"items": {
"type": "int"
}
},
"Closed": {
"description": "Closed list of closed object handles or nil",
"type": "slice",
"items": {
"type": "int"
}
},
"Suspended": {
"description": "Suspended list of suspended object handles or nil",
"type": "slice",
"items": {
"type": "int"
}
}
}
},
"ChangeListsKey": {
"description": "ChangeListsKey key for ChangeLists context value",
"type": "struct"
},
"CharRange": {
"type": "struct",
"entries": {
"CharCount": {
"description": "Number of occurrences found.",
"type": "int"
},
"CharPos": {
"description": "Position of the first search occurrence.",
"type": "int"
}
}
},
"ChildList": {
"description": "Lists the children of a generic object. Is the layout for ChildListDef.\nChildList is used by the GetLayout Method to list the children of a generic object.",
"type": "struct",
"entries": {
"Items": {
"description": "Information about the items in the app object.",
"type": "slice",
"items": {
"type": "#/definitions/NxContainerEntry"
}
}
}
},
"ChildListDef": {
"description": "Defines the list of children of a generic object.\nWhat is defined in ChildListDef has an impact on what the GetLayout method returns. See Example for more information.",
"type": "struct",
"entries": {
"Data": {
"description": "Data that you want to include in the child list definition.\nYou need to enter the paths to the information you want to retrieve.",
"type": "https://golang.org/pkg/encoding/json/RawMessage"
}
}
},
"CodePage": {
"type": "struct",
"entries": {
"Description": {
"description": "Description of the code page.",
"type": "string"
},
"Name": {
"description": "Name of the code page.",
"type": "string"
},
"Number": {
"description": "Number of the code page.",
"type": "int"
}
}
},
"CondDef": {
"type": "struct",
"entries": {
"Always": {
"description": "When set to nil the default value is used, when set to point at a value that value is used (including golang zero values)",
"type": "bool",
"ref-type": "pointer"
},
"Expression": {
"type": "#/definitions/ValueExpr"
}
}
},
"Connection": {
"type": "struct",
"entries": {
"ConnectionString": {
"description": "One of:\n\n• ODBC CONNECT TO [\u003cprovider name\u003e]\n\n• OLEDB CONNECT TO [\u003cprovider name\u003e]\n\n• CUSTOM CONNECT TO [\u003cprovider name\u003e]\n\n• \"\u003clocal absolute or relative path, UNC path\u003e\"\n\n• \"\u003cURL\u003e\"\n\nConnection string.\nThis parameter is mandatory and must be set when creating or modifying a connection.",
"type": "string"
},
"Id": {
"description": "Identifier of the connection.\nIs generated by the engine and is unique.",
"type": "string"
},
"LogOn": {
"description": "Select which user credentials to use to connect to the source.\n\n• LOG_ON_SERVICE_USER: Disables\n\n• LOG_ON_CURRENT_USER: Enables\n\nOne of:\n\n• LOG_ON_SERVICE_USER\n\n• LOG_ON_CURRENT_USER",
"type": "string"
},
"Meta": {
"description": "Information about the connection.",
"type": "#/definitions/NxMeta"
},
"ModifiedDate": {
"description": "Is generated by the engine.\nCreation date of the connection or last modification date of the connection.",
"type": "string"
},
"Name": {
"description": "Name of the connection.\nThis parameter is mandatory and must be set when creating or modifying a connection.",
"type": "string"
},
"Password": {
"description": "Password of the user who creates the connection.\nThis parameter is optional; it is only used for OLEDB, ODBC and CUSTOM connections.\nA call to GetConnection Method does not return the password.",
"type": "string"
},
"Type": {
"description": "One of:\n\n• ODBC\n\n• OLEDB\n\n• \u003cName of the custom connection file\u003e\n\n• folder\n\n• internet\n\nType of the connection.\nThis parameter is mandatory and must be set when creating or modifying a connection.\nFor ODBC, OLEDB and custom connections, the engine checks that the connection type matches the connection string.\nThe type is not case sensitive.",
"type": "string"
},
"UserName": {
"description": "Name of the user who creates the connection.\nThis parameter is optional; it is only used for OLEDB, ODBC and CUSTOM connections.\nA call to GetConnection Method does not return the user name.",
"type": "string"
}
}
},
"ContentLibraryList": {
"type": "struct",
"entries": {
"Items": {
"description": "Information about the content library.",
"type": "slice",
"items": {
"type": "#/definitions/ContentLibraryListItem"
}
}
}
},
"ContentLibraryListItem": {
"type": "struct",
"entries": {
"AppSpecific": {
"description": "Is set to true if the library is specific to the app (not a global content library).",
"type": "bool"
},
"Meta": {
"description": "Information about publishing and permissions.",
"type": "#/definitions/NxMeta"
},
"Name": {
"description": "Name of the library.",
"type": "string"
}
}
},
"CustomConnector": {
"type": "struct",
"entries": {
"DisplayName": {
"description": "Name of the custom connector as displayed in the Qlik interface.",
"type": "string"
},
"MachineMode": {
"description": "Mode of the machine (64 or 32 bits).\n\nOne of:\n\n• CONNECT_DEFAULT\n\n• CONNECT_64\n\n• CONNECT_32",
"type": "string"
},
"Parent": {
"description": "Name of the parent folder that contains the custom connector file.",
"type": "string"
},
"Provider": {
"description": "Name of the custom connector file.",
"type": "string"
},
"SupportFileStreaming": {
"type": "bool"
}
}
},
"CyclicGroupPosition": {
"type": "struct",
"entries": {
"ActiveField": {
"description": "Active field of the cyclic group, identified by a zero-based index.",
"type": "int"
},
"Info": {
"description": "Target cyclic group.",
"type": "#/definitions/NxInfo"
}
}
},
"DataField": {
"type": "struct",
"entries": {
"IsKey": {
"description": "Is set to true if the field is a primary key.",
"type": "bool"
},
"Name": {
"description": "Name of the field.",
"type": "string"
},
"OriginalFieldName": {
"description": "Is shown for fixed records.\n_qOriginalFieldName_ and qName are identical if no field names are used in the file.\n_qOriginalFieldName_ differs from qName if embedded file names are used in the file.",
"type": "string"
}
}
},
"DataRecord": {
"type": "struct",
"entries": {
"Values": {
"description": "List of values inside the table.\nThe first values (in result/qPreview/0/qValues ) correspond to the field names in the table.\nThe following values (from result/qPreview/1/qValues ) are the values of the fields in the table.",
"type": "slice",
"items": {
"type": "string"
}
}
}
},
"DataTable": {
"type": "struct",
"entries": {
"Name": {
"description": "Name of the table.",
"type": "string"
},
"Type": {
"description": "Type of the table.\nFor example: Table or View.",
"type": "string"
}
}
},
"DataTableEx": {
"type": "struct",
"entries": {
"Fields": {
"description": "List of the fields in the table.",
"type": "slice",
"items": {
"type": "#/definitions/DataField"
}
},
"FormatSpec": {
"description": "List of format specification items, within brackets.\nExamples of specification items:\n\n• file type\n\n• embedded labels, no labels\n\n• table is \u003ctable name\u003e",
"type": "string"
},
"Name": {
"description": "Name of the table.",
"type": "string"
}
}
},
"Database": {
"type": "struct",
"entries": {
"IsDefault": {
"description": "Is set to true if the database is set by default.",
"type": "bool"
},
"Name": {
"description": "Name of the database.",
"type": "string"
}
}
},
"DatabaseInfo": {
"type": "struct",
"entries": {
"DBFirst": {
"description": "If set to true, it means that the database is displayed first, before the owners and tables.",
"type": "bool"
},
"DBMSName": {
"description": "Name of the product accessed by the provider.",
"type": "string"
},
"DBSeparator": {
"description": "Character string used after the database name.\nExample with separator \" . \":\nFROM LinkedTablesData.dbo.Months\nWhere:\n\n• LinkedTablesData is the database name\n\n• dbo is the owner name\n\n• Months is the table name",
"type": "string"
},
"DBUsage": {
"description": "If set to true, it means that the data source contains some databases.",
"type": "bool"
},
"DefaultDatabase": {
"description": "Name of the default database.",
"type": "string"
},
"Keywords": {
"description": "List of the script keywords.",
"type": "slice",
"items": {
"type": "string"
}
},
"OwnerSeparator": {
"description": "Character string used after the owner name.\nExample with separator \" . \":\nFROM LinkedTablesData.dbo.Months\nWhere:\n\n• LinkedTablesData is the database name\n\n• dbo is the owner name\n\n• Months is the table name",
"type": "string"
},
"OwnerUsage": {
"description": "If set to true, it means that the data source contains some owners.",
"type": "bool"
},
"QuotePreffix": {
"description": "Prefix used with field, database or owner names that contain special characters or keywords.",
"type": "string"
},
"QuoteSuffix": {
"description": "Suffix used with field, database or owner names that contain special characters or keywords.",
"type": "string"
},
"SpecialChars": {
"description": "List of the special characters.",
"type": "string"
}
}
},
"DatabaseOwner": {
"type": "struct",
"entries": {
"Name": {
"description": "Name of the owner.",
"type": "string"
}
}
},
"DelimiterInfo": {
"type": "struct",
"entries": {
"IsMultiple": {
"description": "Is set to true if multiple spaces are used to separate the values.",
"type": "bool"
},
"Name": {
"description": "Name of the delimiter.\nExample:\n\"Tab_DELIMITER\"",
"type": "string"
},
"Number": {
"description": "Delimiter character number used by the engine to determine how to separate the values.",
"type": "int"
},
"ScriptCode": {
"description": "Representation of the delimiter value that is used in the script.\nExample:\n\"'\\t'\"",
"type": "string"
}
}
},
"DerivedFieldsInTableData": {
"type": "struct",
"entries": {
"Active": {
"description": "Is set to true is the derived field is in use.",
"type": "bool"
},
"DefinitionName": {
"description": "Name of the derived definition.",
"type": "string"
},
"Tags": {
"description": "List of tags.",
"type": "slice",
"items": {
"type": "string"
}
}
}
},
"Dialer": {
"description": "Dialer contains various settings for how to create WebSocket connections towards Qlik Associative Engine.",
"type": "struct",
"entries": {
"CreateSocket": {
"description": "A function to use when instantiating the WebSocket",
"type": "function",
"params": [
{
"type": "https://golang.org/pkg/context/Context"
},
{
"type": "string"
},
{
"type": "https://golang.org/pkg/net/http/Header"
}
],
"returns": [
{
"type": "#/definitions/Socket"
},
{
"type": "error"
}
]
},
"Dial": {
"description": "Dial establishes a connection to Qlik Associative Engine using the settings set in the Dialer.",
"type": "method",
"params": [
{
"type": "https://golang.org/pkg/context/Context"
},
{
"type": "string"
},
{
"type": "https://golang.org/pkg/net/http/Header"
}
],
"returns": [
{
"type": "#/definitions/Global"
},
{
"type": "error"
}
]
},
"DialRaw": {
"description": "DialRaw establishes a connection to Qlik Associative Engine using the settings set in the Dialer.\nThe returned remote object points to the Global object of the session with handle -1.\nDialRaw can be used with custom specifications by wrapping the returned RemoteObject in a generated schema type like so:\n\n\tremoteObject, err := enigma.Dialer{}.DialRaw(ctx, \"ws://...\", nil)\n\tmySpecialGlobal := \u0026specialSchemaPackage.SpecialGlobal{RemoteObject: remoteObject}",
"type": "method",
"params": [
{
"type": "https://golang.org/pkg/context/Context"
},
{
"type": "string"