Qlik Sense Engine (qix)

Download OpenRPC spec

GenericMeasure

GenericMeasure 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

  • qPatches array of objects
    Required

    Array of patches.

    Show qPatches properties
    • qOp string

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

    • qPath string

      Path to the property to add, remove or replace.

    • qValue string

      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)

enigma.js
const result = await genericMeasure.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": {}
}

GenericMeasure Approve

()

Adds the generic measure to the list of approved objects

This operation is possible only in Qlik Sense Enterprise.

Response

object

Errors

array
GenericErrors

Approve()

enigma.js
const result = await genericMeasure.approve()

Request

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

Response

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

GenericMeasure GetInfo

()

Returns the type and identifier of the object.

Response

  • qInfo object
    Show qInfo properties
    • qId string

      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.

    • qType string

      Type of the object. This parameter is mandatory.

Errors

array
GenericErrors

GetInfo()

enigma.js
const result = await genericMeasure.getInfo()

Request

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

Response

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

GenericMeasure GetLayout

()

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

Response

  • qLayout object

    Is the layout for GenericMeasureProperties.

    Show qLayout properties
    • qInfo object
      Show qInfo properties
      • qId string

        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.

      • qType string

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

      Information about the library measure. Is the layout for NxLibraryMeasureDef.

      Show qMeasure properties
      • qLabel string
      • qDef string
      • qGrouping string

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

      • qExpressions array of strings
      • qActiveExpression integer

        format = int32

      • qLabelExpression string
      • qNumFormat object

        Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

        Formatting mechanism

        The formatting mechanism depends on the type set in qType, as shown below:

        In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

        Type is DATE, TIME, TIMESTAMP or INTERVAL

        The following applies:

        • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
        • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
        • The properties qDec , qThou , qnDec , qUseThou are not used.

        Type is INTEGER

        The following applies:

        • 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 ).
        • 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 .

        Type is REAL

        The following applies:

        • 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 ).
        • 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.
        • 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.
        • 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.

        Type is FIX

        The following applies:

        • 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 ).
        • 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.

        Type is MONEY

        The following applies:

        • 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 ).
        • 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 ).

        Type is ASCII

        No formatting, qFmt is ignored.

        Show qNumFormat properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qScriptGenerated boolean Deprecated
      • qOrigin string

        Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

    • qMeta object

      Layout for NxMetaDef.

      Show qMeta properties
      • qName string

        Name. This property is optional.

Errors

array
GenericErrors

GetLayout()

enigma.js
const result = await genericMeasure.getLayout()

Request

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

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qLayout": {
      "qInfo": {
        "qId": "value",
        "qType": "value"
      },
      "qMeasure": {
        "qLabel": "value",
        "qDef": "value",
        "qGrouping": "N",
        "qExpressions": [
          "value"
        ],
        "qActiveExpression": 123,
        "qLabelExpression": "value",
        "qNumFormat": {
          "qType": "U",
          "qnDec": 10,
          "qUseThou": 0,
          "qFmt": "value",
          "qDec": "value",
          "qThou": "value"
        },
        "qScriptGenerated": true,
        "qOrigin": "PROGRAM"
      },
      "qMeta": {
        "qName": "value"
      }
    }
  }
}

GenericMeasure GetLinkedObjects

()

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

Response

  • qItems array of objects
    Show qItems properties
    • qRootId string

      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.

    • qInfo object
      Show qInfo properties
      • qId string

        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.

      • qType string

        Type of the object. This parameter is mandatory.

Errors

array
GenericErrors

GetLinkedObjects()

enigma.js
const result = await genericMeasure.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"
        }
      }
    ]
  }
}

GenericMeasure GetMeasure

()

Returns the definition of a measure.

Response

  • qMeasure object
    Show qMeasure properties
    • qLabel string

      Label of the measure.

    • qDef string

      Definition of the measure.

    • qGrouping string

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

    • qExpressions array of strings

      Array of expressions.

    • qActiveExpression integer

      Index to the active expression in a measure.

      format = int32

    • qLabelExpression string

      Optional expression used for dynamic label.

    • qNumFormat object

      Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

      Formatting mechanism

      The formatting mechanism depends on the type set in qType, as shown below:

      In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

      Type is DATE, TIME, TIMESTAMP or INTERVAL

      The following applies:

      • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
      • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
      • The properties qDec , qThou , qnDec , qUseThou are not used.

      Type is INTEGER

      The following applies:

      • 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 ).
      • 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 .

      Type is REAL

      The following applies:

      • 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 ).
      • 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.
      • 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.
      • 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.

      Type is FIX

      The following applies:

      • 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 ).
      • 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.

      Type is MONEY

      The following applies:

      • 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 ).
      • 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 ).

      Type is ASCII

      No formatting, qFmt is ignored.

      Show qNumFormat properties
      • qType string

        Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

      • qnDec integer

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThou integer

        Defines whether or not a thousands separator must be used. Default is 0.

        default = 0, format = int32, default = 0

      • qFmt string

        Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

      • qDec string

        Defines the decimal separator. Example: .

      • qThou string

        Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
    • qScriptGenerated boolean Deprecated

      default = false

    • qOrigin string

      Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

Errors

array
GenericErrors

GetMeasure()

enigma.js
const result = await genericMeasure.getMeasure()

Request

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

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qMeasure": {
      "qLabel": "value",
      "qDef": "value",
      "qGrouping": "N",
      "qExpressions": [
        "value"
      ],
      "qActiveExpression": 123,
      "qLabelExpression": "value",
      "qNumFormat": {
        "qType": "U",
        "qnDec": 10,
        "qUseThou": 0,
        "qFmt": "value",
        "qDec": "value",
        "qThou": "value"
      },
      "qScriptGenerated": false,
      "qOrigin": "PROGRAM"
    }
  }
}

GenericMeasure GetProperties

()

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

If the member delta is set to true in the request object, only the delta is retrieved.
The following is always returned in the output:

Response

  • qProp object
    Show qProp properties
    • qInfo object
      Show qInfo properties
      • qId string

        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.

      • qType string

        Type of the object. This parameter is mandatory.
    • qMeasure object
      Show qMeasure properties
      • qLabel string

        Label of the measure.

      • qDef string

        Definition of the measure.

      • qGrouping string

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

      • qExpressions array of strings

        Array of expressions.

      • qActiveExpression integer

        Index to the active expression in a measure.

        format = int32

      • qLabelExpression string

        Optional expression used for dynamic label.

      • qNumFormat object

        Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

        Formatting mechanism

        The formatting mechanism depends on the type set in qType, as shown below:

        In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

        Type is DATE, TIME, TIMESTAMP or INTERVAL

        The following applies:

        • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
        • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
        • The properties qDec , qThou , qnDec , qUseThou are not used.

        Type is INTEGER

        The following applies:

        • 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 ).
        • 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 .

        Type is REAL

        The following applies:

        • 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 ).
        • 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.
        • 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.
        • 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.

        Type is FIX

        The following applies:

        • 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 ).
        • 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.

        Type is MONEY

        The following applies:

        • 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 ).
        • 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 ).

        Type is ASCII

        No formatting, qFmt is ignored.

        Show qNumFormat properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qScriptGenerated boolean Deprecated

        default = false

      • qOrigin string

        Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

    • qMetaDef object

      Used to collect metadata.

      Properties

      Semantic type with an empty structure.

Errors

array
GenericErrors

GetProperties()

enigma.js
const result = await genericMeasure.getProperties()

Request

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

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qProp": {
      "qInfo": {
        "qId": "value",
        "qType": "value"
      },
      "qMeasure": {
        "qLabel": "value",
        "qDef": "value",
        "qGrouping": "N",
        "qExpressions": [
          "value"
        ],
        "qActiveExpression": 123,
        "qLabelExpression": "value",
        "qNumFormat": {
          "qType": "U",
          "qnDec": 10,
          "qUseThou": 0,
          "qFmt": "value",
          "qDec": "value",
          "qThou": "value"
        },
        "qScriptGenerated": false,
        "qOrigin": "PROGRAM"
      },
      "qMetaDef": {}
    }
  }
}

GenericMeasure Publish

()

Publishes a measure.

This operation is not applicable for Qlik Sense Desktop.

Response

object

Errors

array
GenericErrors

Publish()

enigma.js
const result = await genericMeasure.publish()

Request

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

Response

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

GenericMeasure SetProperties

(qProp)

Sets some properties for a measure.

Parameters

  • qProp object
    Required

    Information about the measure.

    Show qProp properties
    • qInfo object
      Show qInfo properties
      • qId string

        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.

      • qType string

        Type of the object. This parameter is mandatory.
    • qMeasure object
      Show qMeasure properties
      • qLabel string

        Label of the measure.

      • qDef string

        Definition of the measure.

      • qGrouping string

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

      • qExpressions array of strings

        Array of expressions.

      • qActiveExpression integer

        Index to the active expression in a measure.

        format = int32

      • qLabelExpression string

        Optional expression used for dynamic label.

      • qNumFormat object

        Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

        Formatting mechanism

        The formatting mechanism depends on the type set in qType, as shown below:

        In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

        Type is DATE, TIME, TIMESTAMP or INTERVAL

        The following applies:

        • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
        • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
        • The properties qDec , qThou , qnDec , qUseThou are not used.

        Type is INTEGER

        The following applies:

        • 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 ).
        • 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 .

        Type is REAL

        The following applies:

        • 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 ).
        • 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.
        • 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.
        • 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.

        Type is FIX

        The following applies:

        • 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 ).
        • 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.

        Type is MONEY

        The following applies:

        • 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 ).
        • 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 ).

        Type is ASCII

        No formatting, qFmt is ignored.

        Show qNumFormat properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qScriptGenerated boolean Deprecated

        default = false

      • qOrigin string

        Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

    • qMetaDef object

      Used to collect metadata.

      Properties

      Semantic type with an empty structure.

Response

object

Errors

array
GenericErrors

SetProperties(qProp)

enigma.js
const result = await genericMeasure.setProperties({
  "qInfo": {
    "qId": "value",
    "qType": "value"
  },
  "qMeasure": {
    "qLabel": "value",
    "qDef": "value",
    "qGrouping": "N",
    "qExpressions": [
      "value"
    ],
    "qActiveExpression": 123,
    "qLabelExpression": "value",
    "qNumFormat": {
      "qType": "U",
      "qnDec": 10,
      "qUseThou": 0,
      "qFmt": "value",
      "qDec": "value",
      "qThou": "value"
    },
    "qScriptGenerated": false,
    "qOrigin": "PROGRAM"
  },
  "qMetaDef": {}
})

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "SetProperties",
  "params": {
    "qProp": {
      "qInfo": {
        "qId": "value",
        "qType": "value"
      },
      "qMeasure": {
        "qLabel": "value",
        "qDef": "value",
        "qGrouping": "N",
        "qExpressions": [
          "value"
        ],
        "qActiveExpression": 123,
        "qLabelExpression": "value",
        "qNumFormat": {
          "qType": "U",
          "qnDec": 10,
          "qUseThou": 0,
          "qFmt": "value",
          "qDec": "value",
          "qThou": "value"
        },
        "qScriptGenerated": false,
        "qOrigin": "PROGRAM"
      },
      "qMetaDef": {}
    }
  }
}

Response

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

GenericMeasure UnApprove

()

Removes the generic measure from the list of approved objects

This operation is possible only in Qlik Sense Enterprise.

Response

object

Errors

array
GenericErrors

UnApprove()

enigma.js
const result = await genericMeasure.unApprove()

Request

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

Response

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

GenericMeasure UnPublish

()

Unpublishes a measure.

This operation is not applicable for Qlik Sense Desktop.

Response

object

Errors

array
GenericErrors

UnPublish()

enigma.js
const result = await genericMeasure.unPublish()

Request

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

Response

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