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

Field

Field Clear

()

Clears the selections in a specific field.

Response

  • qReturnboolean

Errors

array
GenericErrors

Clear()

const result = await field.Clear({})

Request

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

Response

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

Field ClearAllButThis

(qSoftLock?)

Maintains the selections in the current field while clearing the selections in the other fields.

Parameters

  • qSoftLockboolean

    Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

Response

  • qReturnboolean

Errors

array
GenericErrors

ClearAllButThis(qSoftLock?)

const result = await field.ClearAllButThis([
  true
])

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "ClearAllButThis",
  "params": {
    "qSoftLock": true
  }
}

Response

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

Field GetAndMode

()

Returns the AND mode status of a field.

Response

  • qReturnboolean

Errors

array
GenericErrors

GetAndMode()

const result = await field.GetAndMode({})

Request

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

Response

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

Field GetCardinal

()

Retrieves the number of distinct values in a field.

Response

  • qReturninteger

Errors

array
GenericErrors

GetCardinal()

const result = await field.GetCardinal({})

Request

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

Response

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

Field GetNxProperties

()

Gets the properties of a field.

The property _OneAndOnlyOne_ is set to true if one and only value has been selected in the field prior setting the property.

Response

  • qPropertiesobject
    Show qProperties properties
    • qOneAndOnlyOneboolean

      This parameter is set to true, if the field has one and only one selection (not 0 and not more than 1). If this property is set to true, the field cannot be cleared anymore and no more selections can be performed in that field.

      The property _OneAndOnlyOne_ can be set to true if one and only value has been selected in the field prior to setting the property.

Errors

array
GenericErrors

GetNxProperties()

const result = await field.GetNxProperties({})

Request

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

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qProperties": {
      "qOneAndOnlyOne": true
    }
  }
}

Field Lock

()

Locks all selected values of a specific field.

Response

  • qReturnboolean

Errors

array
GenericErrors

Lock()

const result = await field.Lock({})

Request

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

Response

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

Field LowLevelSelect

(qValues, qToggleMode, qSoftLock?)

Selects some values in a field, by entering the element numbers related to the values to select.

Parameters

  • qValuesarray of integers
    Required

    Indexes (or element numbers) of the values to select.

  • qToggleModeboolean
    Required

    Set to true to keep any selections present in the list object. If this parameter is set to false, selections made before accepting the list object search become alternative.

  • qSoftLockboolean

    Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

Response

  • qReturnboolean

Errors

array
GenericErrors

LowLevelSelect(qValues, qToggleMode, qSoftLock?)

const result = await field.LowLevelSelect([
  [
    123
  ],
  true,
  true
])

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "LowLevelSelect",
  "params": {
    "qValues": [
      123
    ],
    "qToggleMode": true,
    "qSoftLock": true
  }
}

Response

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

Field Select

(qMatch, qSoftLock?, qExcludedValuesMode?)

Selects field values matching a search string.

Parameters

  • qMatchstring
    Required

    String to search for. Can contain wild cards or numeric search criteria. The characters <>"~()='[] have pre-defined meanings when used at the start of the string. To use them, EnableSpecialCharacterEscapingInSearch needs to be enabled and the delimiter \ needs to precede the special character.

  • qSoftLockboolean

    Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

  • qExcludedValuesModeinteger

    Include excluded values in search.

Response

  • qReturnboolean

Errors

array
GenericErrors

Select(qMatch, qSoftLock?, qExcludedValuesMode?)

const result = await field.Select([
  "value",
  true,
  123
])

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "Select",
  "params": {
    "qMatch": "value",
    "qSoftLock": true,
    "qExcludedValuesMode": 123
  }
}

Response

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

Field SelectAll

(qSoftLock?)

Selects all values of a field. Excluded values are also selected.

Parameters

  • qSoftLockboolean

    Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

Response

  • qReturnboolean

Errors

array
GenericErrors

SelectAll(qSoftLock?)

const result = await field.SelectAll([
  true
])

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "SelectAll",
  "params": {
    "qSoftLock": true
  }
}

Response

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

Field SelectAlternative

(qSoftLock?)

Selects all alternatives values in a specific field.

In a field that contains at least one selected value, the values that are neither selected nor excluded are alternatives values.

Parameters

  • qSoftLockboolean

    Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

Response

  • qReturnboolean

Errors

array
GenericErrors

SelectAlternative(qSoftLock?)

const result = await field.SelectAlternative([
  true
])

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "SelectAlternative",
  "params": {
    "qSoftLock": true
  }
}

Response

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

Field SelectExcluded

(qSoftLock?)

Inverts the current selections.

Parameters

  • qSoftLockboolean

    Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

Response

  • qReturnboolean

Errors

array
GenericErrors

SelectExcluded(qSoftLock?)

const result = await field.SelectExcluded([
  true
])

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "SelectExcluded",
  "params": {
    "qSoftLock": true
  }
}

Response

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

Field SelectPossible

(qSoftLock?)

Selects all possible values in a specific field.

Parameters

  • qSoftLockboolean

    Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

Response

  • qReturnboolean

Errors

array
GenericErrors

SelectPossible(qSoftLock?)

const result = await field.SelectPossible([
  true
])

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "SelectPossible",
  "params": {
    "qSoftLock": true
  }
}

Response

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

Field SelectValues

(qFieldValues, qToggleMode?, qSoftLock?)

Selects some values in a field, by entering the values to select.

Parameters

  • qFieldValuesarray of objects
    Required

    List of the values to select.

    Show qFieldValues properties
    • qTextstring

      Text related to the field value. This parameter is optional.

    • qIsNumericboolean

      Is set to true if the value is a numeric. This parameter is optional. Default is false.

    • qNumbernumber

      Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

      format = double

  • qToggleModeboolean

    The default value is false.

  • qSoftLockboolean

    Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

Response

  • qReturnboolean

Errors

array
GenericErrors

SelectValues(qFieldValues, qToggleMode?, qSoftLock?)

const result = await field.SelectValues([
  [
    {
      "qText": "value",
      "qIsNumeric": true,
      "qNumber": 123
    }
  ],
  true,
  true
])

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "SelectValues",
  "params": {
    "qFieldValues": [
      {
        "qText": "value",
        "qIsNumeric": true,
        "qNumber": 123
      }
    ],
    "qToggleMode": true,
    "qSoftLock": true
  }
}

Response

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

Field SetAndMode

(qAndMode)

Sets a field in the AND mode.

Parameters

  • qAndModeboolean
    Required

    Specifies if the AND mode applies to the field. Set this parameter to true to enter the AND mode.

Response

object

Errors

array
GenericErrors

SetAndMode(qAndMode)

const result = await field.SetAndMode([
  true
])

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "SetAndMode",
  "params": {
    "qAndMode": true
  }
}

Response

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

Field SetNxProperties

(qProperties)

Sets some properties to a field.

Parameters

  • qPropertiesobject
    Required

    Information about the properties of the field.

    Show qProperties properties
    • qOneAndOnlyOneboolean

      This parameter is set to true, if the field has one and only one selection (not 0 and not more than 1). If this property is set to true, the field cannot be cleared anymore and no more selections can be performed in that field.

      The property _OneAndOnlyOne_ can be set to true if one and only value has been selected in the field prior to setting the property.

Response

object

Errors

array
GenericErrors

SetNxProperties(qProperties)

const result = await field.SetNxProperties([
  {
    "qOneAndOnlyOne": true
  }
])

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "SetNxProperties",
  "params": {
    "qProperties": {
      "qOneAndOnlyOne": true
    }
  }
}

Response

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

Field ToggleSelect

(qMatch, qSoftLock?, qExcludedValuesMode?)

Toggle selects field values matching a search string.

Parameters

  • qMatchstring
    Required

    String to search for. Can contain wild cards or numeric search criteria.

  • qSoftLockboolean

    Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

  • qExcludedValuesModeinteger

    Include excluded values in search.

Response

  • qReturnboolean

Errors

array
GenericErrors

ToggleSelect(qMatch, qSoftLock?, qExcludedValuesMode?)

const result = await field.ToggleSelect([
  "value",
  true,
  123
])

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "ToggleSelect",
  "params": {
    "qMatch": "value",
    "qSoftLock": true,
    "qExcludedValuesMode": 123
  }
}

Response

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

Field Unlock

()

Unlocks all selected values of a specific field if the target (or handle ) is a field.

Response

  • qReturnboolean

Errors

array
GenericErrors

Unlock()

const result = await field.Unlock({})

Request

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

Response

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