Skip to content
This repository has been archived by the owner on Apr 30, 2024. It is now read-only.

Commit

Permalink
Automated: Bump QIX Engine API docs (#549)
Browse files Browse the repository at this point in the history
  • Loading branch information
qlikossbuild authored and wennmo committed Nov 25, 2019
1 parent 3b9126a commit 81d8f9d
Show file tree
Hide file tree
Showing 15 changed files with 71 additions and 17 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<!-- proselint-disable -->
# gRPC Data Connector API

_gRPC Data Connector API for version 12.477.0._
_gRPC Data Connector API for version 12.515.0._

Package: **qlik.connect**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<!-- proselint-disable -->
# gRPC File Connector API

_gRPC File Connector API for version 12.477.0._
_gRPC File Connector API for version 12.515.0._

Package: **qlik.filehosting**

Expand Down
38 changes: 36 additions & 2 deletions docs/services/qix-engine/apis/qix/definitions.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<!-- proselint-disable -->
# Definitions

_QIX definitions for version 12.477.0._
_QIX definitions for version 12.515.0._

## `AlfaNumString`

Expand Down Expand Up @@ -102,7 +102,7 @@ _No description._
| `qFieldFlag` | boolean | N/A | If set to true, the definition is related to a field.<br>This parameter is optional. The default value is false. |
| `qMT` | string | N/A | Type of the data.<br><br>One of:<br>- N or NOT_META<br>- D or META_DOC_NAME<br>- R or META_RET_TYPE<br>- V or META_DEFAULT_VALUE |
| `qDepr` | boolean | N/A | Indicates whether a script statement, a chart or a script function is deprecated (not recommended for use).<br>If set to true, the script statement or the function is not recommended for use in Qlik Sense.<br>This parameter is optional. The default value is false. |
| `qFGList` | undefined | N/A | List of groups the function belongs to. |
| `qFGList` | array&lt;undefined> | N/A | List of groups the function belongs to. |

## `BookmarkFieldItem`

Expand Down Expand Up @@ -951,6 +951,7 @@ In addition, this structure can return dynamic properties.
| `qHasData` | boolean | N/A | Is set to true if the app contains data following a script reload. |
| `qReadOnly` | boolean | N/A | If set to true, it means that the app is read-only. |
| `qIsOpenedWithoutData` | boolean | N/A | If set to true, it means that the app was opened without loading its data. |
| `qIsSessionApp` | boolean | N/A | If set to true, the app is a Session App, i.e. not persistent. |
| `qThumbnail` | [`StaticContentUrl`](#staticcontenturl) | N/A | App thumbnail. |

## `NxAppProperties`
Expand Down Expand Up @@ -1518,6 +1519,7 @@ Either **qDef** or **qLibraryId** must be set, but not both. If the measure is s
| `qAttributeDimensions` | array&lt;[`NxAttrDimDef`](#nxattrdimdef)> | N/A | List of attribute dimensions. |
| `qCalcCond` | [`ValueExpr`](#valueexpr) | N/A | Specifies a calculation condition, which must be fulfilled for the measure to be calculated.<br>If the calculation condition is not met, the measure is excluded from the calculation.<br>By default, there is no calculation condition.<br>This property is optional. |
| `qCalcCondition` | [`NxCalcCond`](#nxcalccond) | N/A | Specifies a calculation condition object.<br>If CalcCondition.Cond is not fulfilled, the measure is excluded from the calculation and CalcCondition.Msg is evaluated.<br>By default, there is no calculation condition.<br>This property is optional. |
| `qTrendLines` | array&lt;[`NxTrendlineDef`](#nxtrendlinedef)> | N/A | Specifies trendlines for this measure. |

## `NxMeasureInfo`

Expand All @@ -1539,6 +1541,7 @@ Layout for [`NxInlineMeasureDef`](#nxinlinemeasuredef).
| `qAttrDimInfo` | array&lt;[`NxAttrDimInfo`](#nxattrdiminfo)> | N/A | List of attribute dimensions. |
| `qCalcCondMsg` | string | N/A | The message displayed if calculation condition is not fulfilled. |
| `qLibraryId` | string | N/A | Refers to a dimension stored in the library. |
| `qTrendLines` | array&lt;[`NxTrendline`](#nxtrendline)> | N/A | Calculated trendlines |

## `NxMeta`

Expand Down Expand Up @@ -1897,6 +1900,37 @@ Represents a measure.
| `qAttrExps` | [`NxAttributeExpressionValues`](#nxattributeexpressionvalues) | N/A | Attribute expression values. |
| `qAttrDims` | [`NxAttributeDimValues`](#nxattributedimvalues) | N/A | Attribute dimension values. |

## `NxTrendline`

**Stability Index: Stable**

Information about the calculated trendline.

| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| `qType` | string | N/A | Type of trendline<br><br>One of:<br>- AVERAGE or Average<br>- LINEAR or Linear<br>- POLYNOMIAL or Polynomial<br>- EXPONENTIAL or Exponential<br>- POWER or Power<br>- LOG or Logarithmic |
| `qSolvedDegree` | integer | N/A | Degree that was solved. |
| `qError` | [`NxValidationError`](#nxvalidationerror) | N/A | This parameter is optional and is displayed in case of error. |
| `qCoeff` | array&lt;number> | N/A | Coefficent c0..cN depending on the trendline type. |
| `qR2` | number | N/A | R2 score. Value between 0..1 that shows the correlation between the trendline and the data. Higher value means higher correlation. |
| `qExpression` | string | N/A | Trendline expression |
| `qElemNo` | integer | N/A | Inner Dim elem no |

## `NxTrendlineDef`

**Stability Index: Stable**

Trendline input definition

| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| `qType` | string | N/A | The type of trendline to calculate<br><br>One of:<br>- AVERAGE or Average<br>- LINEAR or Linear<br>- POLYNOMIAL or Polynomial<br>- EXPONENTIAL or Exponential<br>- POWER or Power<br>- LOG or Logarithmic |
| `qPolynomialDegree` | integer | N/A | For a polynomial type the degree can be between 2..4 |
| `qXColIx` | integer | -1 | The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure |
| `qCalcR2` | boolean | N/A | Set to true to calulatate the R2 score |
| `qContinuousXAxis` | string | CONTINUOUS_NEVER | Set if the numerical value of x axis dimension should be used<br><br>One of:<br>- Never or CONTINUOUS_NEVER<br>- Possible or CONTINUOUS_IF_POSSIBLE |
| `qMultiDimMode` | string | TRENDLINE_MULTILINE | If you have a hypercube with two dimensions and qXColIx refers to a dimension<br>This determines if you get one trendline of each value in the other dimension or<br>Or trendline based on the sum of the value in the other dimension<br>The sum variant is only supported when qXColIx is 0 and qMode (on the hypercube) is K or T<br><br>One of:<br>- Multi or TRENDLINE_MULTILINE<br>- Sum or TRENDLINE_SUM |

## `NxValidationError`

_No description._
Expand Down
2 changes: 1 addition & 1 deletion docs/services/qix-engine/apis/qix/doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<!-- proselint-disable -->
# Doc

_QIX methods for version 12.477.0._
_QIX methods for version 12.515.0._

## `AbortModal`

Expand Down
2 changes: 1 addition & 1 deletion docs/services/qix-engine/apis/qix/field.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<!-- proselint-disable -->
# Field

_QIX methods for version 12.477.0._
_QIX methods for version 12.515.0._

## `Clear`

Expand Down
2 changes: 1 addition & 1 deletion docs/services/qix-engine/apis/qix/genericbookmark.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<!-- proselint-disable -->
# GenericBookmark

_QIX methods for version 12.477.0._
_QIX methods for version 12.515.0._

## `Apply`

Expand Down
2 changes: 1 addition & 1 deletion docs/services/qix-engine/apis/qix/genericdimension.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<!-- proselint-disable -->
# GenericDimension

_QIX methods for version 12.477.0._
_QIX methods for version 12.515.0._

## `ApplyPatches`

Expand Down
2 changes: 1 addition & 1 deletion docs/services/qix-engine/apis/qix/genericmeasure.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<!-- proselint-disable -->
# GenericMeasure

_QIX methods for version 12.477.0._
_QIX methods for version 12.515.0._

## `ApplyPatches`

Expand Down
2 changes: 1 addition & 1 deletion docs/services/qix-engine/apis/qix/genericobject.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<!-- proselint-disable -->
# GenericObject

_QIX methods for version 12.477.0._
_QIX methods for version 12.515.0._

## `AbortListObjectSearch`

Expand Down
2 changes: 1 addition & 1 deletion docs/services/qix-engine/apis/qix/genericvariable.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<!-- proselint-disable -->
# GenericVariable

_QIX methods for version 12.477.0._
_QIX methods for version 12.515.0._

## `ApplyPatches`

Expand Down
20 changes: 19 additions & 1 deletion docs/services/qix-engine/apis/qix/global.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<!-- proselint-disable -->
# Global

_QIX methods for version 12.477.0._
_QIX methods for version 12.515.0._

## `AbortAll`

Expand Down Expand Up @@ -745,6 +745,24 @@ Required permissions: [`update`](https://core.qlik.com/services/qix-engine/acces
| ---- | ---- | ----------- |
| `qSuccess` | boolean | &lt;true or false&gt; |

## `SaveAs`

Save a copy of an app with a different name.<br>Can be used to save a session app as an ordinary app.

Required permissions: [`create`](https://core.qlik.com/services/qix-engine/access-control/#actions)

**Parameters:**

| Name | Type | Mandatory | Description |
| ---- | ---- | --------- | ----------- |
| `qNewAppName` | string | Yes | &lt;Name of the saved app&gt; |

**Returns:**

| Name | Type | Description |
| ---- | ---- | ----------- |
| `qNewAppId` | string | &lt;Identifier of the saved app&gt; |

## `ShutdownProcess`

Shuts down the Qlik engine.<br>This operation is possible only in Qlik Sense Desktop.
Expand Down
2 changes: 1 addition & 1 deletion docs/services/qix-engine/apis/qix/variable.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<!-- proselint-disable -->
# Variable

_QIX methods for version 12.477.0._
_QIX methods for version 12.515.0._

## `ForceContent`

Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<!-- proselint-disable -->
# Qlik Associative Engine API

_Qlik Associative Engine API for version 12.477.0._
_Qlik Associative Engine API for version 12.515.0._

[Qlik Associative Engine API specification](./qlik-associative-engine-api.json)

Expand Down Expand Up @@ -115,11 +115,12 @@ Required permissions: [`import`](https://core.qlik.com/services/qix-engine/acces

| Parameter | In | Type | Mandatory | Description |
| --------- | -- | ---- | --------- | ----------- |
| `filedata` | body | [FileData](#filedata) | true | Path of the source app. |
| `filedata` | body | [FileData](#filedata) | false | Path of the source app. |
| `name` | query | string | false | The name of the target app. |
| `spaceId` | query | string | false | The space id of the target app. |
| `mode` | query | string | false | The import mode. In `new` mode (default), the source app will be imported as a new app with generated attributes. In `autoreplace` mode, the attributes from the source app will be retained and imported with the app. The app-id is extracted from the source app and used as the target app-id. If the app exists, it will be replaced. Approved objects in the target app that are not available in the source app will be removed. Non-approved objects in the target app will not be removed. One of:<br/>&bull; NEW<br/>&bull; AUTOREPLACE |
| `appId` | query | string | false | The app id of the target app when source is qvw file. |
| `fileId` | query | string | false | The file id to be downloaded from TCS and used during import. |
| `fallbackName` | query | string | false | The name of the target app when source not has a specified name, applicable if source is qvw file. |

**Responses**
Expand Down Expand Up @@ -833,6 +834,7 @@ _Type: object_
| ---- | ---- | ----------- |
| `cpu_time_spent_ms` | integer | Number of CPU milliseconds it took to reload the app. |
| `hardware` | [HardwareMeta](#hardwaremeta) | Hardware available for the engine doing the reload. |
| `peak_memory_bytes` | integer | Max number of bytes used during reload of the app. |

### `HardwareMeta`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<!-- proselint-disable -->
# gRPC Analytical Connector API

_gRPC Analytical Connector API for version 12.477.0._
_gRPC Analytical Connector API for version 12.515.0._

Package: **qlik.sse**

Expand Down

0 comments on commit 81d8f9d

Please sign in to comment.