@qlik/api 0.0.2 → 0.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/api-keys.d.mts +14 -0
- package/api-keys.d.ts +14 -0
- package/api-keys.js +14 -10
- package/api-keys.mjs +6 -2
- package/apps.d.mts +479 -149
- package/apps.d.ts +479 -149
- package/apps.js +100 -42
- package/apps.mjs +60 -2
- package/audits.d.mts +12 -0
- package/audits.d.ts +12 -0
- package/audits.js +10 -9
- package/audits.mjs +3 -2
- package/auth-AWZV4DPP.js +41 -0
- package/{auth-RTFXVSSK.mjs → auth-CPBNNC7S.mjs} +4 -1
- package/auth.js +4 -3
- package/auth.mjs +3 -2
- package/automations.d.mts +36 -0
- package/automations.d.ts +36 -0
- package/automations.js +28 -21
- package/automations.mjs +9 -2
- package/brands.d.mts +45 -4
- package/brands.d.ts +45 -4
- package/brands.js +20 -15
- package/brands.mjs +7 -2
- package/{chunk-ZT4C7KCQ.js → chunk-2STFUQKQ.js} +3 -3
- package/{chunk-7REWEWCX.mjs → chunk-3SVRHJII.mjs} +3 -3
- package/{chunk-CKPJE4IA.mjs → chunk-67GJTTPV.mjs} +1 -1
- package/{chunk-M7F4JFOB.js → chunk-7RY3NO6N.js} +2 -2
- package/{chunk-NALKLKZS.mjs → chunk-CYRLVHU3.mjs} +316 -53
- package/{chunk-RMKP2BDX.js → chunk-D52VW5UN.js} +318 -55
- package/{chunk-GUQBHY3H.mjs → chunk-GNWU6SP2.mjs} +1 -1
- package/{chunk-QN23TPIE.js → chunk-GV5SRHY2.js} +4 -4
- package/{chunk-OULT3V2U.js → chunk-JNGURO23.js} +3 -3
- package/chunk-P57PW2II.js +11 -0
- package/{chunk-3YE7EI7I.mjs → chunk-TE7XMBT5.mjs} +1 -1
- package/chunk-ZFXKCRJC.mjs +11 -0
- package/collections.d.mts +51 -17
- package/collections.d.ts +51 -17
- package/collections.js +28 -14
- package/collections.mjs +16 -2
- package/csp-origins.d.mts +16 -1
- package/csp-origins.d.ts +16 -1
- package/csp-origins.js +12 -9
- package/csp-origins.mjs +5 -2
- package/data-assets.d.mts +10 -0
- package/data-assets.d.ts +10 -0
- package/data-assets.js +13 -8
- package/data-assets.mjs +7 -2
- package/data-connections.d.mts +18 -0
- package/data-connections.d.ts +18 -0
- package/data-connections.js +19 -12
- package/data-connections.mjs +9 -2
- package/data-credentials.d.mts +8 -0
- package/data-credentials.d.ts +8 -0
- package/data-credentials.js +10 -7
- package/data-credentials.mjs +5 -2
- package/data-files.d.mts +98 -13
- package/data-files.d.ts +98 -13
- package/data-files.js +22 -15
- package/data-files.mjs +9 -2
- package/{enigma-session-VPPJMBEM.js → enigma-session-XPXDQAIV.js} +5 -4
- package/{enigma-session-HGXKZJVO.mjs → enigma-session-ZH6MYA54.mjs} +2 -1
- package/{esm-RX7B2TUN.js → esm-3VXX2GKL.js} +3 -1
- package/{esm-M5ZBFTVD.mjs → esm-OY4XVIJB.mjs} +3 -1
- package/extensions.d.mts +26 -2
- package/extensions.d.ts +26 -2
- package/extensions.js +13 -10
- package/extensions.mjs +5 -2
- package/glossaries.d.mts +55 -20
- package/glossaries.d.ts +55 -20
- package/glossaries.js +39 -27
- package/glossaries.mjs +14 -2
- package/groups.d.mts +16 -0
- package/groups.d.ts +16 -0
- package/groups.js +16 -11
- package/groups.mjs +7 -2
- package/identity-providers.d.mts +16 -0
- package/identity-providers.d.ts +16 -0
- package/identity-providers.js +14 -11
- package/identity-providers.mjs +5 -2
- package/index.js +135 -101
- package/index.mjs +131 -97
- package/{invoke-fetch-IMO4AMA3.mjs → invoke-fetch-3WZWAAZH.mjs} +4 -1
- package/invoke-fetch-UNTAUR7O.js +17 -0
- package/items.d.mts +6 -6
- package/items.d.ts +6 -6
- package/items.js +14 -11
- package/items.mjs +5 -2
- package/licenses.d.mts +18 -0
- package/licenses.d.ts +18 -0
- package/licenses.js +17 -12
- package/licenses.mjs +7 -2
- package/package.json +4 -4
- package/{qix-K22VHZRH.js → qix-UNWXPGMA.js} +9 -8
- package/{qix-57WD2ZE6.mjs → qix-ZSJ4PIK3.mjs} +3 -2
- package/qix.d.mts +1 -1
- package/qix.d.ts +1 -1
- package/qix.js +4 -3
- package/qix.mjs +3 -2
- package/quotas.d.mts +4 -0
- package/quotas.d.ts +4 -0
- package/quotas.js +6 -5
- package/quotas.mjs +3 -2
- package/reload-tasks.js +11 -8
- package/reload-tasks.mjs +5 -2
- package/reloads.d.mts +17 -10
- package/reloads.d.ts +17 -10
- package/reloads.js +9 -7
- package/reloads.mjs +4 -2
- package/roles.d.mts +4 -0
- package/roles.d.ts +4 -0
- package/roles.js +6 -5
- package/roles.mjs +3 -2
- package/spaces.d.mts +27 -4
- package/spaces.d.ts +27 -4
- package/spaces.js +21 -15
- package/spaces.mjs +8 -2
- package/temp-contents.d.mts +8 -3
- package/temp-contents.d.ts +8 -3
- package/temp-contents.js +8 -6
- package/temp-contents.mjs +4 -2
- package/tenants.d.mts +12 -0
- package/tenants.d.ts +12 -0
- package/tenants.js +14 -9
- package/tenants.mjs +7 -2
- package/themes.d.mts +26 -2
- package/themes.d.ts +26 -2
- package/themes.js +13 -10
- package/themes.mjs +5 -2
- package/transports.d.mts +12 -0
- package/transports.d.ts +12 -0
- package/transports.js +12 -9
- package/transports.mjs +5 -2
- package/users.d.mts +48 -29
- package/users.d.ts +48 -29
- package/users.js +18 -13
- package/users.mjs +7 -2
- package/web-integrations.d.mts +10 -0
- package/web-integrations.d.ts +10 -0
- package/web-integrations.js +11 -8
- package/web-integrations.mjs +5 -2
- package/web-notifications.d.mts +12 -0
- package/web-notifications.d.ts +12 -0
- package/web-notifications.js +12 -9
- package/web-notifications.mjs +5 -2
- package/webhooks.d.mts +25 -5
- package/webhooks.d.ts +25 -5
- package/webhooks.js +17 -13
- package/webhooks.mjs +6 -2
- package/auth-CSVTXOZX.js +0 -36
- package/auth-OU7OTB7Y.js +0 -38
- package/auth-TE272Q34.mjs +0 -36
- package/chunk-4ES65KO3.js +0 -57
- package/chunk-4FLMND6T.js +0 -25
- package/chunk-4OMEH5SW.mjs +0 -1337
- package/chunk-6JERR27K.js +0 -17
- package/chunk-E42WUFCK.mjs +0 -57
- package/chunk-H7SAZYEE.js +0 -21
- package/chunk-KMMWJZHM.mjs +0 -25
- package/chunk-W4J34XGA.mjs +0 -17
- package/chunk-WM7FQU2U.mjs +0 -21
- package/chunk-XASXL2NC.js +0 -1337
- package/enigma-session-4L373ALV.mjs +0 -10196
- package/enigma-session-TEB53FAF.js +0 -10196
- package/esm-4X3DKK5D.js +0 -63
- package/esm-SOWVJKOQ.mjs +0 -63
- package/invoke-fetch-7PKPQ3FD.js +0 -14
- package/invoke-fetch-MSSJAZ7K.mjs +0 -14
- package/invoke-fetch-PEI54KZO.js +0 -14
- package/qix-EU7PXRZ6.mjs +0 -573
- package/qix-RLTISYTB.js +0 -573
package/apps.d.mts
CHANGED
|
@@ -71,7 +71,7 @@ type AnalysisModelResponseDetail = {
|
|
|
71
71
|
isLogicalModelEnabled?: boolean;
|
|
72
72
|
masterItems?: AnalysisModelItemMasterItem[];
|
|
73
73
|
};
|
|
74
|
-
type AnalysisRecommendRequest =
|
|
74
|
+
type AnalysisRecommendRequest = RecommendNaturalLangQuery | RecommendItems;
|
|
75
75
|
type AnalysisRecommendationResponse = {
|
|
76
76
|
data?: AnalysisRecommendationResponseDetail[];
|
|
77
77
|
};
|
|
@@ -89,10 +89,10 @@ type AppAttributes = {
|
|
|
89
89
|
/** The space ID of the application */
|
|
90
90
|
spaceId?: string;
|
|
91
91
|
/** Indicates whether the app is used for Analytics or DataPreparation
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
92
|
+
*
|
|
93
|
+
* One of:
|
|
94
|
+
* * ANALYTICS
|
|
95
|
+
* * DATA_PREPARATION */
|
|
96
96
|
usage?: "ANALYTICS" | "DATA_PREPARATION";
|
|
97
97
|
};
|
|
98
98
|
type AppContentList = {
|
|
@@ -142,9 +142,9 @@ type DataModelMetadata = {
|
|
|
142
142
|
/** Profiling data of the tables in the app. */
|
|
143
143
|
tables_profiling_data?: TableProfilingData[];
|
|
144
144
|
/**
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
145
|
+
* One of:
|
|
146
|
+
* * ANALYTICS
|
|
147
|
+
* * DATA_PREPARATION */
|
|
148
148
|
usage?: "ANALYTICS" | "DATA_PREPARATION";
|
|
149
149
|
};
|
|
150
150
|
type Error = {
|
|
@@ -176,37 +176,37 @@ type EvaluatorError = {
|
|
|
176
176
|
};
|
|
177
177
|
type FieldAttributes = {
|
|
178
178
|
/** Defines the decimal separator.
|
|
179
|
-
|
|
179
|
+
* Example: **.** */
|
|
180
180
|
Dec?: string;
|
|
181
181
|
/** Defines the format pattern that applies to _qText_ .
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
182
|
+
* Is used in connection to the type of the field (parameter **qType** ).
|
|
183
|
+
* For more information, see _Formatting mechanism_.
|
|
184
|
+
* Example: _YYYY-MM-DD_ for a date. */
|
|
185
185
|
Fmt?: string;
|
|
186
186
|
/** Defines the thousand separator (if any).
|
|
187
|
-
|
|
188
|
-
|
|
187
|
+
* Is used if **qUseThou** is set to 1.
|
|
188
|
+
* Example: **,** */
|
|
189
189
|
Thou?: string;
|
|
190
190
|
/** Type of the field.
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
191
|
+
* Default is U.
|
|
192
|
+
*
|
|
193
|
+
* One of:
|
|
194
|
+
* * U or UNKNOWN
|
|
195
|
+
* * A or ASCII
|
|
196
|
+
* * I or INTEGER
|
|
197
|
+
* * R or REAL
|
|
198
|
+
* * F or FIX
|
|
199
|
+
* * M or MONEY
|
|
200
|
+
* * D or DATE
|
|
201
|
+
* * T or TIME
|
|
202
|
+
* * TS or TIMESTAMP
|
|
203
|
+
* * IV or INTERVAL */
|
|
204
204
|
Type?: "UNKNOWN" | "ASCII" | "INTEGER" | "REAL" | "FIX" | "MONEY" | "DATE" | "TIME" | "TIMESTAMP" | "INTERVAL";
|
|
205
205
|
/** Defines whether or not a thousands separator must be used.
|
|
206
|
-
|
|
206
|
+
* Default is 0. */
|
|
207
207
|
UseThou?: number;
|
|
208
208
|
/** Number of decimals.
|
|
209
|
-
|
|
209
|
+
* Default is 10. */
|
|
210
210
|
nDec?: number;
|
|
211
211
|
};
|
|
212
212
|
type FieldInTableProfilingData = {
|
|
@@ -252,42 +252,42 @@ type FieldInTableProfilingData = {
|
|
|
252
252
|
/** Number of null values */
|
|
253
253
|
NullValues?: number;
|
|
254
254
|
/** Sets the formatting of a field.
|
|
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
|
-
|
|
255
|
+
* The properties of _qFieldAttributes_ and the formatting mechanism are described below.
|
|
256
|
+
*
|
|
257
|
+
* ### Formatting mechanism
|
|
258
|
+
* The formatting mechanism depends on the type set in _qType,_ as shown below:
|
|
259
|
+
* <div class=note>In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.</div>
|
|
260
|
+
*
|
|
261
|
+
* ### Type is DATE, TIME, TIMESTAMP or INTERVAL
|
|
262
|
+
* The following applies:
|
|
263
|
+
* * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ .
|
|
264
|
+
* * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ).
|
|
265
|
+
* * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used.
|
|
266
|
+
*
|
|
267
|
+
* ### Type is INTEGER
|
|
268
|
+
* The following applies:
|
|
269
|
+
* * 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_ ).
|
|
270
|
+
* * 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 .
|
|
271
|
+
*
|
|
272
|
+
* ### Type is REAL
|
|
273
|
+
* The following applies:
|
|
274
|
+
* * 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_ ).
|
|
275
|
+
* * 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.
|
|
276
|
+
* * 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.
|
|
277
|
+
* * 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.
|
|
278
|
+
*
|
|
279
|
+
* ### Type is FIX
|
|
280
|
+
* The following applies:
|
|
281
|
+
* * 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_ ).
|
|
282
|
+
* * 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.
|
|
283
|
+
*
|
|
284
|
+
* ### Type is MONEY
|
|
285
|
+
* The following applies:
|
|
286
|
+
* * 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_ ).
|
|
287
|
+
* * 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_ ).
|
|
288
|
+
*
|
|
289
|
+
* ### Type is ASCII
|
|
290
|
+
* No formatting, _qFmt_ is ignored. */
|
|
291
291
|
NumberFormat?: FieldAttributes;
|
|
292
292
|
/** Number of numeric values */
|
|
293
293
|
NumericValues?: number;
|
|
@@ -310,8 +310,8 @@ type FieldInTableProfilingData = {
|
|
|
310
310
|
};
|
|
311
311
|
type FieldMetadata = {
|
|
312
312
|
/** If set to true, the field has one and only one selection (not 0 and not more than 1).
|
|
313
|
-
|
|
314
|
-
|
|
313
|
+
* If this property is set to true, the field cannot be cleared anymore and no more selections can be performed in that field.
|
|
314
|
+
* The default value is false. */
|
|
315
315
|
always_one_selected?: boolean;
|
|
316
316
|
/** Static RAM memory used in bytes. */
|
|
317
317
|
byte_size?: number;
|
|
@@ -320,31 +320,31 @@ type FieldMetadata = {
|
|
|
320
320
|
/** Field comment. */
|
|
321
321
|
comment?: string;
|
|
322
322
|
/** If set to true, only distinct field values are shown.
|
|
323
|
-
|
|
323
|
+
* The default value is false. */
|
|
324
324
|
distinct_only?: boolean;
|
|
325
325
|
/** Hash of the data in the field. If the data in a reload is the same, the hash will be consistent. */
|
|
326
326
|
hash?: string;
|
|
327
327
|
/** If set to true, the field is hidden.
|
|
328
|
-
|
|
328
|
+
* The default value is false. */
|
|
329
329
|
is_hidden?: boolean;
|
|
330
330
|
/** If set to true, the field is locked.
|
|
331
|
-
|
|
331
|
+
* The default value is false. */
|
|
332
332
|
is_locked?: boolean;
|
|
333
333
|
/** Is set to true if the value is a numeric.
|
|
334
|
-
|
|
334
|
+
* The default value is false. */
|
|
335
335
|
is_numeric?: boolean;
|
|
336
336
|
/** If set to true, the field is semantic.
|
|
337
|
-
|
|
337
|
+
* The default value is false. */
|
|
338
338
|
is_semantic?: boolean;
|
|
339
339
|
/** If set to true, the field is a system field.
|
|
340
|
-
|
|
340
|
+
* The default value is false. */
|
|
341
341
|
is_system?: boolean;
|
|
342
342
|
/** Name of the field. */
|
|
343
343
|
name?: string;
|
|
344
344
|
/** List of table names. */
|
|
345
345
|
src_tables?: string[];
|
|
346
346
|
/** Gives information on a field. For example, it can return the type of the field.
|
|
347
|
-
|
|
347
|
+
* Examples: key, text, ASCII. */
|
|
348
348
|
tags?: string[];
|
|
349
349
|
/** Total number of field values. */
|
|
350
350
|
total_count?: number;
|
|
@@ -353,7 +353,113 @@ type FieldOverride = {
|
|
|
353
353
|
classifications?: string[];
|
|
354
354
|
defaultAggregation?: string;
|
|
355
355
|
};
|
|
356
|
-
type FileData =
|
|
356
|
+
type FileData = BodyInit;
|
|
357
|
+
type Filter = {
|
|
358
|
+
readonly createdAt?: string;
|
|
359
|
+
/** The filter description. */
|
|
360
|
+
description?: string;
|
|
361
|
+
filterType?: FilterType;
|
|
362
|
+
filterV1_0?: FilterV10;
|
|
363
|
+
filterVersion?: "filter-1.0";
|
|
364
|
+
/** The filter ID (bookmarkId). */
|
|
365
|
+
readonly id?: string;
|
|
366
|
+
/** The filter name. */
|
|
367
|
+
name?: string;
|
|
368
|
+
/** The user that owns the filter, if missing the same as the request user. */
|
|
369
|
+
ownerId?: string;
|
|
370
|
+
readonly updatedAt?: string;
|
|
371
|
+
};
|
|
372
|
+
type FilterError = {
|
|
373
|
+
/** The unique code for the error
|
|
374
|
+
*
|
|
375
|
+
* - "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
|
|
376
|
+
* - "REP-400008" Selections error.
|
|
377
|
+
* - "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
|
|
378
|
+
* - "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
|
|
379
|
+
* - "REP-401001" Unauthorized, bad JWT.
|
|
380
|
+
* - "REP-403000" Forbidden. The client does not have access rights to the content.
|
|
381
|
+
* - "REP-403001" App forbidden, the user does not have read permission on the app.
|
|
382
|
+
* - "REP-403002" Chart type not supported.
|
|
383
|
+
* - "REP-404000" Not found. The server can not find the requested resource.
|
|
384
|
+
* - "REP-409043" Filter name conflict. The filter name must be unique.
|
|
385
|
+
* - "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
|
|
386
|
+
* - "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
|
|
387
|
+
* - "REP-429016" Exceeded max session tenant quota per day.
|
|
388
|
+
* - "REP-500000" Fail to resolve resource.
|
|
389
|
+
* - "REP-503005" Engine unavailable, qix-sessions error no engines available.
|
|
390
|
+
* - "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
|
|
391
|
+
* - "REP-504042" Context deadline exceeded applying selections of the Filter. */
|
|
392
|
+
code: string;
|
|
393
|
+
/** A summary in english explaining what went wrong. */
|
|
394
|
+
title: string;
|
|
395
|
+
};
|
|
396
|
+
type FilterErrors = {
|
|
397
|
+
errors: FilterError[];
|
|
398
|
+
};
|
|
399
|
+
type FilterField = {
|
|
400
|
+
/** Gets the resource description. */
|
|
401
|
+
description?: string;
|
|
402
|
+
name: string;
|
|
403
|
+
overrideValues?: boolean;
|
|
404
|
+
selectExcluded?: boolean;
|
|
405
|
+
/** The filter values. */
|
|
406
|
+
values?: FilterFieldValue[];
|
|
407
|
+
};
|
|
408
|
+
type FilterFieldValue = {
|
|
409
|
+
valueAsNumber?: Float64;
|
|
410
|
+
valueAsText?: string;
|
|
411
|
+
valueType?: "string" | "number" | "evaluate" | "search";
|
|
412
|
+
};
|
|
413
|
+
type FilterList = {
|
|
414
|
+
/** a list of filters containing all the filters properties (like name,description...) except the filter definition (like FilterV1_0) */
|
|
415
|
+
data: FilterListItem[];
|
|
416
|
+
links: LinksResponse;
|
|
417
|
+
};
|
|
418
|
+
type FilterListItem = {
|
|
419
|
+
readonly createdAt?: string;
|
|
420
|
+
/** The filter description. */
|
|
421
|
+
readonly description?: string;
|
|
422
|
+
filterType?: FilterType;
|
|
423
|
+
filterV1_0?: FilterV10;
|
|
424
|
+
readonly filterVersion?: "filter-1.0";
|
|
425
|
+
/** The filter ID (bookmarkId) */
|
|
426
|
+
readonly id?: string;
|
|
427
|
+
/** The filter name. */
|
|
428
|
+
readonly name?: string;
|
|
429
|
+
/** The user that owns the filter, if missing the same as the request user. */
|
|
430
|
+
readonly ownerId?: string;
|
|
431
|
+
readonly updatedAt?: string;
|
|
432
|
+
};
|
|
433
|
+
type FilterRequest = {
|
|
434
|
+
/** The App ID. */
|
|
435
|
+
appId?: string;
|
|
436
|
+
/** The filter description. */
|
|
437
|
+
description?: string;
|
|
438
|
+
filterType: FilterType;
|
|
439
|
+
filterV1_0?: FilterV10;
|
|
440
|
+
filterVersion: "filter-1.0";
|
|
441
|
+
/** The filter name. */
|
|
442
|
+
name: string;
|
|
443
|
+
/** The user that owns the filter, if missing the same as the request user. */
|
|
444
|
+
ownerId?: string;
|
|
445
|
+
};
|
|
446
|
+
type FilterType = "REP" | "SUB";
|
|
447
|
+
type FilterV10 = {
|
|
448
|
+
/** 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. */
|
|
449
|
+
fieldsByState?: unknown;
|
|
450
|
+
/** The filter variables. */
|
|
451
|
+
variables?: FilterVariable[];
|
|
452
|
+
};
|
|
453
|
+
type FilterVariable = {
|
|
454
|
+
evaluate?: boolean;
|
|
455
|
+
name: string;
|
|
456
|
+
value?: string;
|
|
457
|
+
};
|
|
458
|
+
type FiltersCount = {
|
|
459
|
+
/** The total number of filters. */
|
|
460
|
+
readonly total?: number;
|
|
461
|
+
};
|
|
462
|
+
type Float64 = number;
|
|
357
463
|
type FrequencyDistributionData = {
|
|
358
464
|
/** Bins edges. */
|
|
359
465
|
BinsEdges?: number[];
|
|
@@ -381,23 +487,31 @@ type LastReloadMetadata = {
|
|
|
381
487
|
};
|
|
382
488
|
type LineageInfoRest = {
|
|
383
489
|
/** A string indicating the origin of the data:
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
490
|
+
* * [filename]: the data comes from a local file.
|
|
491
|
+
* * INLINE: the data is entered inline in the load script.
|
|
492
|
+
* * RESIDENT: the data comes from a resident table. The table name is listed.
|
|
493
|
+
* * AUTOGENERATE: the data is generated from the load script (no external table of data source).
|
|
494
|
+
* * Provider: the data comes from a data connection. The connector source name is listed.
|
|
495
|
+
* * [webfile]: the data comes from a web-based file.
|
|
496
|
+
* * STORE: path to QVD or TXT file where data is stored.
|
|
497
|
+
* * EXTENSION: the data comes from a Server Side Extension (SSE). */
|
|
392
498
|
discriminator?: string;
|
|
393
499
|
/** The LOAD and SELECT script statements from the data load script. */
|
|
394
500
|
statement?: string;
|
|
395
501
|
};
|
|
502
|
+
type LinkResponse = {
|
|
503
|
+
href?: string;
|
|
504
|
+
};
|
|
396
505
|
type Links = {
|
|
397
506
|
next?: Href;
|
|
398
507
|
prev?: Href;
|
|
399
508
|
self?: Href;
|
|
400
509
|
};
|
|
510
|
+
type LinksResponse = {
|
|
511
|
+
next: LinkResponse;
|
|
512
|
+
prev: LinkResponse;
|
|
513
|
+
self: LinkResponse;
|
|
514
|
+
};
|
|
401
515
|
type Log = {
|
|
402
516
|
/** Provides a link to download the log file. */
|
|
403
517
|
log?: string;
|
|
@@ -415,20 +529,20 @@ type NxApp = {
|
|
|
415
529
|
/** Object create privileges. Hints to the client what type of objects the user is allowed to create. */
|
|
416
530
|
create?: NxAppCreatePrivileges[];
|
|
417
531
|
/** Application privileges.
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
532
|
+
* Hints to the client what actions the user is allowed to perform.
|
|
533
|
+
* Could be any of:
|
|
534
|
+
* * read
|
|
535
|
+
* * create
|
|
536
|
+
* * update
|
|
537
|
+
* * delete
|
|
538
|
+
* * reload
|
|
539
|
+
* * import
|
|
540
|
+
* * publish
|
|
541
|
+
* * duplicate
|
|
542
|
+
* * export
|
|
543
|
+
* * exportdata
|
|
544
|
+
* * change_owner
|
|
545
|
+
* * change_space */
|
|
432
546
|
privileges?: string[];
|
|
433
547
|
};
|
|
434
548
|
type NxAppCreatePrivileges = {
|
|
@@ -441,15 +555,15 @@ type NxAppObject = {
|
|
|
441
555
|
/** App object attributes. This structure can also contain extra user-defined attributes. */
|
|
442
556
|
attributes?: NxObjectAttributes;
|
|
443
557
|
/** Application object privileges.
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
558
|
+
* Hints to the client what actions the user is allowed to perform.
|
|
559
|
+
* Could be any of:
|
|
560
|
+
* * read
|
|
561
|
+
* * create
|
|
562
|
+
* * update
|
|
563
|
+
* * delete
|
|
564
|
+
* * publish
|
|
565
|
+
* * exportdata
|
|
566
|
+
* * change_owner */
|
|
453
567
|
privileges?: string[];
|
|
454
568
|
};
|
|
455
569
|
type NxAttributes = {
|
|
@@ -488,9 +602,9 @@ type NxAttributes = {
|
|
|
488
602
|
/** App thumbnail. */
|
|
489
603
|
thumbnail?: string;
|
|
490
604
|
/**
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
605
|
+
* One of:
|
|
606
|
+
* * ANALYTICS
|
|
607
|
+
* * DATA_PREPARATION */
|
|
494
608
|
usage?: "ANALYTICS" | "DATA_PREPARATION";
|
|
495
609
|
};
|
|
496
610
|
type NxObjectAttributes = {
|
|
@@ -501,13 +615,13 @@ type NxObjectAttributes = {
|
|
|
501
615
|
/** Object description. */
|
|
502
616
|
description?: string;
|
|
503
617
|
/** The generic type of the object.
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
618
|
+
*
|
|
619
|
+
* One of:
|
|
620
|
+
* * genericObject
|
|
621
|
+
* * genericBookmark
|
|
622
|
+
* * genericMeasure
|
|
623
|
+
* * genericDimension
|
|
624
|
+
* * genericVariable */
|
|
511
625
|
genericType?: "genericObject" | "genericBookmark" | "genericMeasure" | "genericDimension" | "genericVariable";
|
|
512
626
|
/** The object Id. */
|
|
513
627
|
id?: string;
|
|
@@ -524,18 +638,18 @@ type NxObjectAttributes = {
|
|
|
524
638
|
};
|
|
525
639
|
type NxPatch = {
|
|
526
640
|
/** Operation to perform.
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
641
|
+
*
|
|
642
|
+
* One of:
|
|
643
|
+
* * add or Add
|
|
644
|
+
* * remove or Remove
|
|
645
|
+
* * replace or Replace */
|
|
532
646
|
Op?: "Add" | "Remove" | "Replace";
|
|
533
647
|
/** Path to the property to add, remove or replace. */
|
|
534
648
|
Path?: string;
|
|
535
649
|
/** This parameter is not used in a remove operation.
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
650
|
+
* Corresponds to the value of the property to add or to the new value of the property to update.
|
|
651
|
+
* Examples:
|
|
652
|
+
* "false", "2", "\"New title\"" */
|
|
539
653
|
Value?: string;
|
|
540
654
|
};
|
|
541
655
|
type PartialNluInfo = {
|
|
@@ -553,10 +667,10 @@ type PartialNluInfo = {
|
|
|
553
667
|
type PublishApp = {
|
|
554
668
|
attributes?: AppUpdateAttributes;
|
|
555
669
|
/** The published app will have data from source or target app.
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
670
|
+
* The default is source.
|
|
671
|
+
*
|
|
672
|
+
* * source: Publish with source data
|
|
673
|
+
* * target: Publish with target data */
|
|
560
674
|
data?: "source" | "target";
|
|
561
675
|
/** The original is moved instead of copied. The current published state of all objects is kept. */
|
|
562
676
|
moveApp?: boolean;
|
|
@@ -619,7 +733,7 @@ type ReloadMeta = {
|
|
|
619
733
|
/** If greater than or equal 0, defines max number of rows loaded from a data source. */
|
|
620
734
|
rowLimit?: number;
|
|
621
735
|
/** Set to true to skip Store statements.
|
|
622
|
-
|
|
736
|
+
* The default value is false. */
|
|
623
737
|
skipStore?: boolean;
|
|
624
738
|
/** List of external loaded or stored statements. */
|
|
625
739
|
statements?: ReloadStatements[];
|
|
@@ -657,10 +771,10 @@ type RepublishApp = {
|
|
|
657
771
|
/** Validate that source app is same as originally published. */
|
|
658
772
|
checkOriginAppId?: boolean;
|
|
659
773
|
/** The republished app will have data from source or target app.
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
774
|
+
* The default is source.
|
|
775
|
+
*
|
|
776
|
+
* * source: Publish with source data
|
|
777
|
+
* * target: Publish with target data */
|
|
664
778
|
data?: "source" | "target";
|
|
665
779
|
/** The target ID to be republished. */
|
|
666
780
|
targetId?: string;
|
|
@@ -721,13 +835,13 @@ type TableMetadata = {
|
|
|
721
835
|
/** Table comment. */
|
|
722
836
|
comment?: string;
|
|
723
837
|
/** If set to true, the table is loose due to circular connection.
|
|
724
|
-
|
|
838
|
+
* The default value is false. */
|
|
725
839
|
is_loose?: boolean;
|
|
726
840
|
/** If set to true, the table is semantic.
|
|
727
|
-
|
|
841
|
+
* The default value is false. */
|
|
728
842
|
is_semantic?: boolean;
|
|
729
843
|
/** If set to true, the table is a system table.
|
|
730
|
-
|
|
844
|
+
* The default value is false. */
|
|
731
845
|
is_system?: boolean;
|
|
732
846
|
/** Name of the table. */
|
|
733
847
|
name?: string;
|
|
@@ -976,6 +1090,7 @@ type Sortedcomparisontables = {
|
|
|
976
1090
|
};
|
|
977
1091
|
/**
|
|
978
1092
|
* Creates a new app.
|
|
1093
|
+
*
|
|
979
1094
|
* @param body an object with the body content
|
|
980
1095
|
* @throws CreateAppHttpError
|
|
981
1096
|
*/
|
|
@@ -1074,6 +1189,7 @@ type GetAppEvaluationXmlHttpError = {
|
|
|
1074
1189
|
};
|
|
1075
1190
|
/**
|
|
1076
1191
|
* Imports an app into the system.
|
|
1192
|
+
*
|
|
1077
1193
|
* @param query an object with query parameters
|
|
1078
1194
|
* @param body an object with the body content
|
|
1079
1195
|
* @throws ImportAppHttpError
|
|
@@ -1088,16 +1204,16 @@ declare const importApp: (query: {
|
|
|
1088
1204
|
/** The file ID to be downloaded from Temporary Content Service (TCS) and used during import. */
|
|
1089
1205
|
fileId?: string;
|
|
1090
1206
|
/** The import mode. In `new` mode (default), the source app will be imported as a new app.<div class=note>The `autoreplace` mode is an internal mode only and is not permitted for external use.</div>
|
|
1091
|
-
|
|
1092
|
-
|
|
1093
|
-
|
|
1094
|
-
|
|
1207
|
+
*
|
|
1208
|
+
* One of:
|
|
1209
|
+
* * NEW
|
|
1210
|
+
* * AUTOREPLACE */
|
|
1095
1211
|
mode?: string;
|
|
1096
1212
|
/** The name of the target app. */
|
|
1097
1213
|
name?: string;
|
|
1098
1214
|
/** The space ID of the target app. */
|
|
1099
1215
|
spaceId?: string;
|
|
1100
|
-
}, body:
|
|
1216
|
+
}, body: FileData, options?: ApiCallOptions) => Promise<ImportAppHttpResponse>;
|
|
1101
1217
|
type ImportAppHttpResponse = {
|
|
1102
1218
|
data: NxApp;
|
|
1103
1219
|
headers: Headers;
|
|
@@ -1110,6 +1226,7 @@ type ImportAppHttpError = {
|
|
|
1110
1226
|
};
|
|
1111
1227
|
/**
|
|
1112
1228
|
* Gets the app privileges for the current user, such as create app and import app. Empty means that the current user has no app privileges.
|
|
1229
|
+
*
|
|
1113
1230
|
* @throws GetAppsPrivilegesHttpError
|
|
1114
1231
|
*/
|
|
1115
1232
|
declare const getAppsPrivileges: (options?: ApiCallOptions) => Promise<GetAppsPrivilegesHttpResponse>;
|
|
@@ -1125,6 +1242,7 @@ type GetAppsPrivilegesHttpError = {
|
|
|
1125
1242
|
};
|
|
1126
1243
|
/**
|
|
1127
1244
|
* Deletes a specific app.
|
|
1245
|
+
*
|
|
1128
1246
|
* @param appId Identifier of the app.
|
|
1129
1247
|
* @throws DeleteAppHttpError
|
|
1130
1248
|
*/
|
|
@@ -1141,6 +1259,7 @@ type DeleteAppHttpError = {
|
|
|
1141
1259
|
};
|
|
1142
1260
|
/**
|
|
1143
1261
|
* Retrieves information for a specific app.
|
|
1262
|
+
*
|
|
1144
1263
|
* @param appId Identifier of the app.
|
|
1145
1264
|
* @throws GetAppInfoHttpError
|
|
1146
1265
|
*/
|
|
@@ -1157,6 +1276,7 @@ type GetAppInfoHttpError = {
|
|
|
1157
1276
|
};
|
|
1158
1277
|
/**
|
|
1159
1278
|
* Updates the information for a specific app.
|
|
1279
|
+
*
|
|
1160
1280
|
* @param appId Identifier of the app.
|
|
1161
1281
|
* @param body an object with the body content
|
|
1162
1282
|
* @throws UpdateAppInfoHttpError
|
|
@@ -1174,6 +1294,7 @@ type UpdateAppInfoHttpError = {
|
|
|
1174
1294
|
};
|
|
1175
1295
|
/**
|
|
1176
1296
|
* Copies a specific app.
|
|
1297
|
+
*
|
|
1177
1298
|
* @param appId Identifier of the app.
|
|
1178
1299
|
* @param body an object with the body content
|
|
1179
1300
|
* @throws CopyAppHttpError
|
|
@@ -1192,6 +1313,7 @@ type CopyAppHttpError = {
|
|
|
1192
1313
|
/**
|
|
1193
1314
|
* Retrieves the lineage for an app.
|
|
1194
1315
|
* Returns a JSON-formatted array of strings describing the lineage of the app.
|
|
1316
|
+
*
|
|
1195
1317
|
* @param appId Identifier of the app.
|
|
1196
1318
|
* @throws GetAppDataLineageHttpError
|
|
1197
1319
|
*/
|
|
@@ -1209,6 +1331,7 @@ type GetAppDataLineageHttpError = {
|
|
|
1209
1331
|
/**
|
|
1210
1332
|
* Retrieves the data model and reload statistics metadata of an app.
|
|
1211
1333
|
* An empty metadata structure is returned if the metadata is not available in the app.
|
|
1334
|
+
*
|
|
1212
1335
|
* @param appId Identifier of the app.
|
|
1213
1336
|
* @throws GetAppDataMetadataHttpError
|
|
1214
1337
|
*/
|
|
@@ -1225,6 +1348,7 @@ type GetAppDataMetadataHttpError = {
|
|
|
1225
1348
|
};
|
|
1226
1349
|
/**
|
|
1227
1350
|
* Exports a specific app.
|
|
1351
|
+
*
|
|
1228
1352
|
* @param appId Identifier of the app.
|
|
1229
1353
|
* @param query an object with query parameters
|
|
1230
1354
|
* @throws ExportAppHttpError
|
|
@@ -1245,6 +1369,7 @@ type ExportAppHttpError = {
|
|
|
1245
1369
|
};
|
|
1246
1370
|
/**
|
|
1247
1371
|
* Returns information about supported analyses for the app's data model. Lists available analysis types, along with minimum and maximum number of dimensions, measures, and fields.
|
|
1372
|
+
*
|
|
1248
1373
|
* @param appId Qlik Sense app identifier
|
|
1249
1374
|
* @throws GetAppInsightAnalysesHttpError
|
|
1250
1375
|
*/
|
|
@@ -1263,6 +1388,7 @@ type GetAppInsightAnalysesHttpError = {
|
|
|
1263
1388
|
};
|
|
1264
1389
|
/**
|
|
1265
1390
|
* Returns analysis recommendations in response to a natural language question, a set of fields and master items, or a set of fields and master items with an optional target analysis.
|
|
1391
|
+
*
|
|
1266
1392
|
* @param appId Qlik Sense app identifier
|
|
1267
1393
|
* @param body an object with the body content
|
|
1268
1394
|
* @throws GetAppInsightAnalysisRecommendationsHttpError
|
|
@@ -1280,6 +1406,7 @@ type GetAppInsightAnalysisRecommendationsHttpError = {
|
|
|
1280
1406
|
};
|
|
1281
1407
|
/**
|
|
1282
1408
|
* Returns information about model used to make analysis recommendations. Lists all fields and master items in the logical model, along with an indication of the validity of the logical model if the default is not used.
|
|
1409
|
+
*
|
|
1283
1410
|
* @param appId Qlik Sense app identifier
|
|
1284
1411
|
* @throws GetAppInsightAnalysisModelHttpError
|
|
1285
1412
|
*/
|
|
@@ -1299,6 +1426,7 @@ type GetAppInsightAnalysisModelHttpError = {
|
|
|
1299
1426
|
/**
|
|
1300
1427
|
* Deletes a media content file or complete directory.
|
|
1301
1428
|
* Returns OK if the bytes containing the media file (or the complete content of a directory) were successfully deleted, or error in case of failure or lack of permission.
|
|
1429
|
+
*
|
|
1302
1430
|
* @param appId Unique application identifier.
|
|
1303
1431
|
* @param path Path to file content.
|
|
1304
1432
|
* @throws DeleteAppMediaHttpError
|
|
@@ -1317,6 +1445,7 @@ type DeleteAppMediaHttpError = {
|
|
|
1317
1445
|
/**
|
|
1318
1446
|
* Gets media content from file.
|
|
1319
1447
|
* Returns a stream of bytes containing the media file content on success, or error if file is not found.
|
|
1448
|
+
*
|
|
1320
1449
|
* @param appId Unique application identifier.
|
|
1321
1450
|
* @param path Path to file content.
|
|
1322
1451
|
* @throws GetAppMediaHttpError
|
|
@@ -1335,12 +1464,13 @@ type GetAppMediaHttpError = {
|
|
|
1335
1464
|
/**
|
|
1336
1465
|
* Stores the media content file.
|
|
1337
1466
|
* Returns OK if the bytes containing the media file content were successfully stored, or error in case of failure, lack of permission or file already exists on the supplied path.
|
|
1467
|
+
*
|
|
1338
1468
|
* @param appId Unique application identifier.
|
|
1339
1469
|
* @param path Path to file content.
|
|
1340
1470
|
* @param body an object with the body content
|
|
1341
1471
|
* @throws UploadAppMediaHttpError
|
|
1342
1472
|
*/
|
|
1343
|
-
declare const uploadAppMedia: (appId: string, path: string, body:
|
|
1473
|
+
declare const uploadAppMedia: (appId: string, path: string, body: FileData, options?: ApiCallOptions) => Promise<UploadAppMediaHttpResponse>;
|
|
1344
1474
|
type UploadAppMediaHttpResponse = {
|
|
1345
1475
|
data: void;
|
|
1346
1476
|
headers: Headers;
|
|
@@ -1354,6 +1484,7 @@ type UploadAppMediaHttpError = {
|
|
|
1354
1484
|
/**
|
|
1355
1485
|
* Lists media content.
|
|
1356
1486
|
* Returns a JSON formatted array of strings describing the available media content or error if the optional path supplied is not found.
|
|
1487
|
+
*
|
|
1357
1488
|
* @param appId Unique application identifier.
|
|
1358
1489
|
* @param path The path to sub folder with static content relative to the root folder. Use empty path to access the root folder.
|
|
1359
1490
|
* @param query an object with query parameters
|
|
@@ -1361,9 +1492,9 @@ type UploadAppMediaHttpError = {
|
|
|
1361
1492
|
*/
|
|
1362
1493
|
declare const getAppMediaList: (appId: string, path: string, query: {
|
|
1363
1494
|
/** Optional. List output can include files and folders in different ways:
|
|
1364
|
-
|
|
1365
|
-
|
|
1366
|
-
|
|
1495
|
+
* * Not recursive, default if show option is not supplied or incorrectly specified, results in output with files and empty directories for the path specified only.
|
|
1496
|
+
* * Recursive(r), use ?show=r or ?show=recursive, results in a recursive output with files, all empty folders are excluded.
|
|
1497
|
+
* * All(a), use ?show=a or ?show=all, results in a recursive output with files and empty directories. */
|
|
1367
1498
|
show?: string;
|
|
1368
1499
|
}, options?: ApiCallOptions) => Promise<GetAppMediaListHttpResponse>;
|
|
1369
1500
|
type GetAppMediaListHttpResponse = {
|
|
@@ -1380,6 +1511,7 @@ type GetAppMediaListHttpError = {
|
|
|
1380
1511
|
* Gets media content from file currently used as application thumbnail.
|
|
1381
1512
|
* Returns a stream of bytes containing the media file content on success, or error if file is not found.
|
|
1382
1513
|
* The image selected as thumbnail is only updated when application is saved.
|
|
1514
|
+
*
|
|
1383
1515
|
* @param appId Unique application identifier.
|
|
1384
1516
|
* @throws GetAppThumbnailHttpError
|
|
1385
1517
|
*/
|
|
@@ -1397,6 +1529,7 @@ type GetAppThumbnailHttpError = {
|
|
|
1397
1529
|
/**
|
|
1398
1530
|
* Sets owner on an app object.
|
|
1399
1531
|
* The user must be the owner of the object.
|
|
1532
|
+
*
|
|
1400
1533
|
* @param appId Identifier of the app.
|
|
1401
1534
|
* @param objectId Identifier of the object.
|
|
1402
1535
|
* @param body an object with the body content
|
|
@@ -1415,6 +1548,7 @@ type UpdateAppObjectOwnerHttpError = {
|
|
|
1415
1548
|
};
|
|
1416
1549
|
/**
|
|
1417
1550
|
* Changes owner of the app.
|
|
1551
|
+
*
|
|
1418
1552
|
* @param appId Identifier of the app.
|
|
1419
1553
|
* @param body an object with the body content
|
|
1420
1554
|
* @throws UpdateAppOwnerHttpError
|
|
@@ -1432,6 +1566,7 @@ type UpdateAppOwnerHttpError = {
|
|
|
1432
1566
|
};
|
|
1433
1567
|
/**
|
|
1434
1568
|
* Publishes a specific app to a managed space.
|
|
1569
|
+
*
|
|
1435
1570
|
* @param appId Identifier of the app.
|
|
1436
1571
|
* @param body an object with the body content
|
|
1437
1572
|
* @throws PublishAppHttpError
|
|
@@ -1449,6 +1584,7 @@ type PublishAppHttpError = {
|
|
|
1449
1584
|
};
|
|
1450
1585
|
/**
|
|
1451
1586
|
* Republishes a published app to a managed space.
|
|
1587
|
+
*
|
|
1452
1588
|
* @param appId Identifier of the app.
|
|
1453
1589
|
* @param body an object with the body content
|
|
1454
1590
|
* @throws RepublishAppHttpError
|
|
@@ -1467,6 +1603,7 @@ type RepublishAppHttpError = {
|
|
|
1467
1603
|
/**
|
|
1468
1604
|
* Retrieves the metadata about all script logs stored for an app.
|
|
1469
1605
|
* Returns an array of ScriptLogMeta objects.
|
|
1606
|
+
*
|
|
1470
1607
|
* @param appId Identifier of the app.
|
|
1471
1608
|
* @throws GetAppReloadLogsHttpError
|
|
1472
1609
|
*/
|
|
@@ -1484,6 +1621,7 @@ type GetAppReloadLogsHttpError = {
|
|
|
1484
1621
|
/**
|
|
1485
1622
|
* Retrieves the log of a specific reload.
|
|
1486
1623
|
* Returns the log as "text/plain; charset=UTF-8".
|
|
1624
|
+
*
|
|
1487
1625
|
* @param appId Identifier of the app.
|
|
1488
1626
|
* @param reloadId Identifier of the reload.
|
|
1489
1627
|
* @throws GetAppReloadLogHttpError
|
|
@@ -1502,6 +1640,7 @@ type GetAppReloadLogHttpError = {
|
|
|
1502
1640
|
/**
|
|
1503
1641
|
* Retrieves the app reload metadata list.
|
|
1504
1642
|
* Reload metadata contains reload information, including reload id, duration, endtime and lineage load info.
|
|
1643
|
+
*
|
|
1505
1644
|
* @param appId Identifier of the app
|
|
1506
1645
|
* @param reloadId Identifier of the reload. Use empty reloadId to get all reloads.
|
|
1507
1646
|
* @param query an object with query parameters
|
|
@@ -1521,18 +1660,131 @@ type GetAppReloadMetadataHttpError = {
|
|
|
1521
1660
|
headers: Headers;
|
|
1522
1661
|
status: number;
|
|
1523
1662
|
};
|
|
1663
|
+
/**
|
|
1664
|
+
* List all filters that are present in the given app. Filters allow to reduce the app data visible in a report output. Each filter can contain definitions on one or multiple fields.
|
|
1665
|
+
*
|
|
1666
|
+
* @param appId Qlik Sense app identifier
|
|
1667
|
+
* @param query an object with query parameters
|
|
1668
|
+
* @throws GetAppReportFiltersHttpError
|
|
1669
|
+
*/
|
|
1670
|
+
declare const getAppReportFilters: (appId: string, query: {
|
|
1671
|
+
/** The advanced filtering to use for the query. Refer to [RFC 7644](https://datatracker.ietf.org/doc/rfc7644/) for the syntax. Cannot be combined with any of the fields marked as deprecated. All conditional statements within this query parameter are case insensitive.
|
|
1672
|
+
* The following fields support the `co` (contains) operator: `name` , `description`
|
|
1673
|
+
* The following fields support the `eq` (equals) operator: `ownerId`
|
|
1674
|
+
* ```
|
|
1675
|
+
* Example:
|
|
1676
|
+
* ```
|
|
1677
|
+
* (name co "query1" or description co "query2") and ownerId eq "123"
|
|
1678
|
+
* ``` */
|
|
1679
|
+
filter?: string;
|
|
1680
|
+
/** The filter type (REP, SUB). REP stands for report bookmark, SUB for subscription bookmark. */
|
|
1681
|
+
filterTypes?: ("REP" | "SUB")[];
|
|
1682
|
+
/** Limit the returned result set */
|
|
1683
|
+
limit?: number;
|
|
1684
|
+
/** If present, the cursor that starts the page of data that is returned. */
|
|
1685
|
+
page?: string;
|
|
1686
|
+
sort?: ("+ownerId" | "-ownerId" | "-name" | "+name" | "+description" | "-description" | "+createdAt" | "-createdAt" | "+updatedAt" | "-updatedAt")[];
|
|
1687
|
+
}, options?: ApiCallOptions) => Promise<GetAppReportFiltersHttpResponse>;
|
|
1688
|
+
type GetAppReportFiltersHttpResponse = {
|
|
1689
|
+
data: FilterList;
|
|
1690
|
+
headers: Headers;
|
|
1691
|
+
status: number;
|
|
1692
|
+
prev?: (options?: ApiCallOptions) => Promise<GetAppReportFiltersHttpResponse>;
|
|
1693
|
+
next?: (options?: ApiCallOptions) => Promise<GetAppReportFiltersHttpResponse>;
|
|
1694
|
+
};
|
|
1695
|
+
type GetAppReportFiltersHttpError = {
|
|
1696
|
+
data: FilterErrors;
|
|
1697
|
+
headers: Headers;
|
|
1698
|
+
status: number;
|
|
1699
|
+
};
|
|
1700
|
+
/**
|
|
1701
|
+
* Creates a new report filter which is used to re-apply selections, variables, patches to an engine session.
|
|
1702
|
+
*
|
|
1703
|
+
* @param appId Qlik Sense app identifier
|
|
1704
|
+
* @param body an object with the body content
|
|
1705
|
+
* @throws CreateAppReportFilterHttpError
|
|
1706
|
+
*/
|
|
1707
|
+
declare const createAppReportFilter: (appId: string, body: FilterRequest, options?: ApiCallOptions) => Promise<CreateAppReportFilterHttpResponse>;
|
|
1708
|
+
type CreateAppReportFilterHttpResponse = {
|
|
1709
|
+
data: Filter;
|
|
1710
|
+
headers: Headers;
|
|
1711
|
+
status: number;
|
|
1712
|
+
};
|
|
1713
|
+
type CreateAppReportFilterHttpError = {
|
|
1714
|
+
data: FilterErrors;
|
|
1715
|
+
headers: Headers;
|
|
1716
|
+
status: number;
|
|
1717
|
+
};
|
|
1718
|
+
/**
|
|
1719
|
+
* Get the number of filters for the given app and filter types
|
|
1720
|
+
*
|
|
1721
|
+
* @param appId Qlik Sense app identifier
|
|
1722
|
+
* @param query an object with query parameters
|
|
1723
|
+
* @throws CountAppReportFiltersHttpError
|
|
1724
|
+
*/
|
|
1725
|
+
declare const countAppReportFilters: (appId: string, query: {
|
|
1726
|
+
/** The filter type (REP, SUB). REP stands for report bookmark, SUB for subscription bookmark. */
|
|
1727
|
+
filterTypes?: ("REP" | "SUB")[];
|
|
1728
|
+
}, options?: ApiCallOptions) => Promise<CountAppReportFiltersHttpResponse>;
|
|
1729
|
+
type CountAppReportFiltersHttpResponse = {
|
|
1730
|
+
data: FiltersCount;
|
|
1731
|
+
headers: Headers;
|
|
1732
|
+
status: number;
|
|
1733
|
+
};
|
|
1734
|
+
type CountAppReportFiltersHttpError = {
|
|
1735
|
+
data: FilterErrors;
|
|
1736
|
+
headers: Headers;
|
|
1737
|
+
status: number;
|
|
1738
|
+
};
|
|
1739
|
+
/**
|
|
1740
|
+
* Delete a filter
|
|
1741
|
+
*
|
|
1742
|
+
* @param appId Qlik Sense app identifier
|
|
1743
|
+
* @param id The filter id identifier (bookmarkId).
|
|
1744
|
+
* @throws DeleteAppReportFilterHttpError
|
|
1745
|
+
*/
|
|
1746
|
+
declare const deleteAppReportFilter: (appId: string, id: string, options?: ApiCallOptions) => Promise<DeleteAppReportFilterHttpResponse>;
|
|
1747
|
+
type DeleteAppReportFilterHttpResponse = {
|
|
1748
|
+
data: void;
|
|
1749
|
+
headers: Headers;
|
|
1750
|
+
status: number;
|
|
1751
|
+
};
|
|
1752
|
+
type DeleteAppReportFilterHttpError = {
|
|
1753
|
+
data: FilterErrors;
|
|
1754
|
+
headers: Headers;
|
|
1755
|
+
status: number;
|
|
1756
|
+
};
|
|
1757
|
+
/**
|
|
1758
|
+
* Get a filter
|
|
1759
|
+
*
|
|
1760
|
+
* @param appId Qlik Sense app identifier
|
|
1761
|
+
* @param id The filter id identifier (bookmarkId).
|
|
1762
|
+
* @throws GetAppReportFilterHttpError
|
|
1763
|
+
*/
|
|
1764
|
+
declare const getAppReportFilter: (appId: string, id: string, options?: ApiCallOptions) => Promise<GetAppReportFilterHttpResponse>;
|
|
1765
|
+
type GetAppReportFilterHttpResponse = {
|
|
1766
|
+
data: Filter;
|
|
1767
|
+
headers: Headers;
|
|
1768
|
+
status: number;
|
|
1769
|
+
};
|
|
1770
|
+
type GetAppReportFilterHttpError = {
|
|
1771
|
+
data: FilterErrors;
|
|
1772
|
+
headers: Headers;
|
|
1773
|
+
status: number;
|
|
1774
|
+
};
|
|
1524
1775
|
/**
|
|
1525
1776
|
* Retrieves the script history for an app.
|
|
1526
1777
|
* Returns information about the saved versions of the script.
|
|
1778
|
+
*
|
|
1527
1779
|
* @param appId Identifier of the app.
|
|
1528
1780
|
* @param query an object with query parameters
|
|
1529
1781
|
* @throws GetAppScriptHistoryHttpError
|
|
1530
1782
|
*/
|
|
1531
1783
|
declare const getAppScriptHistory: (appId: string, query: {
|
|
1532
1784
|
/** A scim filter expression defining which script versions should be retrieved. Filterable fields are:
|
|
1533
|
-
|
|
1534
|
-
|
|
1535
|
-
|
|
1785
|
+
* * ScriptId
|
|
1786
|
+
* * ModifiedTime
|
|
1787
|
+
* * ModifierId */
|
|
1536
1788
|
filter?: string;
|
|
1537
1789
|
/** Maximum number of records to return from this request. */
|
|
1538
1790
|
limit?: string;
|
|
@@ -1553,6 +1805,7 @@ type GetAppScriptHistoryHttpError = {
|
|
|
1553
1805
|
};
|
|
1554
1806
|
/**
|
|
1555
1807
|
* Sets script for an app.
|
|
1808
|
+
*
|
|
1556
1809
|
* @param appId Identifier of the app.
|
|
1557
1810
|
* @param body an object with the body content
|
|
1558
1811
|
* @throws UpdateAppScriptHttpError
|
|
@@ -1571,6 +1824,7 @@ type UpdateAppScriptHttpError = {
|
|
|
1571
1824
|
/**
|
|
1572
1825
|
* Deletes a specific version of the script for an app.
|
|
1573
1826
|
* Fails if the version to delete is the current version.
|
|
1827
|
+
*
|
|
1574
1828
|
* @param appId Identifier of the app.
|
|
1575
1829
|
* @param version Identifier of the script version
|
|
1576
1830
|
* @throws DeleteAppScriptHttpError
|
|
@@ -1589,6 +1843,7 @@ type DeleteAppScriptHttpError = {
|
|
|
1589
1843
|
/**
|
|
1590
1844
|
* Retrieves a version of the script for an app.
|
|
1591
1845
|
* Returns the script text.
|
|
1846
|
+
*
|
|
1592
1847
|
* @param appId Identifier of the app.
|
|
1593
1848
|
* @param version Identifier of the script version, or 'current' for retrieving the current version.
|
|
1594
1849
|
* @throws GetAppScriptHttpError
|
|
@@ -1606,6 +1861,7 @@ type GetAppScriptHttpError = {
|
|
|
1606
1861
|
};
|
|
1607
1862
|
/**
|
|
1608
1863
|
* Updates a specific version of the script for an app.
|
|
1864
|
+
*
|
|
1609
1865
|
* @param appId Identifier of the app.
|
|
1610
1866
|
* @param version Identifier of the script version.
|
|
1611
1867
|
* @param body an object with the body content
|
|
@@ -1624,6 +1880,7 @@ type PatchAppScriptHttpError = {
|
|
|
1624
1880
|
};
|
|
1625
1881
|
/**
|
|
1626
1882
|
* Removes space from a specific app.
|
|
1883
|
+
*
|
|
1627
1884
|
* @param appId Identifier of the app.
|
|
1628
1885
|
* @throws RemoveAppFromSpaceHttpError
|
|
1629
1886
|
*/
|
|
@@ -1640,6 +1897,7 @@ type RemoveAppFromSpaceHttpError = {
|
|
|
1640
1897
|
};
|
|
1641
1898
|
/**
|
|
1642
1899
|
* Sets space on a specific app.
|
|
1900
|
+
*
|
|
1643
1901
|
* @param appId Identifier of the app.
|
|
1644
1902
|
* @param body an object with the body content
|
|
1645
1903
|
* @throws MoveAppToSpaceHttpError
|
|
@@ -1715,6 +1973,7 @@ declare function clearCache(): void;
|
|
|
1715
1973
|
interface AppsAPI {
|
|
1716
1974
|
/**
|
|
1717
1975
|
* Creates a new app.
|
|
1976
|
+
*
|
|
1718
1977
|
* @param body an object with the body content
|
|
1719
1978
|
* @throws CreateAppHttpError
|
|
1720
1979
|
*/
|
|
@@ -1753,6 +2012,7 @@ interface AppsAPI {
|
|
|
1753
2012
|
getAppEvaluationXml: typeof getAppEvaluationXml;
|
|
1754
2013
|
/**
|
|
1755
2014
|
* Imports an app into the system.
|
|
2015
|
+
*
|
|
1756
2016
|
* @param query an object with query parameters
|
|
1757
2017
|
* @param body an object with the body content
|
|
1758
2018
|
* @throws ImportAppHttpError
|
|
@@ -1760,23 +2020,27 @@ interface AppsAPI {
|
|
|
1760
2020
|
importApp: typeof importApp;
|
|
1761
2021
|
/**
|
|
1762
2022
|
* Gets the app privileges for the current user, such as create app and import app. Empty means that the current user has no app privileges.
|
|
2023
|
+
*
|
|
1763
2024
|
* @throws GetAppsPrivilegesHttpError
|
|
1764
2025
|
*/
|
|
1765
2026
|
getAppsPrivileges: typeof getAppsPrivileges;
|
|
1766
2027
|
/**
|
|
1767
2028
|
* Deletes a specific app.
|
|
2029
|
+
*
|
|
1768
2030
|
* @param appId Identifier of the app.
|
|
1769
2031
|
* @throws DeleteAppHttpError
|
|
1770
2032
|
*/
|
|
1771
2033
|
deleteApp: typeof deleteApp;
|
|
1772
2034
|
/**
|
|
1773
2035
|
* Retrieves information for a specific app.
|
|
2036
|
+
*
|
|
1774
2037
|
* @param appId Identifier of the app.
|
|
1775
2038
|
* @throws GetAppInfoHttpError
|
|
1776
2039
|
*/
|
|
1777
2040
|
getAppInfo: typeof getAppInfo;
|
|
1778
2041
|
/**
|
|
1779
2042
|
* Updates the information for a specific app.
|
|
2043
|
+
*
|
|
1780
2044
|
* @param appId Identifier of the app.
|
|
1781
2045
|
* @param body an object with the body content
|
|
1782
2046
|
* @throws UpdateAppInfoHttpError
|
|
@@ -1784,6 +2048,7 @@ interface AppsAPI {
|
|
|
1784
2048
|
updateAppInfo: typeof updateAppInfo;
|
|
1785
2049
|
/**
|
|
1786
2050
|
* Copies a specific app.
|
|
2051
|
+
*
|
|
1787
2052
|
* @param appId Identifier of the app.
|
|
1788
2053
|
* @param body an object with the body content
|
|
1789
2054
|
* @throws CopyAppHttpError
|
|
@@ -1792,6 +2057,7 @@ interface AppsAPI {
|
|
|
1792
2057
|
/**
|
|
1793
2058
|
* Retrieves the lineage for an app.
|
|
1794
2059
|
* Returns a JSON-formatted array of strings describing the lineage of the app.
|
|
2060
|
+
*
|
|
1795
2061
|
* @param appId Identifier of the app.
|
|
1796
2062
|
* @throws GetAppDataLineageHttpError
|
|
1797
2063
|
*/
|
|
@@ -1799,12 +2065,14 @@ interface AppsAPI {
|
|
|
1799
2065
|
/**
|
|
1800
2066
|
* Retrieves the data model and reload statistics metadata of an app.
|
|
1801
2067
|
* An empty metadata structure is returned if the metadata is not available in the app.
|
|
2068
|
+
*
|
|
1802
2069
|
* @param appId Identifier of the app.
|
|
1803
2070
|
* @throws GetAppDataMetadataHttpError
|
|
1804
2071
|
*/
|
|
1805
2072
|
getAppDataMetadata: typeof getAppDataMetadata;
|
|
1806
2073
|
/**
|
|
1807
2074
|
* Exports a specific app.
|
|
2075
|
+
*
|
|
1808
2076
|
* @param appId Identifier of the app.
|
|
1809
2077
|
* @param query an object with query parameters
|
|
1810
2078
|
* @throws ExportAppHttpError
|
|
@@ -1812,12 +2080,14 @@ interface AppsAPI {
|
|
|
1812
2080
|
exportApp: typeof exportApp;
|
|
1813
2081
|
/**
|
|
1814
2082
|
* Returns information about supported analyses for the app's data model. Lists available analysis types, along with minimum and maximum number of dimensions, measures, and fields.
|
|
2083
|
+
*
|
|
1815
2084
|
* @param appId Qlik Sense app identifier
|
|
1816
2085
|
* @throws GetAppInsightAnalysesHttpError
|
|
1817
2086
|
*/
|
|
1818
2087
|
getAppInsightAnalyses: typeof getAppInsightAnalyses;
|
|
1819
2088
|
/**
|
|
1820
2089
|
* Returns analysis recommendations in response to a natural language question, a set of fields and master items, or a set of fields and master items with an optional target analysis.
|
|
2090
|
+
*
|
|
1821
2091
|
* @param appId Qlik Sense app identifier
|
|
1822
2092
|
* @param body an object with the body content
|
|
1823
2093
|
* @throws GetAppInsightAnalysisRecommendationsHttpError
|
|
@@ -1825,6 +2095,7 @@ interface AppsAPI {
|
|
|
1825
2095
|
getAppInsightAnalysisRecommendations: typeof getAppInsightAnalysisRecommendations;
|
|
1826
2096
|
/**
|
|
1827
2097
|
* Returns information about model used to make analysis recommendations. Lists all fields and master items in the logical model, along with an indication of the validity of the logical model if the default is not used.
|
|
2098
|
+
*
|
|
1828
2099
|
* @param appId Qlik Sense app identifier
|
|
1829
2100
|
* @throws GetAppInsightAnalysisModelHttpError
|
|
1830
2101
|
*/
|
|
@@ -1832,6 +2103,7 @@ interface AppsAPI {
|
|
|
1832
2103
|
/**
|
|
1833
2104
|
* Deletes a media content file or complete directory.
|
|
1834
2105
|
* Returns OK if the bytes containing the media file (or the complete content of a directory) were successfully deleted, or error in case of failure or lack of permission.
|
|
2106
|
+
*
|
|
1835
2107
|
* @param appId Unique application identifier.
|
|
1836
2108
|
* @param path Path to file content.
|
|
1837
2109
|
* @throws DeleteAppMediaHttpError
|
|
@@ -1840,6 +2112,7 @@ interface AppsAPI {
|
|
|
1840
2112
|
/**
|
|
1841
2113
|
* Gets media content from file.
|
|
1842
2114
|
* Returns a stream of bytes containing the media file content on success, or error if file is not found.
|
|
2115
|
+
*
|
|
1843
2116
|
* @param appId Unique application identifier.
|
|
1844
2117
|
* @param path Path to file content.
|
|
1845
2118
|
* @throws GetAppMediaHttpError
|
|
@@ -1848,6 +2121,7 @@ interface AppsAPI {
|
|
|
1848
2121
|
/**
|
|
1849
2122
|
* Stores the media content file.
|
|
1850
2123
|
* Returns OK if the bytes containing the media file content were successfully stored, or error in case of failure, lack of permission or file already exists on the supplied path.
|
|
2124
|
+
*
|
|
1851
2125
|
* @param appId Unique application identifier.
|
|
1852
2126
|
* @param path Path to file content.
|
|
1853
2127
|
* @param body an object with the body content
|
|
@@ -1857,6 +2131,7 @@ interface AppsAPI {
|
|
|
1857
2131
|
/**
|
|
1858
2132
|
* Lists media content.
|
|
1859
2133
|
* Returns a JSON formatted array of strings describing the available media content or error if the optional path supplied is not found.
|
|
2134
|
+
*
|
|
1860
2135
|
* @param appId Unique application identifier.
|
|
1861
2136
|
* @param path The path to sub folder with static content relative to the root folder. Use empty path to access the root folder.
|
|
1862
2137
|
* @param query an object with query parameters
|
|
@@ -1867,6 +2142,7 @@ interface AppsAPI {
|
|
|
1867
2142
|
* Gets media content from file currently used as application thumbnail.
|
|
1868
2143
|
* Returns a stream of bytes containing the media file content on success, or error if file is not found.
|
|
1869
2144
|
* The image selected as thumbnail is only updated when application is saved.
|
|
2145
|
+
*
|
|
1870
2146
|
* @param appId Unique application identifier.
|
|
1871
2147
|
* @throws GetAppThumbnailHttpError
|
|
1872
2148
|
*/
|
|
@@ -1874,6 +2150,7 @@ interface AppsAPI {
|
|
|
1874
2150
|
/**
|
|
1875
2151
|
* Sets owner on an app object.
|
|
1876
2152
|
* The user must be the owner of the object.
|
|
2153
|
+
*
|
|
1877
2154
|
* @param appId Identifier of the app.
|
|
1878
2155
|
* @param objectId Identifier of the object.
|
|
1879
2156
|
* @param body an object with the body content
|
|
@@ -1882,6 +2159,7 @@ interface AppsAPI {
|
|
|
1882
2159
|
updateAppObjectOwner: typeof updateAppObjectOwner;
|
|
1883
2160
|
/**
|
|
1884
2161
|
* Changes owner of the app.
|
|
2162
|
+
*
|
|
1885
2163
|
* @param appId Identifier of the app.
|
|
1886
2164
|
* @param body an object with the body content
|
|
1887
2165
|
* @throws UpdateAppOwnerHttpError
|
|
@@ -1889,6 +2167,7 @@ interface AppsAPI {
|
|
|
1889
2167
|
updateAppOwner: typeof updateAppOwner;
|
|
1890
2168
|
/**
|
|
1891
2169
|
* Publishes a specific app to a managed space.
|
|
2170
|
+
*
|
|
1892
2171
|
* @param appId Identifier of the app.
|
|
1893
2172
|
* @param body an object with the body content
|
|
1894
2173
|
* @throws PublishAppHttpError
|
|
@@ -1896,6 +2175,7 @@ interface AppsAPI {
|
|
|
1896
2175
|
publishApp: typeof publishApp;
|
|
1897
2176
|
/**
|
|
1898
2177
|
* Republishes a published app to a managed space.
|
|
2178
|
+
*
|
|
1899
2179
|
* @param appId Identifier of the app.
|
|
1900
2180
|
* @param body an object with the body content
|
|
1901
2181
|
* @throws RepublishAppHttpError
|
|
@@ -1904,6 +2184,7 @@ interface AppsAPI {
|
|
|
1904
2184
|
/**
|
|
1905
2185
|
* Retrieves the metadata about all script logs stored for an app.
|
|
1906
2186
|
* Returns an array of ScriptLogMeta objects.
|
|
2187
|
+
*
|
|
1907
2188
|
* @param appId Identifier of the app.
|
|
1908
2189
|
* @throws GetAppReloadLogsHttpError
|
|
1909
2190
|
*/
|
|
@@ -1911,6 +2192,7 @@ interface AppsAPI {
|
|
|
1911
2192
|
/**
|
|
1912
2193
|
* Retrieves the log of a specific reload.
|
|
1913
2194
|
* Returns the log as "text/plain; charset=UTF-8".
|
|
2195
|
+
*
|
|
1914
2196
|
* @param appId Identifier of the app.
|
|
1915
2197
|
* @param reloadId Identifier of the reload.
|
|
1916
2198
|
* @throws GetAppReloadLogHttpError
|
|
@@ -1919,15 +2201,57 @@ interface AppsAPI {
|
|
|
1919
2201
|
/**
|
|
1920
2202
|
* Retrieves the app reload metadata list.
|
|
1921
2203
|
* Reload metadata contains reload information, including reload id, duration, endtime and lineage load info.
|
|
2204
|
+
*
|
|
1922
2205
|
* @param appId Identifier of the app
|
|
1923
2206
|
* @param reloadId Identifier of the reload. Use empty reloadId to get all reloads.
|
|
1924
2207
|
* @param query an object with query parameters
|
|
1925
2208
|
* @throws GetAppReloadMetadataHttpError
|
|
1926
2209
|
*/
|
|
1927
2210
|
getAppReloadMetadata: typeof getAppReloadMetadata;
|
|
2211
|
+
/**
|
|
2212
|
+
* List all filters that are present in the given app. Filters allow to reduce the app data visible in a report output. Each filter can contain definitions on one or multiple fields.
|
|
2213
|
+
*
|
|
2214
|
+
* @param appId Qlik Sense app identifier
|
|
2215
|
+
* @param query an object with query parameters
|
|
2216
|
+
* @throws GetAppReportFiltersHttpError
|
|
2217
|
+
*/
|
|
2218
|
+
getAppReportFilters: typeof getAppReportFilters;
|
|
2219
|
+
/**
|
|
2220
|
+
* Creates a new report filter which is used to re-apply selections, variables, patches to an engine session.
|
|
2221
|
+
*
|
|
2222
|
+
* @param appId Qlik Sense app identifier
|
|
2223
|
+
* @param body an object with the body content
|
|
2224
|
+
* @throws CreateAppReportFilterHttpError
|
|
2225
|
+
*/
|
|
2226
|
+
createAppReportFilter: typeof createAppReportFilter;
|
|
2227
|
+
/**
|
|
2228
|
+
* Get the number of filters for the given app and filter types
|
|
2229
|
+
*
|
|
2230
|
+
* @param appId Qlik Sense app identifier
|
|
2231
|
+
* @param query an object with query parameters
|
|
2232
|
+
* @throws CountAppReportFiltersHttpError
|
|
2233
|
+
*/
|
|
2234
|
+
countAppReportFilters: typeof countAppReportFilters;
|
|
2235
|
+
/**
|
|
2236
|
+
* Delete a filter
|
|
2237
|
+
*
|
|
2238
|
+
* @param appId Qlik Sense app identifier
|
|
2239
|
+
* @param id The filter id identifier (bookmarkId).
|
|
2240
|
+
* @throws DeleteAppReportFilterHttpError
|
|
2241
|
+
*/
|
|
2242
|
+
deleteAppReportFilter: typeof deleteAppReportFilter;
|
|
2243
|
+
/**
|
|
2244
|
+
* Get a filter
|
|
2245
|
+
*
|
|
2246
|
+
* @param appId Qlik Sense app identifier
|
|
2247
|
+
* @param id The filter id identifier (bookmarkId).
|
|
2248
|
+
* @throws GetAppReportFilterHttpError
|
|
2249
|
+
*/
|
|
2250
|
+
getAppReportFilter: typeof getAppReportFilter;
|
|
1928
2251
|
/**
|
|
1929
2252
|
* Retrieves the script history for an app.
|
|
1930
2253
|
* Returns information about the saved versions of the script.
|
|
2254
|
+
*
|
|
1931
2255
|
* @param appId Identifier of the app.
|
|
1932
2256
|
* @param query an object with query parameters
|
|
1933
2257
|
* @throws GetAppScriptHistoryHttpError
|
|
@@ -1935,6 +2259,7 @@ interface AppsAPI {
|
|
|
1935
2259
|
getAppScriptHistory: typeof getAppScriptHistory;
|
|
1936
2260
|
/**
|
|
1937
2261
|
* Sets script for an app.
|
|
2262
|
+
*
|
|
1938
2263
|
* @param appId Identifier of the app.
|
|
1939
2264
|
* @param body an object with the body content
|
|
1940
2265
|
* @throws UpdateAppScriptHttpError
|
|
@@ -1943,6 +2268,7 @@ interface AppsAPI {
|
|
|
1943
2268
|
/**
|
|
1944
2269
|
* Deletes a specific version of the script for an app.
|
|
1945
2270
|
* Fails if the version to delete is the current version.
|
|
2271
|
+
*
|
|
1946
2272
|
* @param appId Identifier of the app.
|
|
1947
2273
|
* @param version Identifier of the script version
|
|
1948
2274
|
* @throws DeleteAppScriptHttpError
|
|
@@ -1951,6 +2277,7 @@ interface AppsAPI {
|
|
|
1951
2277
|
/**
|
|
1952
2278
|
* Retrieves a version of the script for an app.
|
|
1953
2279
|
* Returns the script text.
|
|
2280
|
+
*
|
|
1954
2281
|
* @param appId Identifier of the app.
|
|
1955
2282
|
* @param version Identifier of the script version, or 'current' for retrieving the current version.
|
|
1956
2283
|
* @throws GetAppScriptHttpError
|
|
@@ -1958,6 +2285,7 @@ interface AppsAPI {
|
|
|
1958
2285
|
getAppScript: typeof getAppScript;
|
|
1959
2286
|
/**
|
|
1960
2287
|
* Updates a specific version of the script for an app.
|
|
2288
|
+
*
|
|
1961
2289
|
* @param appId Identifier of the app.
|
|
1962
2290
|
* @param version Identifier of the script version.
|
|
1963
2291
|
* @param body an object with the body content
|
|
@@ -1966,12 +2294,14 @@ interface AppsAPI {
|
|
|
1966
2294
|
patchAppScript: typeof patchAppScript;
|
|
1967
2295
|
/**
|
|
1968
2296
|
* Removes space from a specific app.
|
|
2297
|
+
*
|
|
1969
2298
|
* @param appId Identifier of the app.
|
|
1970
2299
|
* @throws RemoveAppFromSpaceHttpError
|
|
1971
2300
|
*/
|
|
1972
2301
|
removeAppFromSpace: typeof removeAppFromSpace;
|
|
1973
2302
|
/**
|
|
1974
2303
|
* Sets space on a specific app.
|
|
2304
|
+
*
|
|
1975
2305
|
* @param appId Identifier of the app.
|
|
1976
2306
|
* @param body an object with the body content
|
|
1977
2307
|
* @throws MoveAppToSpaceHttpError
|
|
@@ -2003,4 +2333,4 @@ interface AppsAPI {
|
|
|
2003
2333
|
*/
|
|
2004
2334
|
declare const appsExport: AppsAPI;
|
|
2005
2335
|
|
|
2006
|
-
export { type Analysis, type AnalysisComposition, type AnalysisDescriptor, type AnalysisDescriptorResponse, type AnalysisDetails, type AnalysisGroup, type AnalysisModelItemField, type AnalysisModelItemMasterItem, type AnalysisModelResponse, type AnalysisModelResponseDetail, type AnalysisRecommendRequest, type AnalysisRecommendationResponse, type AnalysisRecommendationResponseDetail, type AppAttributes, type AppContentList, type AppContentListItem, type AppUpdateAttributes, type AppsAPI, type ChartType, type Classification, type Classifications, type Cmpbool, type Cmpfloat, type Cmpint, type Comparison, type Comparisonfields, type Comparisonobjresponsetime, type Comparisonoobjheavy, type Comparisontables, type CompositionMinMax, type CopyAppHttpError, type CopyAppHttpResponse, type CreateApp, type CreateAppHttpError, type CreateAppHttpResponse, type DataModelMetadata, type DeleteAppHttpError, type DeleteAppHttpResponse, type DeleteAppMediaHttpError, type DeleteAppMediaHttpResponse, type DeleteAppScriptHttpError, type DeleteAppScriptHttpResponse, type Error, type Errors, type Evaluation, type Evaluations, type EvaluatorError, type Event, type ExportAppHttpError, type ExportAppHttpResponse, type FieldAttributes, type FieldInTableProfilingData, type FieldMetadata, type FieldOverride, type FileData, type FrequencyDistributionData, type GetAppDataLineageHttpError, type GetAppDataLineageHttpResponse, type GetAppDataMetadataHttpError, type GetAppDataMetadataHttpResponse, type GetAppEvaluationComparisonHttpError, type GetAppEvaluationComparisonHttpResponse, type GetAppEvaluationComparisonXmlHttpError, type GetAppEvaluationComparisonXmlHttpResponse, type GetAppEvaluationHttpError, type GetAppEvaluationHttpResponse, type GetAppEvaluationXmlHttpError, type GetAppEvaluationXmlHttpResponse, type GetAppEvaluationsHttpError, type GetAppEvaluationsHttpResponse, type GetAppInfoHttpError, type GetAppInfoHttpResponse, type GetAppInsightAnalysesHttpError, type GetAppInsightAnalysesHttpResponse, type GetAppInsightAnalysisModelHttpError, type GetAppInsightAnalysisModelHttpResponse, type GetAppInsightAnalysisRecommendationsHttpError, type GetAppInsightAnalysisRecommendationsHttpResponse, type GetAppMediaHttpError, type GetAppMediaHttpResponse, type GetAppMediaListHttpError, type GetAppMediaListHttpResponse, type GetAppReloadLogHttpError, type GetAppReloadLogHttpResponse, type GetAppReloadLogsHttpError, type GetAppReloadLogsHttpResponse, type GetAppReloadMetadataHttpError, type GetAppReloadMetadataHttpResponse, type GetAppScriptHistoryHttpError, type GetAppScriptHistoryHttpResponse, type GetAppScriptHttpError, type GetAppScriptHttpResponse, type GetAppThumbnailHttpError, type GetAppThumbnailHttpResponse, type GetAppsPrivilegesHttpError, type GetAppsPrivilegesHttpResponse, type HardwareMeta, type Href, type ImportAppHttpError, type ImportAppHttpResponse, type JsonObject, type LastReloadMetadata, type LineageInfoRest, type Links, type Log, type Metadata, type MoveAppToSpaceHttpError, type MoveAppToSpaceHttpResponse, type NavigationLink, type NavigationLinks, type NumberFormat, type NxApp, type NxAppCreatePrivileges, type NxAppObject, type NxAttributes, type NxObjectAttributes, type NxPatch, type Objectmetrics, type Objectspec, type Objecttopspec, type PartialNluInfo, type PatchAppScriptHttpError, type PatchAppScriptHttpResponse, type PublishApp, type PublishAppHttpError, type PublishAppHttpResponse, type QueueAppEvaluationHttpError, type QueueAppEvaluationHttpResponse, type RecommendFieldItem, type RecommendItems, type RecommendMasterItem, type RecommendNaturalLangQuery, type RecommendedAnalysis, type RecommendedAnalysisCore, type ReloadListMetadata, type ReloadMeta, type ReloadStatements, type RemoveAppFromSpaceHttpError, type RemoveAppFromSpaceHttpResponse, type RepublishApp, type RepublishAppHttpError, type RepublishAppHttpResponse, type Result, type Resultentry, type Resultmetadatatopfields, type Resultmetadatatoptables, type Resultobjresponsetime, type Resultobjsheet, type Resultobjsinglethreaded, type Resultsingle, type ScriptLogList, type ScriptLogMeta, type ScriptMeta, type ScriptMetaList, type ScriptVersion, type SimplifiedClassifications, type Sortedcomparisonfields, type Sortedcomparisonobjresponsetime, type Sortedcomparisonoobjheavy, type Sortedcomparisontables, type SymbolFrequency, type SymbolValue, type TableMetadata, type TableProfilingData, type UpdateApp, type UpdateAppInfoHttpError, type UpdateAppInfoHttpResponse, type UpdateAppObjectOwnerHttpError, type UpdateAppObjectOwnerHttpResponse, type UpdateAppOwnerHttpError, type UpdateAppOwnerHttpResponse, type UpdateAppScriptHttpError, type UpdateAppScriptHttpResponse, type UpdateOwner, type UpdateSpace, type UploadAppMediaHttpError, type UploadAppMediaHttpResponse, clearCache, copyApp, createApp, appsExport as default, deleteApp, deleteAppMedia, deleteAppScript, exportApp, getAppDataLineage, getAppDataMetadata, getAppEvaluation, getAppEvaluationComparison, getAppEvaluationComparisonXml, getAppEvaluationXml, getAppEvaluations, getAppInfo, getAppInsightAnalyses, getAppInsightAnalysisModel, getAppInsightAnalysisRecommendations, getAppMedia, getAppMediaList, getAppReloadLog, getAppReloadLogs, getAppReloadMetadata, getAppScript, getAppScriptHistory, getAppThumbnail, getAppsPrivileges, importApp, moveAppToSpace, patchAppScript, publishApp, queueAppEvaluation, removeAppFromSpace, republishApp, updateAppInfo, updateAppObjectOwner, updateAppOwner, updateAppScript, uploadAppMedia };
|
|
2336
|
+
export { type Analysis, type AnalysisComposition, type AnalysisDescriptor, type AnalysisDescriptorResponse, type AnalysisDetails, type AnalysisGroup, type AnalysisModelItemField, type AnalysisModelItemMasterItem, type AnalysisModelResponse, type AnalysisModelResponseDetail, type AnalysisRecommendRequest, type AnalysisRecommendationResponse, type AnalysisRecommendationResponseDetail, type AppAttributes, type AppContentList, type AppContentListItem, type AppUpdateAttributes, type AppsAPI, type ChartType, type Classification, type Classifications, type Cmpbool, type Cmpfloat, type Cmpint, type Comparison, type Comparisonfields, type Comparisonobjresponsetime, type Comparisonoobjheavy, type Comparisontables, type CompositionMinMax, type CopyAppHttpError, type CopyAppHttpResponse, type CountAppReportFiltersHttpError, type CountAppReportFiltersHttpResponse, type CreateApp, type CreateAppHttpError, type CreateAppHttpResponse, type CreateAppReportFilterHttpError, type CreateAppReportFilterHttpResponse, type DataModelMetadata, type DeleteAppHttpError, type DeleteAppHttpResponse, type DeleteAppMediaHttpError, type DeleteAppMediaHttpResponse, type DeleteAppReportFilterHttpError, type DeleteAppReportFilterHttpResponse, type DeleteAppScriptHttpError, type DeleteAppScriptHttpResponse, type Error, type Errors, type Evaluation, type Evaluations, type EvaluatorError, type Event, type ExportAppHttpError, type ExportAppHttpResponse, type FieldAttributes, type FieldInTableProfilingData, type FieldMetadata, type FieldOverride, type FileData, type Filter, type FilterError, type FilterErrors, type FilterField, type FilterFieldValue, type FilterList, type FilterListItem, type FilterRequest, type FilterType, type FilterV10, type FilterVariable, type FiltersCount, type Float64, type FrequencyDistributionData, type GetAppDataLineageHttpError, type GetAppDataLineageHttpResponse, type GetAppDataMetadataHttpError, type GetAppDataMetadataHttpResponse, type GetAppEvaluationComparisonHttpError, type GetAppEvaluationComparisonHttpResponse, type GetAppEvaluationComparisonXmlHttpError, type GetAppEvaluationComparisonXmlHttpResponse, type GetAppEvaluationHttpError, type GetAppEvaluationHttpResponse, type GetAppEvaluationXmlHttpError, type GetAppEvaluationXmlHttpResponse, type GetAppEvaluationsHttpError, type GetAppEvaluationsHttpResponse, type GetAppInfoHttpError, type GetAppInfoHttpResponse, type GetAppInsightAnalysesHttpError, type GetAppInsightAnalysesHttpResponse, type GetAppInsightAnalysisModelHttpError, type GetAppInsightAnalysisModelHttpResponse, type GetAppInsightAnalysisRecommendationsHttpError, type GetAppInsightAnalysisRecommendationsHttpResponse, type GetAppMediaHttpError, type GetAppMediaHttpResponse, type GetAppMediaListHttpError, type GetAppMediaListHttpResponse, type GetAppReloadLogHttpError, type GetAppReloadLogHttpResponse, type GetAppReloadLogsHttpError, type GetAppReloadLogsHttpResponse, type GetAppReloadMetadataHttpError, type GetAppReloadMetadataHttpResponse, type GetAppReportFilterHttpError, type GetAppReportFilterHttpResponse, type GetAppReportFiltersHttpError, type GetAppReportFiltersHttpResponse, type GetAppScriptHistoryHttpError, type GetAppScriptHistoryHttpResponse, type GetAppScriptHttpError, type GetAppScriptHttpResponse, type GetAppThumbnailHttpError, type GetAppThumbnailHttpResponse, type GetAppsPrivilegesHttpError, type GetAppsPrivilegesHttpResponse, type HardwareMeta, type Href, type ImportAppHttpError, type ImportAppHttpResponse, type JsonObject, type LastReloadMetadata, type LineageInfoRest, type LinkResponse, type Links, type LinksResponse, type Log, type Metadata, type MoveAppToSpaceHttpError, type MoveAppToSpaceHttpResponse, type NavigationLink, type NavigationLinks, type NumberFormat, type NxApp, type NxAppCreatePrivileges, type NxAppObject, type NxAttributes, type NxObjectAttributes, type NxPatch, type Objectmetrics, type Objectspec, type Objecttopspec, type PartialNluInfo, type PatchAppScriptHttpError, type PatchAppScriptHttpResponse, type PublishApp, type PublishAppHttpError, type PublishAppHttpResponse, type QueueAppEvaluationHttpError, type QueueAppEvaluationHttpResponse, type RecommendFieldItem, type RecommendItems, type RecommendMasterItem, type RecommendNaturalLangQuery, type RecommendedAnalysis, type RecommendedAnalysisCore, type ReloadListMetadata, type ReloadMeta, type ReloadStatements, type RemoveAppFromSpaceHttpError, type RemoveAppFromSpaceHttpResponse, type RepublishApp, type RepublishAppHttpError, type RepublishAppHttpResponse, type Result, type Resultentry, type Resultmetadatatopfields, type Resultmetadatatoptables, type Resultobjresponsetime, type Resultobjsheet, type Resultobjsinglethreaded, type Resultsingle, type ScriptLogList, type ScriptLogMeta, type ScriptMeta, type ScriptMetaList, type ScriptVersion, type SimplifiedClassifications, type Sortedcomparisonfields, type Sortedcomparisonobjresponsetime, type Sortedcomparisonoobjheavy, type Sortedcomparisontables, type SymbolFrequency, type SymbolValue, type TableMetadata, type TableProfilingData, type UpdateApp, type UpdateAppInfoHttpError, type UpdateAppInfoHttpResponse, type UpdateAppObjectOwnerHttpError, type UpdateAppObjectOwnerHttpResponse, type UpdateAppOwnerHttpError, type UpdateAppOwnerHttpResponse, type UpdateAppScriptHttpError, type UpdateAppScriptHttpResponse, type UpdateOwner, type UpdateSpace, type UploadAppMediaHttpError, type UploadAppMediaHttpResponse, clearCache, copyApp, countAppReportFilters, createApp, createAppReportFilter, appsExport as default, deleteApp, deleteAppMedia, deleteAppReportFilter, deleteAppScript, exportApp, getAppDataLineage, getAppDataMetadata, getAppEvaluation, getAppEvaluationComparison, getAppEvaluationComparisonXml, getAppEvaluationXml, getAppEvaluations, getAppInfo, getAppInsightAnalyses, getAppInsightAnalysisModel, getAppInsightAnalysisRecommendations, getAppMedia, getAppMediaList, getAppReloadLog, getAppReloadLogs, getAppReloadMetadata, getAppReportFilter, getAppReportFilters, getAppScript, getAppScriptHistory, getAppThumbnail, getAppsPrivileges, importApp, moveAppToSpace, patchAppScript, publishApp, queueAppEvaluation, removeAppFromSpace, republishApp, updateAppInfo, updateAppObjectOwner, updateAppOwner, updateAppScript, uploadAppMedia };
|