Conditions
Conditions is the resource representing a condition query based on data in a Qlik app.
Endpoints
Skip to sectionPOST | /v1/conditions |
GET | /v1/conditions/{id} |
PATCH | /v1/conditions/{id} |
DELETE | /v1/conditions/{id} |
POST | /v1/conditions/{id}/evaluations |
GET | /v1/conditions/{id}/evaluations/{evaluationId} |
DELETE | /v1/conditions/{id}/evaluations/{evaluationId} |
POST | /v1/conditions/previews |
GET | /v1/conditions/previews/{id} |
GET | /v1/conditions/settings |
PUT | /v1/conditions/settings |
Creates a new condition.
Facts POST /v1/conditions
Rate limit | Tier 2 (100 requests per minute) |
Request Body POST /v1/conditions
application/json | The condition create request definition. |
Responses POST /v1/conditions
201 optional, application/json | Condition created |
400 optional, application/json | Bad request body |
default optional, application/json | Error response. |
POST/v1/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","dataCondition":{"headers":["sumnum"],"history":{"enabled":true},"measures":[{"title":"sumnum","qLibraryId":"PgQKNQ","qNumFormat":{"qDec":".","qFmt":"###0","qType":"I","qnDec":0,"qUseThou":1}}],"dimensions":[{"field":"Neighborhood","title":"Neighborhood","qLibraryId":"PgQKNQ"}],"selections":[{"count":2,"field":"SalesTerritoryCountry","selectedSummary":"[ Germany, Australia ]"}],"conditionBase":{"id":"5f31c6e8476ae50001030fb6","type":"compound","appId":"4xQ1chLoHkOikyzUGcHJquteNrAfketW","created":"2006-01-02T15:04:05Z07:00","ownerId":"EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA","updated":"2006-01-02T14:04:05Z07:00","tenantId":"5GI7yWoJk9lvNtuEc66SXCypXVfhbVeH","bookmarkId":"anTjnOABmxlCirVx8IRfhWhLd9IZjENl","createdById":"EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA","description":"My condition","lastReloadTime":"2006-01-02T15:04:05Z07:00"},"conditionData":{}},"compoundCondition":{"data":{"history":{"enabled":true},"conditions":["rDDAcMEI1V0qzauEWepEVY8oSLJ9fvA2","qFPF1dAtPK4vfPTmKyyuKaqA6iERCwLi","4gnz8E6ZruG0lkSKwkau66P24CtORyLr","ATs--Z0b_NGyuHajcbQkxu7RrajgPaEQ"],"expression":"($0 OR $1) AND ($2 OR $3)"},"conditionBase":{"id":"5f31c6e8476ae50001030fb6","type":"compound","appId":"4xQ1chLoHkOikyzUGcHJquteNrAfketW","created":"2006-01-02T15:04:05Z07:00","ownerId":"EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA","updated":"2006-01-02T14:04:05Z07:00","tenantId":"5GI7yWoJk9lvNtuEc66SXCypXVfhbVeH","bookmarkId":"anTjnOABmxlCirVx8IRfhWhLd9IZjENl","createdById":"EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA","description":"My condition","lastReloadTime":"2006-01-02T15:04:05Z07:00"}}}'
Request POST /v1/conditions
{
"type": "compound",
"dataCondition": {
"headers": [
"sumnum"
],
"history": {
"enabled": true
},
"measures": [
{
"title": "sumnum",
"qLibraryId": "PgQKNQ",
"qNumFormat": {
"qDec": ".",
"qFmt": "###0",
"qType": "I",
"qnDec": 0,
"qUseThou": 1
}
}
],
"dimensions": [
{
"field": "Neighborhood",
"title": "Neighborhood",
"qLibraryId": "PgQKNQ"
}
],
"selections": [
{
"count": 2,
"field": "SalesTerritoryCountry",
"selectedSummary": "[ Germany, Australia ]"
}
],
"conditionBase": {
"id": "5f31c6e8476ae50001030fb6",
"type": "compound",
"appId": "4xQ1chLoHkOikyzUGcHJquteNrAfketW",
"created": "2006-01-02T15:04:05Z07:00",
"ownerId": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
"updated": "2006-01-02T14:04:05Z07:00",
"tenantId": "5GI7yWoJk9lvNtuEc66SXCypXVfhbVeH",
"bookmarkId": "anTjnOABmxlCirVx8IRfhWhLd9IZjENl",
"createdById": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
"description": "My condition",
"lastReloadTime": "2006-01-02T15:04:05Z07:00"
},
"conditionData": {}
},
"compoundCondition": {
"data": {
"history": {
"enabled": true
},
"conditions": [
"rDDAcMEI1V0qzauEWepEVY8oSLJ9fvA2",
"qFPF1dAtPK4vfPTmKyyuKaqA6iERCwLi",
"4gnz8E6ZruG0lkSKwkau66P24CtORyLr",
"ATs--Z0b_NGyuHajcbQkxu7RrajgPaEQ"
],
"expression": "($0 OR $1) AND ($2 OR $3)"
},
"conditionBase": {
"id": "5f31c6e8476ae50001030fb6",
"type": "compound",
"appId": "4xQ1chLoHkOikyzUGcHJquteNrAfketW",
"created": "2006-01-02T15:04:05Z07:00",
"ownerId": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
"updated": "2006-01-02T14:04:05Z07:00",
"tenantId": "5GI7yWoJk9lvNtuEc66SXCypXVfhbVeH",
"bookmarkId": "anTjnOABmxlCirVx8IRfhWhLd9IZjENl",
"createdById": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
"description": "My condition",
"lastReloadTime": "2006-01-02T15:04:05Z07:00"
}
}
}
Response POST /v1/conditions
{
"errors": [
{
"code": "string",
"meta": {},
"title": "string",
"detail": "string"
}
],
"condition": {
"type": "compound",
"ownerId": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
"tenantId": "5GI7yWoJk9lvNtuEc66SXCypXVfhbVeH",
"dataCondition": {
"headers": [
"sumnum"
],
"history": {
"enabled": true
},
"measures": [
{
"title": "sumnum",
"qLibraryId": "PgQKNQ",
"qNumFormat": {
"qDec": ".",
"qFmt": "###0",
"qType": "I",
"qnDec": 0,
"qUseThou": 1
}
}
],
"dimensions": [
{
"field": "Neighborhood",
"title": "Neighborhood",
"qLibraryId": "PgQKNQ"
}
],
"selections": [
{
"count": 2,
"field": "SalesTerritoryCountry",
"selectedSummary": "[ Germany, Australia ]"
}
],
"conditionBase": {
"id": "5f31c6e8476ae50001030fb6",
"type": "compound",
"appId": "4xQ1chLoHkOikyzUGcHJquteNrAfketW",
"created": "2006-01-02T15:04:05Z07:00",
"ownerId": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
"updated": "2006-01-02T14:04:05Z07:00",
"tenantId": "5GI7yWoJk9lvNtuEc66SXCypXVfhbVeH",
"bookmarkId": "anTjnOABmxlCirVx8IRfhWhLd9IZjENl",
"createdById": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
"description": "My condition",
"lastReloadTime": "2006-01-02T15:04:05Z07:00"
},
"conditionData": {}
},
"compoundCondition": {
"data": {
"history": {
"enabled": true
},
"conditions": [
"rDDAcMEI1V0qzauEWepEVY8oSLJ9fvA2",
"qFPF1dAtPK4vfPTmKyyuKaqA6iERCwLi",
"4gnz8E6ZruG0lkSKwkau66P24CtORyLr",
"ATs--Z0b_NGyuHajcbQkxu7RrajgPaEQ"
],
"expression": "($0 OR $1) AND ($2 OR $3)"
},
"conditionBase": {
"id": "5f31c6e8476ae50001030fb6",
"type": "compound",
"appId": "4xQ1chLoHkOikyzUGcHJquteNrAfketW",
"created": "2006-01-02T15:04:05Z07:00",
"ownerId": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
"updated": "2006-01-02T14:04:05Z07:00",
"tenantId": "5GI7yWoJk9lvNtuEc66SXCypXVfhbVeH",
"bookmarkId": "anTjnOABmxlCirVx8IRfhWhLd9IZjENl",
"createdById": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
"description": "My condition",
"lastReloadTime": "2006-01-02T15:04:05Z07:00"
}
}
}
}
Retrieve a specific condition by id.
Facts GET /v1/conditions/{id}
Rate limit | Tier 1 (1000 requests per minute) |
Path Parameters GET /v1/conditions/{id}
id string<uid> | The id of the condition |
Responses GET /v1/conditions/{id}
200 optional, application/json | The condition |
404 optional, application/json | Resource does not exist. |
default optional, application/json | Error response. |
GET/v1/conditions/{id}
curl "https://your-tenant.us.qlikcloud.com/api/v1/conditions/{id}" \
-H "Authorization: Bearer <API-key>"
Response GET /v1/conditions/{id}
{
"type": "compound",
"ownerId": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
"tenantId": "5GI7yWoJk9lvNtuEc66SXCypXVfhbVeH",
"dataCondition": {
"headers": [
"sumnum"
],
"history": {
"enabled": true
},
"measures": [
{
"title": "sumnum",
"qLibraryId": "PgQKNQ",
"qNumFormat": {
"qDec": ".",
"qFmt": "###0",
"qType": "I",
"qnDec": 0,
"qUseThou": 1
}
}
],
"dimensions": [
{
"field": "Neighborhood",
"title": "Neighborhood",
"qLibraryId": "PgQKNQ"
}
],
"selections": [
{
"count": 2,
"field": "SalesTerritoryCountry",
"selectedSummary": "[ Germany, Australia ]"
}
],
"conditionBase": {
"id": "5f31c6e8476ae50001030fb6",
"type": "compound",
"appId": "4xQ1chLoHkOikyzUGcHJquteNrAfketW",
"created": "2006-01-02T15:04:05Z07:00",
"ownerId": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
"updated": "2006-01-02T14:04:05Z07:00",
"tenantId": "5GI7yWoJk9lvNtuEc66SXCypXVfhbVeH",
"bookmarkId": "anTjnOABmxlCirVx8IRfhWhLd9IZjENl",
"createdById": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
"description": "My condition",
"lastReloadTime": "2006-01-02T15:04:05Z07:00"
},
"conditionData": {}
},
"compoundCondition": {
"data": {
"history": {
"enabled": true
},
"conditions": [
"rDDAcMEI1V0qzauEWepEVY8oSLJ9fvA2",
"qFPF1dAtPK4vfPTmKyyuKaqA6iERCwLi",
"4gnz8E6ZruG0lkSKwkau66P24CtORyLr",
"ATs--Z0b_NGyuHajcbQkxu7RrajgPaEQ"
],
"expression": "($0 OR $1) AND ($2 OR $3)"
},
"conditionBase": {
"id": "5f31c6e8476ae50001030fb6",
"type": "compound",
"appId": "4xQ1chLoHkOikyzUGcHJquteNrAfketW",
"created": "2006-01-02T15:04:05Z07:00",
"ownerId": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
"updated": "2006-01-02T14:04:05Z07:00",
"tenantId": "5GI7yWoJk9lvNtuEc66SXCypXVfhbVeH",
"bookmarkId": "anTjnOABmxlCirVx8IRfhWhLd9IZjENl",
"createdById": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
"description": "My condition",
"lastReloadTime": "2006-01-02T15:04:05Z07:00"
}
}
}
Patch values in the condition
Facts PATCH /v1/conditions/{id}
Rate limit | Tier 2 (100 requests per minute) |
Path Parameters PATCH /v1/conditions/{id}
id string<uid> | The id of the condition |
Request Body PATCH /v1/conditions/{id}
optional, application/json | No description |
Responses PATCH /v1/conditions/{id}
204 optional object | The condition was updated |
400 optional, application/json | A path or value was invalid |
404 optional, application/json | Resource does not exist. |
default optional, application/json | Error response |
PATCH/v1/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"}]'
Request PATCH /v1/conditions/{id}
[
{
"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"
}
]
Delete the condition
Facts DELETE /v1/conditions/{id}
Rate limit | Tier 2 (100 requests per minute) |
Path Parameters DELETE /v1/conditions/{id}
id string<uid> | The id of the condition |
Responses DELETE /v1/conditions/{id}
204 optional object | The record was deleted. |
404 optional, application/json | Resource does not exist. |
default optional, application/json | Error response |
DELETE/v1/conditions/{id}
curl "https://your-tenant.us.qlikcloud.com/api/v1/conditions/{id}" \
-X DELETE \
-H "Authorization: Bearer <API-key>"
Executes the condition
Facts POST /v1/conditions/{id}/evaluations
Rate limit | Tier 2 (100 requests per minute) |
Path Parameters POST /v1/conditions/{id}/evaluations
id string<uid> | The id of the condition |
Request Body POST /v1/conditions/{id}/evaluations
application/json | No description |
Responses POST /v1/conditions/{id}/evaluations
201 optional, application/json | Condition evaluation created |
400 optional, application/json | Bad request body |
500 optional, application/json | Internal server error. |
default optional, application/json | Error response. |
POST/v1/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 '{"alertId":"5f64885b2e11d23982c09e03","contextId":"795c75ba-7812-4c8f-9ced-551b6b006183","causalEvent":{"data":{"eventID":"string","lastReloadTime":"2006-01-02T15:04:05Z07:00"},"eventID":"string","extensions":{"userID":"string","tenantID":"string","sessionID":"string"},"manualTrigger":true,"manualTriggerID":"string"}}'
Request POST /v1/conditions/{id}/evaluations
{
"alertId": "5f64885b2e11d23982c09e03",
"contextId": "795c75ba-7812-4c8f-9ced-551b6b006183",
"causalEvent": {
"data": {
"eventID": "string",
"lastReloadTime": "2006-01-02T15:04:05Z07:00"
},
"eventID": "string",
"extensions": {
"userID": "string",
"tenantID": "string",
"sessionID": "string"
},
"manualTrigger": true,
"manualTriggerID": "string"
}
}
Response POST /v1/conditions/{id}/evaluations
{
"errors": [
{
"code": "string",
"meta": {},
"title": "string",
"detail": "string"
}
],
"contextId": "795c75ba-7812-4c8f-9ced-551b6b006183",
"evaluationId": "795c75ba-7812-4c8f-9ced-551b6b006183"
}
Get an Evaluation
Facts GET /v1/conditions/{id}/evaluations/{evaluationId}
Rate limit | Tier 1 (1000 requests per minute) |
Path Parameters GET /v1/conditions/{id}/evaluations/{evaluationId}
evaluationId string<uid> | The id of the evaluation |
id string<uid> | The id of the condition |
Responses GET /v1/conditions/{id}/evaluations/{evaluationId}
200 optional, application/json | The evaluation |
404 optional, application/json | Resource does not exist. |
default optional, application/json | Error response. |
GET/v1/conditions/{id}/evaluations/{evaluationId}
curl "https://your-tenant.us.qlikcloud.com/api/v1/conditions/{id}/evaluations/{evaluationId}" \
-H "Authorization: Bearer <API-key>"
Response GET /v1/conditions/{id}/evaluations/{evaluationId}
{
"condition": {
"type": "compound",
"ownerId": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
"tenantId": "5GI7yWoJk9lvNtuEc66SXCypXVfhbVeH",
"dataCondition": {
"headers": [
"sumnum"
],
"history": {
"enabled": true
},
"measures": [
{
"title": "sumnum",
"qLibraryId": "PgQKNQ",
"qNumFormat": {
"qDec": ".",
"qFmt": "###0",
"qType": "I",
"qnDec": 0,
"qUseThou": 1
}
}
],
"dimensions": [
{
"field": "Neighborhood",
"title": "Neighborhood",
"qLibraryId": "PgQKNQ"
}
],
"selections": [
{
"count": 2,
"field": "SalesTerritoryCountry",
"selectedSummary": "[ Germany, Australia ]"
}
],
"conditionBase": {
"id": "5f31c6e8476ae50001030fb6",
"type": "compound",
"appId": "4xQ1chLoHkOikyzUGcHJquteNrAfketW",
"created": "2006-01-02T15:04:05Z07:00",
"ownerId": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
"updated": "2006-01-02T14:04:05Z07:00",
"tenantId": "5GI7yWoJk9lvNtuEc66SXCypXVfhbVeH",
"bookmarkId": "anTjnOABmxlCirVx8IRfhWhLd9IZjENl",
"createdById": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
"description": "My condition",
"lastReloadTime": "2006-01-02T15:04:05Z07:00"
},
"conditionData": {}
},
"compoundCondition": {
"data": {
"history": {
"enabled": true
},
"conditions": [
"rDDAcMEI1V0qzauEWepEVY8oSLJ9fvA2",
"qFPF1dAtPK4vfPTmKyyuKaqA6iERCwLi",
"4gnz8E6ZruG0lkSKwkau66P24CtORyLr",
"ATs--Z0b_NGyuHajcbQkxu7RrajgPaEQ"
],
"expression": "($0 OR $1) AND ($2 OR $3)"
},
"conditionBase": {
"id": "5f31c6e8476ae50001030fb6",
"type": "compound",
"appId": "4xQ1chLoHkOikyzUGcHJquteNrAfketW",
"created": "2006-01-02T15:04:05Z07:00",
"ownerId": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
"updated": "2006-01-02T14:04:05Z07:00",
"tenantId": "5GI7yWoJk9lvNtuEc66SXCypXVfhbVeH",
"bookmarkId": "anTjnOABmxlCirVx8IRfhWhLd9IZjENl",
"createdById": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
"description": "My condition",
"lastReloadTime": "2006-01-02T15:04:05Z07:00"
}
}
},
"evaluation": {
"id": "string",
"errors": [
{
"code": "string",
"meta": {
"fatal": true
},
"title": "string"
}
],
"result": true,
"status": "RUNNING",
"alertId": "5f64885b2e11d23982c09e03",
"endTime": "string",
"ownerId": "string",
"retries": 0,
"tenantId": "string",
"condition": {
"type": "compound",
"ownerId": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
"tenantId": "5GI7yWoJk9lvNtuEc66SXCypXVfhbVeH",
"dataCondition": {
"headers": [
"sumnum"
],
"history": {
"enabled": true
},
"measures": [
{
"title": "sumnum",
"qLibraryId": "PgQKNQ",
"qNumFormat": {
"qDec": ".",
"qFmt": "###0",
"qType": "I",
"qnDec": 0,
"qUseThou": 1
}
}
],
"dimensions": [
{
"field": "Neighborhood",
"title": "Neighborhood",
"qLibraryId": "PgQKNQ"
}
],
"selections": [
{
"count": 2,
"field": "SalesTerritoryCountry",
"selectedSummary": "[ Germany, Australia ]"
}
],
"conditionBase": {
"id": "5f31c6e8476ae50001030fb6",
"type": "compound",
"appId": "4xQ1chLoHkOikyzUGcHJquteNrAfketW",
"created": "2006-01-02T15:04:05Z07:00",
"ownerId": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
"updated": "2006-01-02T14:04:05Z07:00",
"tenantId": "5GI7yWoJk9lvNtuEc66SXCypXVfhbVeH",
"bookmarkId": "anTjnOABmxlCirVx8IRfhWhLd9IZjENl",
"createdById": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
"description": "My condition",
"lastReloadTime": "2006-01-02T15:04:05Z07:00"
},
"conditionData": {}
},
"compoundCondition": {
"data": {
"history": {
"enabled": true
},
"conditions": [
"rDDAcMEI1V0qzauEWepEVY8oSLJ9fvA2",
"qFPF1dAtPK4vfPTmKyyuKaqA6iERCwLi",
"4gnz8E6ZruG0lkSKwkau66P24CtORyLr",
"ATs--Z0b_NGyuHajcbQkxu7RrajgPaEQ"
],
"expression": "($0 OR $1) AND ($2 OR $3)"
},
"conditionBase": {
"id": "5f31c6e8476ae50001030fb6",
"type": "compound",
"appId": "4xQ1chLoHkOikyzUGcHJquteNrAfketW",
"created": "2006-01-02T15:04:05Z07:00",
"ownerId": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
"updated": "2006-01-02T14:04:05Z07:00",
"tenantId": "5GI7yWoJk9lvNtuEc66SXCypXVfhbVeH",
"bookmarkId": "anTjnOABmxlCirVx8IRfhWhLd9IZjENl",
"createdById": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
"description": "My condition",
"lastReloadTime": "2006-01-02T15:04:05Z07:00"
}
}
},
"contextId": "string",
"startTime": "string",
"resultData": {},
"causalEvent": {},
"conditionId": "string",
"retryPolicy": "NONE",
"reloadEndTime": "string",
"byokMigrationId": "string",
"removalErrorCount": 3,
"dataConditionEvaluatorId": "string"
}
}
Delete an Evaluation
Facts DELETE /v1/conditions/{id}/evaluations/{evaluationId}
Rate limit | Tier 2 (100 requests per minute) |
Path Parameters DELETE /v1/conditions/{id}/evaluations/{evaluationId}
evaluationId string<uid> | The id of the evaluation |
id string<uid> | The id of the condition |
Responses DELETE /v1/conditions/{id}/evaluations/{evaluationId}
204 optional object | The evaluation was deleted |
404 optional, application/json | Resource does not exist. |
default optional, application/json | Error response |
DELETE/v1/conditions/{id}/evaluations/{evaluationId}
curl "https://your-tenant.us.qlikcloud.com/api/v1/conditions/{id}/evaluations/{evaluationId}" \
-X DELETE \
-H "Authorization: Bearer <API-key>"
Create condition preview request\
Create condition preview request.
Facts POST /v1/conditions/previews
Rate limit | Tier 2 (100 requests per minute) |
Request Body POST /v1/conditions/previews
application/json | Create condition preview request |
Responses POST /v1/conditions/previews
201 optional, application/json | Condition preview request created. |
400 optional, application/json | Bad request body |
500 optional, application/json | Internal server error. |
default optional, application/json | Error response. |
POST/v1/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","dataCondition":{"headers":["sumnum"],"history":{"enabled":true},"measures":[{"title":"sumnum","qLibraryId":"PgQKNQ","qNumFormat":{"qDec":".","qFmt":"###0","qType":"I","qnDec":0,"qUseThou":1}}],"dimensions":[{"field":"Neighborhood","title":"Neighborhood","qLibraryId":"PgQKNQ"}],"selections":[{"count":2,"field":"SalesTerritoryCountry","selectedSummary":"[ Germany, Australia ]"}],"conditionBase":{"id":"5f31c6e8476ae50001030fb6","type":"compound","appId":"4xQ1chLoHkOikyzUGcHJquteNrAfketW","created":"2006-01-02T15:04:05Z07:00","ownerId":"EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA","updated":"2006-01-02T14:04:05Z07:00","tenantId":"5GI7yWoJk9lvNtuEc66SXCypXVfhbVeH","bookmarkId":"anTjnOABmxlCirVx8IRfhWhLd9IZjENl","createdById":"EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA","description":"My condition","lastReloadTime":"2006-01-02T15:04:05Z07:00"},"conditionData":{}},"compoundCondition":{"data":{"history":{"enabled":true},"conditions":["rDDAcMEI1V0qzauEWepEVY8oSLJ9fvA2","qFPF1dAtPK4vfPTmKyyuKaqA6iERCwLi","4gnz8E6ZruG0lkSKwkau66P24CtORyLr","ATs--Z0b_NGyuHajcbQkxu7RrajgPaEQ"],"expression":"($0 OR $1) AND ($2 OR $3)"},"conditionBase":{"id":"5f31c6e8476ae50001030fb6","type":"compound","appId":"4xQ1chLoHkOikyzUGcHJquteNrAfketW","created":"2006-01-02T15:04:05Z07:00","ownerId":"EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA","updated":"2006-01-02T14:04:05Z07:00","tenantId":"5GI7yWoJk9lvNtuEc66SXCypXVfhbVeH","bookmarkId":"anTjnOABmxlCirVx8IRfhWhLd9IZjENl","createdById":"EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA","description":"My condition","lastReloadTime":"2006-01-02T15:04:05Z07:00"}}}'
Request POST /v1/conditions/previews
{
"type": "compound",
"dataCondition": {
"headers": [
"sumnum"
],
"history": {
"enabled": true
},
"measures": [
{
"title": "sumnum",
"qLibraryId": "PgQKNQ",
"qNumFormat": {
"qDec": ".",
"qFmt": "###0",
"qType": "I",
"qnDec": 0,
"qUseThou": 1
}
}
],
"dimensions": [
{
"field": "Neighborhood",
"title": "Neighborhood",
"qLibraryId": "PgQKNQ"
}
],
"selections": [
{
"count": 2,
"field": "SalesTerritoryCountry",
"selectedSummary": "[ Germany, Australia ]"
}
],
"conditionBase": {
"id": "5f31c6e8476ae50001030fb6",
"type": "compound",
"appId": "4xQ1chLoHkOikyzUGcHJquteNrAfketW",
"created": "2006-01-02T15:04:05Z07:00",
"ownerId": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
"updated": "2006-01-02T14:04:05Z07:00",
"tenantId": "5GI7yWoJk9lvNtuEc66SXCypXVfhbVeH",
"bookmarkId": "anTjnOABmxlCirVx8IRfhWhLd9IZjENl",
"createdById": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
"description": "My condition",
"lastReloadTime": "2006-01-02T15:04:05Z07:00"
},
"conditionData": {}
},
"compoundCondition": {
"data": {
"history": {
"enabled": true
},
"conditions": [
"rDDAcMEI1V0qzauEWepEVY8oSLJ9fvA2",
"qFPF1dAtPK4vfPTmKyyuKaqA6iERCwLi",
"4gnz8E6ZruG0lkSKwkau66P24CtORyLr",
"ATs--Z0b_NGyuHajcbQkxu7RrajgPaEQ"
],
"expression": "($0 OR $1) AND ($2 OR $3)"
},
"conditionBase": {
"id": "5f31c6e8476ae50001030fb6",
"type": "compound",
"appId": "4xQ1chLoHkOikyzUGcHJquteNrAfketW",
"created": "2006-01-02T15:04:05Z07:00",
"ownerId": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
"updated": "2006-01-02T14:04:05Z07:00",
"tenantId": "5GI7yWoJk9lvNtuEc66SXCypXVfhbVeH",
"bookmarkId": "anTjnOABmxlCirVx8IRfhWhLd9IZjENl",
"createdById": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
"description": "My condition",
"lastReloadTime": "2006-01-02T15:04:05Z07:00"
}
}
}
Response POST /v1/conditions/previews
{
"previewId": "467ea9bc-bbd7-11ea-b3de-0242ac130004"
}
Get condition preview response
Get condition preview response.
Facts GET /v1/conditions/previews/{id}
Rate limit | Tier 1 (1000 requests per minute) |
Path Parameters GET /v1/conditions/previews/{id}
id string<uid> | The id of the condition |
Responses GET /v1/conditions/previews/{id}
200 optional, application/json | The evaluation |
400 optional, application/json | Bad request body |
404 optional, application/json | Resource does not exist. |
500 optional, application/json | Internal server error. |
default optional, application/json | Error response. |
GET/v1/conditions/previews/{id}
curl "https://your-tenant.us.qlikcloud.com/api/v1/conditions/previews/{id}" \
-H "Authorization: Bearer <API-key>"
Response GET /v1/conditions/previews/{id}
{
"errors": [
{
"code": "string",
"meta": {},
"title": "string",
"detail": "string"
}
],
"status": "ACCEPTED",
"condition": {
"type": "compound",
"ownerId": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
"tenantId": "5GI7yWoJk9lvNtuEc66SXCypXVfhbVeH",
"dataCondition": {
"headers": [
"sumnum"
],
"history": {
"enabled": true
},
"measures": [
{
"title": "sumnum",
"qLibraryId": "PgQKNQ",
"qNumFormat": {
"qDec": ".",
"qFmt": "###0",
"qType": "I",
"qnDec": 0,
"qUseThou": 1
}
}
],
"dimensions": [
{
"field": "Neighborhood",
"title": "Neighborhood",
"qLibraryId": "PgQKNQ"
}
],
"selections": [
{
"count": 2,
"field": "SalesTerritoryCountry",
"selectedSummary": "[ Germany, Australia ]"
}
],
"conditionBase": {
"id": "5f31c6e8476ae50001030fb6",
"type": "compound",
"appId": "4xQ1chLoHkOikyzUGcHJquteNrAfketW",
"created": "2006-01-02T15:04:05Z07:00",
"ownerId": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
"updated": "2006-01-02T14:04:05Z07:00",
"tenantId": "5GI7yWoJk9lvNtuEc66SXCypXVfhbVeH",
"bookmarkId": "anTjnOABmxlCirVx8IRfhWhLd9IZjENl",
"createdById": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
"description": "My condition",
"lastReloadTime": "2006-01-02T15:04:05Z07:00"
},
"conditionData": {}
},
"compoundCondition": {
"data": {
"history": {
"enabled": true
},
"conditions": [
"rDDAcMEI1V0qzauEWepEVY8oSLJ9fvA2",
"qFPF1dAtPK4vfPTmKyyuKaqA6iERCwLi",
"4gnz8E6ZruG0lkSKwkau66P24CtORyLr",
"ATs--Z0b_NGyuHajcbQkxu7RrajgPaEQ"
],
"expression": "($0 OR $1) AND ($2 OR $3)"
},
"conditionBase": {
"id": "5f31c6e8476ae50001030fb6",
"type": "compound",
"appId": "4xQ1chLoHkOikyzUGcHJquteNrAfketW",
"created": "2006-01-02T15:04:05Z07:00",
"ownerId": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
"updated": "2006-01-02T14:04:05Z07:00",
"tenantId": "5GI7yWoJk9lvNtuEc66SXCypXVfhbVeH",
"bookmarkId": "anTjnOABmxlCirVx8IRfhWhLd9IZjENl",
"createdById": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
"description": "My condition",
"lastReloadTime": "2006-01-02T15:04:05Z07:00"
}
}
},
"previewId": "467ea9bc-bbd7-11ea-b3de-0242ac130004",
"evaluation": {
"endTime": "string",
"ownerId": "string",
"tenantId": "string",
"resultUrl": "string",
"startTime": "string"
}
}
Retrieves condition manager settings
Lists api settings.
Facts GET /v1/conditions/settings
Rate limit | Tier 1 (1000 requests per minute) |
Responses GET /v1/conditions/settings
200 optional, application/json | The api settings have been successfully returned |
404 optional, application/json | Resource does not exist. |
500 optional, application/json | Internal server error. |
default optional, application/json | Error response. |
GET/v1/conditions/settings
curl "https://your-tenant.us.qlikcloud.com/api/v1/conditions/settings" \
-H "Authorization: Bearer <API-key>"
Response GET /v1/conditions/settings
{
"tenantId": "cgdsAumGmQ6l0Bi7CUKt9V8P_Y9GL0sC",
"enable-conditions": true
}
Updates condition manager settings
Updates API configuration. Accessible only by tenant admins.
Facts PUT /v1/conditions/settings
Rate limit | Tier 2 (100 requests per minute) |
Header Parameters PUT /v1/conditions/settings
Authorization optional string | The JWT used for authentication. Send the JWT in the AuthRequest header using the Bearer schema. |
Request Body PUT /v1/conditions/settings
application/json | Request for updating the api settings |
Responses PUT /v1/conditions/settings
204 optional object | api settings have been successfully updated. |
400 optional, application/json | Bad request body |
500 optional, application/json | Internal server error. |
default optional, application/json | Error response. |
PUT/v1/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}'
Request PUT /v1/conditions/settings
{
"enable-conditions": true
}
APISettings
objectProperties
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 |
APISettingsUpload
objectProperties
enable-conditions boolean | Whether API endpoints for condition manager are enabled |
CausalEvent
objectProperties
data optional | No description |
eventID optional string | the event id from eventing |
extensions optional | No description |
manualTrigger optional boolean | No description |
manualTriggerID optional string | the manual trigger id from eventing if present |
CausalEventData
objectProperties
eventID optional string | the event id from eventing service. |
lastReloadTime optional string<RFC3339> | The time of the last reload |
CausalEventExtensions
objectProperties
userID optional string | No description |
tenantID optional string | No description |
sessionID optional string | No description |
CompoundCondition
objectA condition made up of other conditions
Properties
data optional | Condition data |
conditionBase optional | A base condition |
CompoundCondition_data
objectCondition data
Properties
history optional | History properties |
conditions optional Array<string> | Array of condition ids |
expression optional string | Boolean expression made up of variable names defined from the conditions section |
Condition
objectonly one of compoundCondition or dataCondition should be set
Properties
type string | Indicates the condition type Enum: compound data |
ownerId optional string<uid> | UserID of the condition owner |
tenantId optional string<uid> | The tenant id |
dataCondition optional | A condition based on data within an app |
compoundCondition optional | A condition made up of other conditions |
ConditionBase
objectA base condition
Properties
id optional string<uid> | The unique id for the resource |
type optional string | Indicates the condition type Enum: compound data |
appId optional string | The id of the app the condition is evaluated against |
created optional string<string> | When the resource was created |
ownerId optional string<uid> | The id of the user the user which owns the condition |
updated optional string<string> | When the resource was last updated |
tenantId optional string<uid> | The tenant id |
bookmarkId optional string | The bookmark corresponding to the selection state to apply to the app at evaluation time |
createdById optional string<uid> | The id of the user which created the condition |
description optional string | Description of the condition |
lastReloadTime optional 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. |
ConditionCreateRequest
objectonly one of compoundCondition or dataCondition should be set
Properties
type string | Indicates the condition type Enum: compound data |
dataCondition optional | A condition based on data within an app |
compoundCondition optional | A condition made up of other conditions |
ConditionDimensions
Array<ConditionDimensions_inner>List of returned dimensions
Properties
field optional string | Field referred to the dimension where the selection is made. This may be used to generate deep links. |
title optional string | Dimension title |
qLibraryId optional string | Refers to a dimension stored in the library |
ConditionDimensions_inner
objectProperties
field optional string | Field referred to the dimension where the selection is made. This may be used to generate deep links. |
title optional string | Dimension title |
qLibraryId optional string | Refers to a dimension stored in the library |
ConditionHeaders
Array<string>List of header labels
ConditionMeasures
Array<ConditionMeasures_inner>List of returned measures
Properties
title optional string | Measure title |
qLibraryId optional string | Refers to a measure stored in the library |
qNumFormat optional object | Format of the field |
ConditionMeasures_inner
objectProperties
title optional string | Measure title |
qLibraryId optional string | Refers to a measure stored in the library |
qNumFormat optional object | Format of the field |
ConditionPatch
Array<ConditionPatch_inner>A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902.
Properties
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. |
ConditionPatch_inner
objectProperties
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. |
ConditionResponse
objectProperties
errors optional | No description |
condition optional | only one of compoundCondition or dataCondition should be set |
CreateEvaluationRequest
objectProperties
alertId optional string | The id of the alerting task the condition and evaluation is part of |
contextId string | Extra context information to carry through to the result if any |
causalEvent optional | No description |
CreateEvaluationResponse
objectProperties
errors optional | No description |
contextId optional string | Extra context information to carry through to the result if any |
evaluationId optional string | Extra context information to carry through to the result if any |
DataCondition
objectA condition based on data within an app
Properties
headers optional Array<string> | List of header labels |
history optional | History properties |
measures optional | List of returned measures |
dimensions optional | List of returned dimensions |
selections optional | List of fields according to the bookmark definition |
conditionBase optional | A base condition |
conditionData optional 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 |
DataConditionCreateRequest
objectA condition based on data within an app
Properties
headers optional Array<string> | List of header labels |
history optional | History properties |
measures optional | List of returned measures |
dimensions optional | List of returned dimensions |
selections optional | List of fields according to the bookmark definition |
conditionBase optional | A base condition |
conditionData optional 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 |
Error
objectProperties
code optional string | Error code specific to condition manager. |
meta optional object | No description |
title optional string | Error title. |
detail optional string | Error cause. |
ErrorResponse
objectProperties
errors optional | Array of errors |
traceId optional string | trace id |
Errors
Array<Error>Properties
code optional string | Error code specific to condition manager. |
meta optional object | No description |
title optional string | Error title. |
detail optional string | Error cause. |
Evaluation
objectProperties
id optional string<uid> | The unique id for the resource |
errors optional | No description |
result optional boolean | The final result of the evalution |
status optional string | The status of the evaluation execution Enum: RUNNING FAILED FINISHED DELETING |
alertId optional string | The id of the alerting task the condition and evaluation is part of |
endTime optional string<string> | The time the evaluation ended |
ownerId optional string<uid> | userId of user being impersonated to evaluate the condition |
retries optional integer | number of retries sent to DCE |
tenantId optional string<uid> | The tenant id |
condition optional | only one of compoundCondition or dataCondition should be set |
contextId optional string | Extra context information to carry through to the result if one was included on when the evaluation was triggered |
startTime optional string<string> | The time the evaluation started |
resultData optional object | Condition type specific result, one of dataResult or compoundResult |
causalEvent optional object | Representation of the event that caused the condition to be evaluated if one was included on when the evaluation was triggered |
conditionId optional string<uid> | The unique id of the associated condition |
retryPolicy optional string | what kind of retry policy this evaluation has Enum: NONE TOO_MANY_REQUESTS GENERIC_ERROR |
reloadEndTime optional string<string> | The time when the reload was completed in Engine |
byokMigrationId optional string | internal identifier used when migrating keys |
removalErrorCount optional integer | The number of times we have attempted to remove this evaluation data-file |
dataConditionEvaluatorId deprecated optional string<uid> | The unique id for the resource given from Data Condition Evaluator. |
EvaluationError
objectProperties
code optional string | Error code specific to condition smanager. |
meta optional | No description |
title optional string | Error title. |
status optional | Error status. |
EvaluationError_meta
objectProperties
fatal optional boolean | defines whether an error is recoverable or not |
EvaluationErrors
Array<EvaluationError>Properties
code optional string | Error code specific to condition smanager. |
meta optional | No description |
title optional string | Error title. |
status optional | Error status. |
GetEvaluationResponse
objectGet response returns the evaluation and condition associated
Properties
condition optional | only one of compoundCondition or dataCondition should be set |
evaluation optional | No description |
HistoryProperties
objectHistory properties
Properties
enabled optional boolean | Is history enabled |
PreviewEvaluation
objectProperties
endTime optional string<string> | The time the evaluation ended |
ownerId optional string<uid> | userId of user being impersonated to evaluate the condition |
tenantId optional string<uid> | The tenant id |
resultUrl optional string | URL to download the condition results |
startTime optional string<string> | The time the evaluation started |
PreviewResponse
objectProperties
previewId optional string<uid> | When the resource was created |
PreviewStatusResponse
objectProperties
errors optional | No description |
status optional string | No description Enum: ACCEPTED FAILED RUNNING SUCCESSFUL |
condition optional | only one of compoundCondition or dataCondition should be set |
previewId optional string<uid> | When the resource was created |
evaluation optional | No description |
Selections
Array<Selections_inner>List of fields according to the bookmark definition
Properties
count optional number | The count |
field optional string | Field name |
selectedSummary optional Array<string> | Array of selected |
Selections_inner
objectProperties
count optional number | The count |
field optional string | Field name |
selectedSummary optional Array<string> | Array of selected |
SingleErrorResponse
objectProperties
code optional string | Error code specific to condition manager. |
meta optional object | meta properties for an error. |
title optional string | Error title. |
detail optional string | Error cause. |