conditions

Conditions is the resource representing a condition query based on data in a Qlik app.

Endpoints

Skip to section
PUT/conditions/settings
GET/conditions/settings
POST/conditions
DELETE/conditions/{id}
GET/conditions/{id}
PATCH/conditions/{id}
POST/conditions/{id}/evaluations
DELETE/conditions/{id}/evaluations/{evaluationId}
GET/conditions/{id}/evaluations/{evaluationId}
POST/conditions/previews
GET/conditions/previews/{id}

Updates API configuration. Accessible only by tenant admins.

Header ParametersUpdates condition manager settings

Authorization
string

The JWT used for authentication. Send the JWT in the AuthRequest header using the Bearer schema.

Request BodyUpdates condition manager settings

application/json

Request for updating the api settings

ResponsesUpdates condition manager settings

204
object

api settings have been successfully updated.

400
application/json

Bad request body

500
application/json

Internal server error.

default
application/json

Error response.

PUT

/conditions/settings

curl "https://your-tenant.us.qlikcloud.com/api/v1/conditions/settings" \
 -X PUT \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"enable-conditions":true}'

RequestUpdates condition manager settings

{
  "enable-conditions": true
}

Lists api settings.

ResponsesRetrieves condition manager settings

200
application/json

The api settings have been successfully returned

404
application/json

Resource does not exist.

500
application/json

Internal server error.

default
application/json

Error response.

GET

/conditions/settings

curl "https://your-tenant.us.qlikcloud.com/api/v1/conditions/settings" \
 -H "Authorization: Bearer <API-key>"

ResponseRetrieves condition manager settings

{
  "tenantId": "cgdsAumGmQ6l0Bi7CUKt9V8P_Y9GL0sC",
  "enable-conditions": true
}

Request BodyCreates a new condition.

application/json

No description

ResponsesCreates a new condition.

201
application/json

Condition created

400
application/json

Bad request body

default
application/json

Error response.

POST

/conditions

curl "https://your-tenant.us.qlikcloud.com/api/v1/conditions" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"type":"compound","compoundCondition":{"conditionBase":{"created":"string","createdById":"string","description":"string","id":"string","ownerId":"string","tenantId":"string","appId":"4xQ1chLoHkOikyzUGcHJquteNrAfketW","bookmarkId":"anTjnOABmxlCirVx8IRfhWhLd9IZjENl","type":"compound","updated":"string","lastReloadTime":"2006-01-02T15:04:05Z07:00"},"data":{"history":{"enabled":true},"conditions":["rDDAcMEI1V0qzauEWepEVY8oSLJ9fvA2","qFPF1dAtPK4vfPTmKyyuKaqA6iERCwLi","4gnz8E6ZruG0lkSKwkau66P24CtORyLr","ATs--Z0b_NGyuHajcbQkxu7RrajgPaEQ"],"expression":"($0 OR $1) AND ($2 OR $3)"}},"dataCondition":{"history":{"enabled":true},"conditionBase":{"created":"string","createdById":"string","description":"string","id":"string","ownerId":"string","tenantId":"string","appId":"4xQ1chLoHkOikyzUGcHJquteNrAfketW","bookmarkId":"anTjnOABmxlCirVx8IRfhWhLd9IZjENl","type":"compound","updated":"string","lastReloadTime":"2006-01-02T15:04:05Z07:00"},"conditionData":{},"selections":[{"field":"string","count":0,"selectedSummary":[]}],"dimensions":[{"qLibraryId":"string","field":"string","title":"string"}],"headers":[],"measures":[{"qLibraryId":"string","qNumFormat":{},"title":"string"}]}}'

RequestCreates a new condition.

{
  "type": "compound",
  "compoundCondition": {
    "conditionBase": {
      "created": "string",
      "createdById": "string",
      "description": "string",
      "id": "string",
      "ownerId": "string",
      "tenantId": "string",
      "appId": "4xQ1chLoHkOikyzUGcHJquteNrAfketW",
      "bookmarkId": "anTjnOABmxlCirVx8IRfhWhLd9IZjENl",
      "type": "compound",
      "updated": "string",
      "lastReloadTime": "2006-01-02T15:04:05Z07:00"
    },
    "data": {
      "history": {
        "enabled": true
      },
      "conditions": [
        "rDDAcMEI1V0qzauEWepEVY8oSLJ9fvA2",
        "qFPF1dAtPK4vfPTmKyyuKaqA6iERCwLi",
        "4gnz8E6ZruG0lkSKwkau66P24CtORyLr",
        "ATs--Z0b_NGyuHajcbQkxu7RrajgPaEQ"
      ],
      "expression": "($0 OR $1) AND ($2 OR $3)"
    }
  },
  "dataCondition": {
    "history": {
      "enabled": true
    },
    "conditionBase": {
      "created": "string",
      "createdById": "string",
      "description": "string",
      "id": "string",
      "ownerId": "string",
      "tenantId": "string",
      "appId": "4xQ1chLoHkOikyzUGcHJquteNrAfketW",
      "bookmarkId": "anTjnOABmxlCirVx8IRfhWhLd9IZjENl",
      "type": "compound",
      "updated": "string",
      "lastReloadTime": "2006-01-02T15:04:05Z07:00"
    },
    "conditionData": {},
    "selections": [
      {
        "field": "string",
        "count": 0,
        "selectedSummary": []
      }
    ],
    "dimensions": [
      {
        "qLibraryId": "string",
        "field": "string",
        "title": "string"
      }
    ],
    "headers": [],
    "measures": [
      {
        "qLibraryId": "string",
        "qNumFormat": {},
        "title": "string"
      }
    ]
  }
}

ResponseCreates a new condition.

{
  "condition": {
    "type": "compound",
    "compoundCondition": {
      "conditionBase": {
        "created": "string",
        "createdById": "string",
        "description": "string",
        "id": "string",
        "ownerId": "string",
        "tenantId": "string",
        "appId": "4xQ1chLoHkOikyzUGcHJquteNrAfketW",
        "bookmarkId": "anTjnOABmxlCirVx8IRfhWhLd9IZjENl",
        "type": "compound",
        "updated": "string",
        "lastReloadTime": "2006-01-02T15:04:05Z07:00"
      },
      "data": {
        "history": {
          "enabled": true
        },
        "conditions": [
          "rDDAcMEI1V0qzauEWepEVY8oSLJ9fvA2",
          "qFPF1dAtPK4vfPTmKyyuKaqA6iERCwLi",
          "4gnz8E6ZruG0lkSKwkau66P24CtORyLr",
          "ATs--Z0b_NGyuHajcbQkxu7RrajgPaEQ"
        ],
        "expression": "($0 OR $1) AND ($2 OR $3)"
      }
    },
    "dataCondition": {
      "conditionBase": {
        "created": "string",
        "createdById": "string",
        "description": "string",
        "id": "string",
        "ownerId": "string",
        "tenantId": "string",
        "appId": "4xQ1chLoHkOikyzUGcHJquteNrAfketW",
        "bookmarkId": "anTjnOABmxlCirVx8IRfhWhLd9IZjENl",
        "type": "compound",
        "updated": "string",
        "lastReloadTime": "2006-01-02T15:04:05Z07:00"
      },
      "conditionData": {},
      "history": {
        "enabled": true
      },
      "selections": [
        {
          "field": "string",
          "count": 0,
          "selectedSummary": []
        }
      ],
      "dimensions": [
        {
          "qLibraryId": "string",
          "field": "string",
          "title": "string"
        }
      ],
      "headers": [],
      "measures": [
        {
          "qLibraryId": "string",
          "qNumFormat": {},
          "title": "string"
        }
      ]
    }
  },
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "title": "string",
      "meta": {}
    }
  ]
}

ResponsesDelete the condition

204
object

The record was deleted.

404
application/json

Resource does not exist.

default
application/json

Error response

DELETE

/conditions/{id}

curl "https://your-tenant.us.qlikcloud.com/api/v1/conditions/{id}" \
 -X DELETE \
 -H "Authorization: Bearer <API-key>"

ResponsesRetrieve a specific condition by id.

200
application/json

The condition

404
application/json

Resource does not exist.

default
application/json

Error response.

GET

/conditions/{id}

curl "https://your-tenant.us.qlikcloud.com/api/v1/conditions/{id}" \
 -H "Authorization: Bearer <API-key>"

ResponseRetrieve a specific condition by id.

{
  "type": "compound",
  "compoundCondition": {
    "conditionBase": {
      "created": "string",
      "createdById": "string",
      "description": "string",
      "id": "string",
      "ownerId": "string",
      "tenantId": "string",
      "appId": "4xQ1chLoHkOikyzUGcHJquteNrAfketW",
      "bookmarkId": "anTjnOABmxlCirVx8IRfhWhLd9IZjENl",
      "type": "compound",
      "updated": "string",
      "lastReloadTime": "2006-01-02T15:04:05Z07:00"
    },
    "data": {
      "history": {
        "enabled": true
      },
      "conditions": [
        "rDDAcMEI1V0qzauEWepEVY8oSLJ9fvA2",
        "qFPF1dAtPK4vfPTmKyyuKaqA6iERCwLi",
        "4gnz8E6ZruG0lkSKwkau66P24CtORyLr",
        "ATs--Z0b_NGyuHajcbQkxu7RrajgPaEQ"
      ],
      "expression": "($0 OR $1) AND ($2 OR $3)"
    }
  },
  "dataCondition": {
    "conditionBase": {
      "created": "string",
      "createdById": "string",
      "description": "string",
      "id": "string",
      "ownerId": "string",
      "tenantId": "string",
      "appId": "4xQ1chLoHkOikyzUGcHJquteNrAfketW",
      "bookmarkId": "anTjnOABmxlCirVx8IRfhWhLd9IZjENl",
      "type": "compound",
      "updated": "string",
      "lastReloadTime": "2006-01-02T15:04:05Z07:00"
    },
    "conditionData": {},
    "history": {
      "enabled": true
    },
    "selections": [
      {
        "field": "string",
        "count": 0,
        "selectedSummary": []
      }
    ],
    "dimensions": [
      {
        "qLibraryId": "string",
        "field": "string",
        "title": "string"
      }
    ],
    "headers": [],
    "measures": [
      {
        "qLibraryId": "string",
        "qNumFormat": {},
        "title": "string"
      }
    ]
  }
}

Request BodyPatch values in the condition

application/json

No description

ResponsesPatch values in the condition

204
object

The condition was updated

400
application/json

A path or value was invalid

404
application/json

Resource does not exist.

default
application/json

Error response

PATCH

/conditions/{id}

curl "https://your-tenant.us.qlikcloud.com/api/v1/conditions/{id}" \
 -X PATCH \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '[{"op":"replace","path":"/compoundCondition/conditionBase/ownerId","value":"I6mWVd60wRWIbOXZr1ZKV8QTnxhnitbX"},{"op":"replace","path":"/dataCondition/conditionBase/description","value":"My description"},{"op":"remove","path":"/compoundCondition/data/conditions/0"},{"op":"replace","path":"/compoundCondition//data/expression","value":"$0 AND $1"},{"op":"replace","path":"/dataCondition/conditionData/measure","value":"revenue"}]'

RequestPatch values in the condition

[
  {
    "op": "replace",
    "path": "/compoundCondition/conditionBase/ownerId",
    "value": "I6mWVd60wRWIbOXZr1ZKV8QTnxhnitbX"
  },
  {
    "op": "replace",
    "path": "/dataCondition/conditionBase/description",
    "value": "My description"
  },
  {
    "op": "remove",
    "path": "/compoundCondition/data/conditions/0"
  },
  {
    "op": "replace",
    "path": "/compoundCondition//data/expression",
    "value": "$0 AND $1"
  },
  {
    "op": "replace",
    "path": "/dataCondition/conditionData/measure",
    "value": "revenue"
  }
]

Request BodyExecutes the condition

application/json

No description

ResponsesExecutes the condition

201
application/json

Condition evaluation created

400
application/json

Bad request body

500
application/json

Internal server error.

default
application/json

Error response.

POST

/conditions/{id}/evaluations

curl "https://your-tenant.us.qlikcloud.com/api/v1/conditions/{id}/evaluations" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"causalEvent":{"manualTrigger":true,"eventID":"string","manualTriggerID":"string","data":{"eventID":"string","lastReloadTime":"2006-01-02T15:04:05Z07:00"},"extensions":{"tenantID":"string","userID":"string","sessionID":"string"}},"contextId":"795c75ba-7812-4c8f-9ced-551b6b006183","alertId":"5f64885b2e11d23982c09e03"}'

RequestExecutes the condition

{
  "causalEvent": {
    "manualTrigger": true,
    "eventID": "string",
    "manualTriggerID": "string",
    "data": {
      "eventID": "string",
      "lastReloadTime": "2006-01-02T15:04:05Z07:00"
    },
    "extensions": {
      "tenantID": "string",
      "userID": "string",
      "sessionID": "string"
    }
  },
  "contextId": "795c75ba-7812-4c8f-9ced-551b6b006183",
  "alertId": "5f64885b2e11d23982c09e03"
}

ResponseExecutes the condition

{
  "contextId": "795c75ba-7812-4c8f-9ced-551b6b006183",
  "evaluationId": "795c75ba-7812-4c8f-9ced-551b6b006183",
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "title": "string",
      "meta": {}
    }
  ]
}

ResponsesDelete an Evaluation

204
object

The evaluation was deleted

404
application/json

Resource does not exist.

default
application/json

Error response

DELETE

/conditions/{id}/evaluations/{evaluationId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/conditions/{id}/evaluations/{evaluationId}" \
 -X DELETE \
 -H "Authorization: Bearer <API-key>"

ResponsesGet an Evaluation

200
application/json

The evaluation

404
application/json

Resource does not exist.

default
application/json

Error response.

GET

/conditions/{id}/evaluations/{evaluationId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/conditions/{id}/evaluations/{evaluationId}" \
 -H "Authorization: Bearer <API-key>"

ResponseGet an Evaluation

{
  "evaluation": {
    "causalEvent": {},
    "contextId": "string",
    "endTime": "string",
    "reloadEndTime": "string",
    "id": "string",
    "conditionId": "string",
    "dataConditionEvaluatorId": "string",
    "ownerId": "string",
    "result": true,
    "resultData": {},
    "startTime": "string",
    "status": "RUNNING",
    "tenantId": "string",
    "retries": 0,
    "condition": {
      "type": "compound",
      "compoundCondition": {
        "conditionBase": {
          "created": "string",
          "createdById": "string",
          "description": "string",
          "id": "string",
          "ownerId": "string",
          "tenantId": "string",
          "appId": "4xQ1chLoHkOikyzUGcHJquteNrAfketW",
          "bookmarkId": "anTjnOABmxlCirVx8IRfhWhLd9IZjENl",
          "type": "compound",
          "updated": "string",
          "lastReloadTime": "2006-01-02T15:04:05Z07:00"
        },
        "data": {
          "history": {
            "enabled": true
          },
          "conditions": [
            "rDDAcMEI1V0qzauEWepEVY8oSLJ9fvA2",
            "qFPF1dAtPK4vfPTmKyyuKaqA6iERCwLi",
            "4gnz8E6ZruG0lkSKwkau66P24CtORyLr",
            "ATs--Z0b_NGyuHajcbQkxu7RrajgPaEQ"
          ],
          "expression": "($0 OR $1) AND ($2 OR $3)"
        }
      },
      "dataCondition": {
        "conditionBase": {
          "created": "string",
          "createdById": "string",
          "description": "string",
          "id": "string",
          "ownerId": "string",
          "tenantId": "string",
          "appId": "4xQ1chLoHkOikyzUGcHJquteNrAfketW",
          "bookmarkId": "anTjnOABmxlCirVx8IRfhWhLd9IZjENl",
          "type": "compound",
          "updated": "string",
          "lastReloadTime": "2006-01-02T15:04:05Z07:00"
        },
        "conditionData": {},
        "history": {
          "enabled": true
        },
        "selections": [
          {
            "field": "string",
            "count": 0,
            "selectedSummary": []
          }
        ],
        "dimensions": [
          {
            "qLibraryId": "string",
            "field": "string",
            "title": "string"
          }
        ],
        "headers": [],
        "measures": [
          {
            "qLibraryId": "string",
            "qNumFormat": {},
            "title": "string"
          }
        ]
      }
    },
    "errors": [
      {
        "code": "string",
        "title": "string",
        "meta": {
          "fatal": true
        }
      }
    ],
    "retryPolicy": "NONE",
    "alertId": "5f64885b2e11d23982c09e03"
  },
  "condition": {
    "type": "compound",
    "compoundCondition": {
      "conditionBase": {
        "created": "string",
        "createdById": "string",
        "description": "string",
        "id": "string",
        "ownerId": "string",
        "tenantId": "string",
        "appId": "4xQ1chLoHkOikyzUGcHJquteNrAfketW",
        "bookmarkId": "anTjnOABmxlCirVx8IRfhWhLd9IZjENl",
        "type": "compound",
        "updated": "string",
        "lastReloadTime": "2006-01-02T15:04:05Z07:00"
      },
      "data": {
        "history": {
          "enabled": true
        },
        "conditions": [
          "rDDAcMEI1V0qzauEWepEVY8oSLJ9fvA2",
          "qFPF1dAtPK4vfPTmKyyuKaqA6iERCwLi",
          "4gnz8E6ZruG0lkSKwkau66P24CtORyLr",
          "ATs--Z0b_NGyuHajcbQkxu7RrajgPaEQ"
        ],
        "expression": "($0 OR $1) AND ($2 OR $3)"
      }
    },
    "dataCondition": {
      "conditionBase": {
        "created": "string",
        "createdById": "string",
        "description": "string",
        "id": "string",
        "ownerId": "string",
        "tenantId": "string",
        "appId": "4xQ1chLoHkOikyzUGcHJquteNrAfketW",
        "bookmarkId": "anTjnOABmxlCirVx8IRfhWhLd9IZjENl",
        "type": "compound",
        "updated": "string",
        "lastReloadTime": "2006-01-02T15:04:05Z07:00"
      },
      "conditionData": {},
      "history": {
        "enabled": true
      },
      "selections": [
        {
          "field": "string",
          "count": 0,
          "selectedSummary": []
        }
      ],
      "dimensions": [
        {
          "qLibraryId": "string",
          "field": "string",
          "title": "string"
        }
      ],
      "headers": [],
      "measures": [
        {
          "qLibraryId": "string",
          "qNumFormat": {},
          "title": "string"
        }
      ]
    }
  }
}

Create condition preview request.

Request BodyCreate condition preview request\

application/json

Create condition preview request

ResponsesCreate condition preview request\

201
application/json

Condition preview request created.

400
application/json

Bad request body

500
application/json

Internal server error.

default
application/json

Error response.

POST

/conditions/previews

curl "https://your-tenant.us.qlikcloud.com/api/v1/conditions/previews" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"type":"compound","compoundCondition":{"conditionBase":{"created":"string","createdById":"string","description":"string","id":"string","ownerId":"string","tenantId":"string","appId":"4xQ1chLoHkOikyzUGcHJquteNrAfketW","bookmarkId":"anTjnOABmxlCirVx8IRfhWhLd9IZjENl","type":"compound","updated":"string","lastReloadTime":"2006-01-02T15:04:05Z07:00"},"data":{"history":{"enabled":true},"conditions":["rDDAcMEI1V0qzauEWepEVY8oSLJ9fvA2","qFPF1dAtPK4vfPTmKyyuKaqA6iERCwLi","4gnz8E6ZruG0lkSKwkau66P24CtORyLr","ATs--Z0b_NGyuHajcbQkxu7RrajgPaEQ"],"expression":"($0 OR $1) AND ($2 OR $3)"}},"dataCondition":{"history":{"enabled":true},"conditionBase":{"created":"string","createdById":"string","description":"string","id":"string","ownerId":"string","tenantId":"string","appId":"4xQ1chLoHkOikyzUGcHJquteNrAfketW","bookmarkId":"anTjnOABmxlCirVx8IRfhWhLd9IZjENl","type":"compound","updated":"string","lastReloadTime":"2006-01-02T15:04:05Z07:00"},"conditionData":{},"selections":[{"field":"string","count":0,"selectedSummary":[]}],"dimensions":[{"qLibraryId":"string","field":"string","title":"string"}],"headers":[],"measures":[{"qLibraryId":"string","qNumFormat":{},"title":"string"}]}}'

RequestCreate condition preview request\

{
  "type": "compound",
  "compoundCondition": {
    "conditionBase": {
      "created": "string",
      "createdById": "string",
      "description": "string",
      "id": "string",
      "ownerId": "string",
      "tenantId": "string",
      "appId": "4xQ1chLoHkOikyzUGcHJquteNrAfketW",
      "bookmarkId": "anTjnOABmxlCirVx8IRfhWhLd9IZjENl",
      "type": "compound",
      "updated": "string",
      "lastReloadTime": "2006-01-02T15:04:05Z07:00"
    },
    "data": {
      "history": {
        "enabled": true
      },
      "conditions": [
        "rDDAcMEI1V0qzauEWepEVY8oSLJ9fvA2",
        "qFPF1dAtPK4vfPTmKyyuKaqA6iERCwLi",
        "4gnz8E6ZruG0lkSKwkau66P24CtORyLr",
        "ATs--Z0b_NGyuHajcbQkxu7RrajgPaEQ"
      ],
      "expression": "($0 OR $1) AND ($2 OR $3)"
    }
  },
  "dataCondition": {
    "history": {
      "enabled": true
    },
    "conditionBase": {
      "created": "string",
      "createdById": "string",
      "description": "string",
      "id": "string",
      "ownerId": "string",
      "tenantId": "string",
      "appId": "4xQ1chLoHkOikyzUGcHJquteNrAfketW",
      "bookmarkId": "anTjnOABmxlCirVx8IRfhWhLd9IZjENl",
      "type": "compound",
      "updated": "string",
      "lastReloadTime": "2006-01-02T15:04:05Z07:00"
    },
    "conditionData": {},
    "selections": [
      {
        "field": "string",
        "count": 0,
        "selectedSummary": []
      }
    ],
    "dimensions": [
      {
        "qLibraryId": "string",
        "field": "string",
        "title": "string"
      }
    ],
    "headers": [],
    "measures": [
      {
        "qLibraryId": "string",
        "qNumFormat": {},
        "title": "string"
      }
    ]
  }
}

ResponseCreate condition preview request\

{
  "previewId": "467ea9bc-bbd7-11ea-b3de-0242ac130004"
}

Get condition preview response.

Path ParametersGet condition preview response

id
string<uid>

The id of the condition

ResponsesGet condition preview response

200
application/json

The evaluation

400
application/json

Bad request body

404
application/json

Resource does not exist.

500
application/json

Internal server error.

default
application/json

Error response.

GET

/conditions/previews/{id}

curl "https://your-tenant.us.qlikcloud.com/api/v1/conditions/previews/{id}" \
 -H "Authorization: Bearer <API-key>"

ResponseGet condition preview response

{
  "previewId": "467ea9bc-bbd7-11ea-b3de-0242ac130004",
  "status": "ACCEPTED",
  "evaluation": {
    "ownerId": "string",
    "resultUrl": "string",
    "startTime": "string",
    "endTime": "string",
    "tenantId": "string"
  },
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "title": "string",
      "meta": {}
    }
  ]
}

Selections

Array<object>

List of fields according to the bookmark definition

PropertiesSelections

field
string

No description

count
number

No description

selectedSummary
Array<string>

No description

PropertiesConditionResponse

condition

only one of compoundCondition or dataCondition should be set

errors

No description

PropertiesMultipleEvaluationsRemovalResponse

evaluationIDs
Array<string>

No description

PropertiesPreviewResponse

previewId
string<uid>

When the resource was created

PropertiesPreviewStatusResponse

previewId
string<uid>

When the resource was created

status
string

No description

Enum:

ACCEPTED

FAILED

RUNNING

SUCCESSFUL

evaluation

No description

errors

No description

A condition made up of other conditions

PropertiesCompoundCondition

conditionBase

No description

data

No description

PropertiesCompoundResult

conditions

A map of variable names to sub-condition results

expression
string

The expression that was executed

only one of compoundCondition or dataCondition should be set

PropertiesConditionCreateRequest

type
string

Indicates the condition type

Enum:

compound

data

compoundCondition

A condition made up of other conditions

dataCondition

A condition based on data within an app

Condition

object

only one of compoundCondition or dataCondition should be set

PropertiesCondition

type
string

Indicates the condition type

Enum:

compound

data

compoundCondition

A condition made up of other conditions

dataCondition

A condition based on data within an app

PropertiesConditionBase

created
string<string>

When the resource was created

createdById
string<uid>

The id of the user which created the condition

description
string

Description of the condition

id
string<uid>

The unique id for the resource

ownerId
string<uid>

The id of the user the user which owns the condition

tenantId
string<uid>

The tenant id

appId
string

The id of the app the condition is evaluated against

bookmarkId
string

The bookmark corresponding to the selection state to apply to the app at evaluation time

type
string

Indicates the condition type

Enum:

compound

data

updated
string<string>

When the resource was last updated

lastReloadTime
string<RFC3339>

The time of the last reload, if the scan is triggered by a reload. If exists and value does not match app's last reload time, the evaluation will fail.

PropertiesConditionPage

data

No description

links

No description

ConditionPatch

Array<object>

A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.

PropertiesConditionPatch

op
string

The operation to be performed.

Enum:

replace

remove

add

path
string

The path for the given resource field to patch.

value
optional
object

The value to be used for this operation.

PropertiesCreateEvaluationRequest

causalEvent

No description

contextId
string

Extra context information to carry through to the result if any

alertId
optional
string

The id of the alerting task the condition and evaluation is part of

PropertiesCreateEvaluationResponse

contextId
string

Extra context information to carry through to the result if any

evaluationId
string

Extra context information to carry through to the result if any

errors

No description

Get response returns the evaluation and condition associated

PropertiesGetEvaluationResponse

evaluation

No description

condition

only one of compoundCondition or dataCondition should be set

A condition based on data within an app

PropertiesDataConditionCreateRequest

history

History properties

conditionBase

No description

conditionData
object

List of parameters specific to data condition are available in DCE and will be passed as is to DCE as per https://github.com/qlik-trial/data-condition-evaluator/blob/master/api-docs.yml

selections

List of fields according to the bookmark definition

dimensions

List of returned dimensions

headers
Array<string>

List of header labels

measures

List of returned measures

A condition based on data within an app

PropertiesDataCondition

conditionBase

No description

conditionData
object

List of parameters specific to data condition are available in DCE and will be passed as is to DCE as per https://github.com/qlik-trial/data-condition-evaluator/blob/master/api-docs.yml

history

History properties

selections

List of fields according to the bookmark definition

dimensions

List of returned dimensions

headers
Array<string>

List of header labels

measures

List of returned measures

History properties

PropertiesHistoryProperties

enabled
boolean

No description

EVALUATION - when the trigger-based evaluation request got received INITIAL - when the initial request is sent to create the first history item PREVIEW - when the request is a preview

A condition based on data within an app with history

PropertiesHistoryCondition

context
string

EVALUATION - when the trigger-based evaluation request got received INITIAL - when the initial request is sent to create the first history item PREVIEW - when the request is a preview

Enum:

INITIAL

EVALUATION

PREVIEW

type
string

Indicates the condition type

Enum:

compound

data

compoundCondition

A condition made up of other conditions

dataCondition

A condition based on data within an app

ConditionDimensions

Array<object>

List of returned dimensions

PropertiesConditionDimensions

qLibraryId
string

No description

field
string

Field referred to the dimension where the selection is made. This may be used to generate deep links.

title
string

No description

ConditionHeaders

Array<string>

List of header labels

ConditionMeasures

Array<object>

List of returned measures

PropertiesConditionMeasures

qLibraryId
string

No description

qNumFormat
object

No description

title
string

No description

only one of manualOperation, setOperation or measureOperation should beset

PropertiesDataOperation

manualOperation

An operation using a static value

measureOperation

An operation against the value of a different measure

setOperation

An operation against a computed aggregate value of the values in the set of values from the app

PropertiesDataResult

count

No description

negative
Array<array>

No description

percentage

No description

positive
Array<array>

No description

Error

object

PropertiesError

code
string

Error code specific to condition manager.

detail
string

Error cause.

title
string

Error title.

meta
object

No description

PropertiesSingleErrorResponse

code
string

Error code specific to condition manager.

detail
string

Error cause.

title
string

Error title.

meta
object

meta properties for an error.

PropertiesErrors

code
string

Error code specific to condition manager.

detail
string

Error cause.

title
string

Error title.

meta
object

No description

PropertiesErrorResponse

errors

No description

traceId
string

No description

PropertiesEvaluationErrors

code
string

Error code specific to condition smanager.

status

Error status.

title
string

Error title.

meta
object

No description

PropertiesEvaluationError

code
string

Error code specific to condition smanager.

status

Error status.

title
string

Error title.

meta
object

No description

PropertiesEvaluations

evaluations

No description

PropertiesEvaluation

causalEvent
object

Representation of the event that caused the condition to be evaluated if one was included on when the evaluation was triggered

contextId
string

Extra context information to carry through to the result if one was included on when the evaluation was triggered

endTime
string<string>

The time the evaluation ended

reloadEndTime
string<string>

The time when the reload was completed in Engine

id
string<uid>

The unique id for the resource

conditionId
string<uid>

The unique id of the associated condition

dataConditionEvaluatorId
string<uid>

The unique id for the resource given from Data Condition Evaluator

ownerId
string<uid>

userId of user being impersonated to evaluate the condition

result
boolean

The final result of the evalution

resultData
object

Condition type specific result, one of dataResult or compoundResult

startTime
string<string>

The time the evaluation started

status
string

The status of the evaluation execution

Enum:

RUNNING

FAILED

FINISHED

DELETING

tenantId
string<uid>

The tenant id

retries
integer

number of retries sent to DCE

condition

only one of compoundCondition or dataCondition should be set

errors

No description

retryPolicy
string

what kind of retry policy this evaluation has

Enum:

NONE

TOO_MANY_REQUESTS

GENERIC_ERROR

alertId
string

The id of the alerting task the condition and evaluation is part of

PropertiesPreviewEvaluation

ownerId
string<uid>

userId of user being impersonated to evaluate the condition

resultUrl
string

URL to download the condition results

startTime
string<string>

The time the evaluation started

endTime
string<string>

The time the evaluation ended

tenantId
string<uid>

The tenant id

An operation using a static value

PropertiesManualOperation

operand

The static value to evaluate against

operator

one of numericalOperator or stringOperator should be set

An operation against the value of a different measure

PropertiesMeasureOperation

compareToMeasure
string

The name of the measure to compare against

offset
number

When present this offset is applied to the second measure value

offsetIsPercent
boolean

When present the offset isn't a fixed value applied to the second value but rather the evaluation will apply against the percent of the value.

operator

No description

Enum:

equal

notEqual

greaterThan

greaterThanOrEqual

lessThan

lessThanOrEqual

in

Operator

object

one of numericalOperator or stringOperator should be set

PropertiesOperator

numericalOperator

No description

Enum:

equal

notEqual

greaterThan

greaterThanOrEqual

lessThan

lessThanOrEqual

in

stringOperator

No description

Enum:

containsString

containsStringCaseInsensitive

startsWith

startsWithCaseInsensitive

endsWith

endsWithCaseInsensitive

An operation against a computed aggregate value of the values in the set of values from the app

PropertiesSetOperation

aggregation
string

The aggregate operation which gives the value to perform the operation against

Enum:

average

standardDeviation

percentile

operand

The value to evaluate against. In the case of percentile aggregation this is the percentile factor.

operator

No description

Enum:

equal

notEqual

greaterThan

greaterThanOrEqual

lessThan

lessThanOrEqual

in

PropertiesAPISettingsUpload

enable-conditions
boolean

Whether API endpoints for condition manager are enabled

PropertiesAPISettings

tenantId
optional
string

These persisted api settings are only available for this tenant. Extracted from request JWT.

enable-conditions
boolean

Whether API endpoints for condition manager are enabled

Self

object

Object with Href to a particular element or set of elements

PropertiesSelf

href
string

No description

Page

object

PropertiesPage

href
string

URL to particular set of elements

token
string

Page unique token

type
string

Page type, can be next or prev

Enum:

prev

next

PropertiesCausalEvent

manualTrigger
boolean

No description

eventID
string

the event id from eventing

manualTriggerID
string

the manual trigger id from eventing if present

data

No description

extensions

No description

PropertiesCausalEventData

eventID
string

the event id from eventing service.

lastReloadTime
string<RFC3339>

The time of the last reload

PropertiesCausalEventExtensions

tenantID
string

No description

userID
string

No description

sessionID
string

No description

v7.8.1
Was this page helpful?