Qlik Sense Engine (qix)

The JSON-RPC API over WebSocket API that enables you to interact with the Qlik Associative Engine for Qlik Sense applications.

Download specification

GenericDimension

GenericDimension ApplyPatches

(qPatches)

Applies a patch to the properties of an object. Allows an update to some of the properties. It should not be possible to patch "/qInfo/qId", and it will be forbidden in the near future.

Applying a patch takes less time than resetting all the properties.

Parameters

  • qPatchesarray of objects
    Required

    Array of patches.

    Show qPatches properties
    • qOpstring

      Can be one of: "add""remove""replace"

    • qPathstring

      Path to the property to add, remove or replace.

    • qValuestring

      This parameter is not used in a remove operation. Corresponds to the value of the property to add or to the new value of the property to update. Examples: "false", "2", ""New title""

Response

object

Errors

array
GenericErrors

ApplyPatches(qPatches)

const result = await genericDimension.ApplyPatches([
  [
    {
      "qOp": "add",
      "qPath": "value",
      "qValue": "value"
    }
  ]
])

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "ApplyPatches",
  "params": {
    "qPatches": [
      {
        "qOp": "add",
        "qPath": "value",
        "qValue": "value"
      }
    ]
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericDimension Approve

()

Adds the generic dimension to the list of approved objects

This operation is possible only in Qlik Sense Enterprise.

Response

object

Errors

array
GenericErrors

Approve()

const result = await genericDimension.Approve({})

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "Approve"
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericDimension GetActiveField

()
Experimental

Get a cyclic dimension's active field.

This operation is only possible for cyclic dimensions.

Response

  • qReturninteger

Errors

array
GenericErrors

GetActiveField()

const result = await genericDimension.GetActiveField({})

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "GetActiveField"
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qReturn": 123
  }
}

GenericDimension GetDimension

()

Returns the definition of a dimension.

The definition of the dimension is returned.

Response

  • qDimobject
    Show qDim properties
    • qGroupingstring

      Can be one of: "N""H""C"

    • qFieldDefsarray of strings

      Array of dimension names.

    • qFieldLabelsarray of strings

      Array of dimension labels.

    • qLabelExpressionstring
    • qAliasstring

      Alias of the dimension.

Errors

array
GenericErrors

GetDimension()

const result = await genericDimension.GetDimension({})

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "GetDimension"
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qDim": {
      "qGrouping": "N",
      "qFieldDefs": [
        "value"
      ],
      "qFieldLabels": [
        "value"
      ],
      "qLabelExpression": "value",
      "qAlias": "value"
    }
  }
}

GenericDimension GetInfo

()

Returns the type and identifier of the object.

Response

  • qInfoobject
    Show qInfo properties
    • qIdstring

      Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

    • qTypestring

      Type of the object. This parameter is mandatory.

Errors

array
GenericErrors

GetInfo()

const result = await genericDimension.GetInfo({})

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "GetInfo"
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qInfo": {
      "qId": "value",
      "qType": "value"
    }
  }
}

GenericDimension GetLayout

()

Evaluates a dimension and displays its properties, including the dynamic properties.

Response

  • qLayoutobject

    Is the layout for GenericDimensionProperties.

    Show qLayout properties
    • qInfoobject
      Show qInfo properties
      • qIdstring

        Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

      • qTypestring

        Type of the object. This parameter is mandatory.
    • qMetaobject

      Layout for NxMetaDef.

      Show qMeta properties
      • qNamestring

        Name. This property is optional.
    • qDimobject
      Show qDim properties
      • qGroupingstring

        Can be one of: "N""H""C"

      • qFieldDefsarray of strings

        Array of dimension names.

      • qFieldLabelsarray of strings

        Array of dimension labels.

      • qLabelExpressionstring
      • qAliasstring

        Alias of the dimension.
    • qDimInfosarray of objects

      Cardinal and tags related to the dimension. Length of the longest value in the field.

      Show qDimInfos properties
      • qApprMaxGlyphCountinteger

        Length of the longest value in the field.

        format = int32

      • qCardinalinteger

        Number of distinct field values

        format = int32

      • qTagsarray of strings

        Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII

      • qIsSemanticboolean

        If set to true, it means that the field is a semantic.

      • qAndModeboolean

        If set to true a logical AND (instead of a logical OR) is used when making selections in a field. The default value is false.

Errors

array
GenericErrors

GetLayout()

const result = await genericDimension.GetLayout({})

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "GetLayout"
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qLayout": {
      "qInfo": {
        "qId": "value",
        "qType": "value"
      },
      "qMeta": {
        "qName": "value"
      },
      "qDim": {
        "qGrouping": "N",
        "qFieldDefs": [
          "value"
        ],
        "qFieldLabels": [
          "value"
        ],
        "qLabelExpression": "value",
        "qAlias": "value"
      },
      "qDimInfos": [
        {
          "qApprMaxGlyphCount": 123,
          "qCardinal": 123,
          "qTags": [
            "value"
          ],
          "qIsSemantic": true,
          "qAndMode": true
        }
      ]
    }
  }
}

GenericDimension GetLinkedObjects

()

Lists the linked objects to a generic object, a dimension or a measure.

Response

  • qItemsarray of objects
    Show qItems properties
    • qRootIdstring

      Identifier of the root object. If the linked object is a child, the root identifier is the identifier of the parent. If the linked object is an app object, the root identifier is the same than the identifier of the linked object since the linked object is a root object.

    • qInfoobject
      Show qInfo properties
      • qIdstring

        Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

      • qTypestring

        Type of the object. This parameter is mandatory.

Errors

array
GenericErrors

GetLinkedObjects()

const result = await genericDimension.GetLinkedObjects({})

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "GetLinkedObjects"
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qItems": [
      {
        "qRootId": "value",
        "qInfo": {
          "qId": "value",
          "qType": "value"
        }
      }
    ]
  }
}

GenericDimension GetProperties

()

Shows the properties of an object. Returns the identifier and the definition of the dimension.

If the member delta is set to true in the request object, only the delta is retrieved.

Response

  • qPropobject
    Show qProp properties
    • qInfoobject
      Show qInfo properties
      • qIdstring

        Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

      • qTypestring

        Type of the object. This parameter is mandatory.
    • qDimobject
      Show qDim properties
      • qGroupingstring

        Can be one of: "N""H""C"

      • qFieldDefsarray of strings

        Array of dimension names.

      • qFieldLabelsarray of strings

        Array of dimension labels.

      • qLabelExpressionstring
      • qAliasstring

        Alias of the dimension.
    • qMetaDefobject

      Used to collect meta data.

      Properties

      Semantic type with an empty structure.

Errors

array
GenericErrors

GetProperties()

const result = await genericDimension.GetProperties({})

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "GetProperties"
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qProp": {
      "qInfo": {
        "qId": "value",
        "qType": "value"
      },
      "qDim": {
        "qGrouping": "N",
        "qFieldDefs": [
          "value"
        ],
        "qFieldLabels": [
          "value"
        ],
        "qLabelExpression": "value",
        "qAlias": "value"
      },
      "qMetaDef": {}
    }
  }
}

GenericDimension Publish

()

Publishes a dimension.

This operation is not applicable for Qlik Sense Desktop.

Response

object

Errors

array
GenericErrors

Publish()

const result = await genericDimension.Publish({})

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "Publish"
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericDimension SetActiveField

(qIx)
Experimental

Set a cyclic dimension's active field directly.

This operation is only possible for cyclic dimensions.

Parameters

  • qIxinteger
    Required

    Index of the new active field.

Response

object

Errors

array
GenericErrors

SetActiveField(qIx)

const result = await genericDimension.SetActiveField([
  123
])

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "SetActiveField",
  "params": {
    "qIx": 123
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericDimension SetProperties

(qProp)

Sets some properties for a dimension.

Parameters

  • qPropobject
    Required

    Information about the dimension.

    Show qProp properties
    • qInfoobject
      Show qInfo properties
      • qIdstring

        Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

      • qTypestring

        Type of the object. This parameter is mandatory.
    • qDimobject
      Show qDim properties
      • qGroupingstring

        Can be one of: "N""H""C"

      • qFieldDefsarray of strings

        Array of dimension names.

      • qFieldLabelsarray of strings

        Array of dimension labels.

      • qLabelExpressionstring
      • qAliasstring

        Alias of the dimension.
    • qMetaDefobject

      Used to collect meta data.

      Properties

      Semantic type with an empty structure.

Response

object

Errors

array
GenericErrors

SetProperties(qProp)

const result = await genericDimension.SetProperties([
  {
    "qInfo": {
      "qId": "value",
      "qType": "value"
    },
    "qDim": {
      "qGrouping": "N",
      "qFieldDefs": [
        "value"
      ],
      "qFieldLabels": [
        "value"
      ],
      "qLabelExpression": "value",
      "qAlias": "value"
    },
    "qMetaDef": {}
  }
])

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "SetProperties",
  "params": {
    "qProp": {
      "qInfo": {
        "qId": "value",
        "qType": "value"
      },
      "qDim": {
        "qGrouping": "N",
        "qFieldDefs": [
          "value"
        ],
        "qFieldLabels": [
          "value"
        ],
        "qLabelExpression": "value",
        "qAlias": "value"
      },
      "qMetaDef": {}
    }
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericDimension StepCycle

(qStep)
Experimental

Step active field in a cyclic dimension.

This operation is only possible for cyclic dimensions.

Parameters

  • qStepinteger
    Required

    The number of steps made through the dimension. Positive values step forward and negative values step backward.

Response

object

Errors

array
GenericErrors

StepCycle(qStep)

const result = await genericDimension.StepCycle([
  123
])

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "StepCycle",
  "params": {
    "qStep": 123
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericDimension UnApprove

()

Removes the generic dimension from the list of approved objects

This operation is possible only in Qlik Sense Enterprise.

Response

object

Errors

array
GenericErrors

UnApprove()

const result = await genericDimension.UnApprove({})

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "UnApprove"
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericDimension UnPublish

()

Unpublishes a dimension.

This operation is not applicable for Qlik Sense Desktop.

Response

object

Errors

array
GenericErrors

UnPublish()

const result = await genericDimension.UnPublish({})

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "UnPublish"
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}