Conditions
Conditions is the resource representing a condition query based on data in a Qlik app.
Endpoints
- POST/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
Facts
| Rate limit | Tier 2 (100 requests per minute) |
| Categories | externalbuild |
Request Body
application/json
The condition create request definition.
only one of compoundCondition or dataCondition should be set
- application/jsonobject
only one of compoundCondition or dataCondition should be set
application/json properties
- typestringRequired
Indicates the condition type
Can be one of: "compound""data"
- dataConditionobject
A condition based on data within an app
dataCondition properties
- headersarray of strings
List of header labels
- historyobject
History properties
history properties
- enabledboolean
Is history enabled
-
- measuresarray of objects
List of returned measures
measures properties
- titlestring
Measure title
- qLibraryIdstring
Refers to a measure stored in the library
- qNumFormatobject
Format of the field
-
- dimensionsarray of objects
List of returned dimensions
dimensions properties
- fieldstring
Field referred to the dimension where the selection is made. This may be used to generate deep links.
- titlestring
Dimension title
- qLibraryIdstring
Refers to a dimension stored in the library
-
- selectionsarray of objects
List of fields according to the bookmark definition
selections properties
- countnumber
The count
- fieldstring
Field name
- selectedSummaryarray of strings
Array of selected
-
- conditionBaseobject
A base condition
conditionBase properties
- idstring
The unique id for the resource
- typestring
Indicates the condition type
Can be one of: "compound""data"
- appIdstring
The id of the app the condition is evaluated against
- createdstring
When the resource was created
- ownerIdstring
The id of the user the user which owns the condition
- updatedstring
When the resource was last updated
- tenantIdstring
The tenant id
- bookmarkIdstring
The bookmark corresponding to the selection state to apply to the app at evaluation time
- createdByIdstring
The id of the user which created the condition
- descriptionstring
Description of the condition
- lastReloadTimestring
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.
-
- conditionDataobject
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
-
- compoundConditionobject
A condition made up of other conditions
compoundCondition properties
- dataobject
Condition data
data properties
- historyobject
History properties
history properties
- enabledboolean
Is history enabled
-
- conditionsarray of strings
Array of condition ids
- expressionstring
Boolean expression made up of variable names defined from the conditions section
-
- conditionBaseobject
A base condition
conditionBase properties
- idstring
The unique id for the resource
- typestring
Indicates the condition type
Can be one of: "compound""data"
- appIdstring
The id of the app the condition is evaluated against
- createdstring
When the resource was created
- ownerIdstring
The id of the user the user which owns the condition
- updatedstring
When the resource was last updated
- tenantIdstring
The tenant id
- bookmarkIdstring
The bookmark corresponding to the selection state to apply to the app at evaluation time
- createdByIdstring
The id of the user which created the condition
- descriptionstring
Description of the condition
- lastReloadTimestring
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.
-
-
-
Responses
201
application/json
Condition created
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
Error code specific to condition manager.
- metaobject
- titlestring
Error title.
- detailstring
Error cause.
-
- conditionobject
only one of compoundCondition or dataCondition should be set
condition properties
- typestringRequired
Indicates the condition type
Can be one of: "compound""data"
- ownerIdstring
UserID of the condition owner
- tenantIdstring
The tenant id
- dataConditionobject
A condition based on data within an app
dataCondition properties
- headersarray of strings
List of header labels
- historyobject
History properties
history properties
- enabledboolean
Is history enabled
-
- measuresarray of objects
List of returned measures
measures properties
- titlestring
Measure title
- qLibraryIdstring
Refers to a measure stored in the library
- qNumFormatobject
Format of the field
-
- dimensionsarray of objects
List of returned dimensions
dimensions properties
- fieldstring
Field referred to the dimension where the selection is made. This may be used to generate deep links.
- titlestring
Dimension title
- qLibraryIdstring
Refers to a dimension stored in the library
-
- selectionsarray of objects
List of fields according to the bookmark definition
selections properties
- countnumber
The count
- fieldstring
Field name
- selectedSummaryarray of strings
Array of selected
-
- conditionBaseobject
A base condition
conditionBase properties
- idstring
The unique id for the resource
- typestring
Indicates the condition type
Can be one of: "compound""data"
- appIdstring
The id of the app the condition is evaluated against
- createdstring
When the resource was created
- ownerIdstring
The id of the user the user which owns the condition
- updatedstring
When the resource was last updated
- tenantIdstring
The tenant id
- bookmarkIdstring
The bookmark corresponding to the selection state to apply to the app at evaluation time
- createdByIdstring
The id of the user which created the condition
- descriptionstring
Description of the condition
- lastReloadTimestring
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.
-
- conditionDataobject
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
-
- compoundConditionobject
A condition made up of other conditions
compoundCondition properties
- dataobject
Condition data
data properties
- historyobject
History properties
history properties
- enabledboolean
Is history enabled
-
- conditionsarray of strings
Array of condition ids
- expressionstring
Boolean expression made up of variable names defined from the conditions section
-
- conditionBaseobject
A base condition
conditionBase properties
- idstring
The unique id for the resource
- typestring
Indicates the condition type
Can be one of: "compound""data"
- appIdstring
The id of the app the condition is evaluated against
- createdstring
When the resource was created
- ownerIdstring
The id of the user the user which owns the condition
- updatedstring
When the resource was last updated
- tenantIdstring
The tenant id
- bookmarkIdstring
The bookmark corresponding to the selection state to apply to the app at evaluation time
- createdByIdstring
The id of the user which created the condition
- descriptionstring
Description of the condition
- lastReloadTimestring
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.
-
-
-
-
400
application/json
Bad request body
- application/jsonobject
application/json properties
- errorsarray of objects
Array of errors
errors properties
- codestring
Error code specific to condition manager.
- metaobject
meta properties for an error.
- titlestring
Error title.
- detailstring
Error cause.
-
- traceIdstring
trace id
-
default
application/json
Error response.
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
trace id
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/conditions" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-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"}}}'
const https = require('https')
const data = JSON.stringify({"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"}}})
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/conditions',
'method': 'POST',
'headers': {
'Content-type': 'application/json',
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
req.write(data)
This API is not included yet in qlik-cli
Request
{
"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
{
"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"
}
}
}
}
Facts
| Rate limit | Tier 1 (1000 requests per minute) |
| Categories | externalbuild |
Path Parameters
- idstringRequired
The id of the condition
Responses
200
application/json
The condition
only one of compoundCondition or dataCondition should be set
- application/jsonobject
only one of compoundCondition or dataCondition should be set
application/json properties
- typestringRequired
Indicates the condition type
Can be one of: "compound""data"
- ownerIdstring
UserID of the condition owner
- tenantIdstring
The tenant id
- dataConditionobject
A condition based on data within an app
dataCondition properties
- headersarray of strings
List of header labels
- historyobject
History properties
history properties
- enabledboolean
Is history enabled
-
- measuresarray of objects
List of returned measures
measures properties
- titlestring
Measure title
- qLibraryIdstring
Refers to a measure stored in the library
- qNumFormatobject
Format of the field
-
- dimensionsarray of objects
List of returned dimensions
dimensions properties
- fieldstring
Field referred to the dimension where the selection is made. This may be used to generate deep links.
- titlestring
Dimension title
- qLibraryIdstring
Refers to a dimension stored in the library
-
- selectionsarray of objects
List of fields according to the bookmark definition
selections properties
- countnumber
The count
- fieldstring
Field name
- selectedSummaryarray of strings
Array of selected
-
- conditionBaseobject
A base condition
conditionBase properties
- idstring
The unique id for the resource
- typestring
Indicates the condition type
Can be one of: "compound""data"
- appIdstring
The id of the app the condition is evaluated against
- createdstring
When the resource was created
- ownerIdstring
The id of the user the user which owns the condition
- updatedstring
When the resource was last updated
- tenantIdstring
The tenant id
- bookmarkIdstring
The bookmark corresponding to the selection state to apply to the app at evaluation time
- createdByIdstring
The id of the user which created the condition
- descriptionstring
Description of the condition
- lastReloadTimestring
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.
-
- conditionDataobject
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
-
- compoundConditionobject
A condition made up of other conditions
compoundCondition properties
- dataobject
Condition data
data properties
- historyobject
History properties
history properties
- enabledboolean
Is history enabled
-
- conditionsarray of strings
Array of condition ids
- expressionstring
Boolean expression made up of variable names defined from the conditions section
-
- conditionBaseobject
A base condition
conditionBase properties
- idstring
The unique id for the resource
- typestring
Indicates the condition type
Can be one of: "compound""data"
- appIdstring
The id of the app the condition is evaluated against
- createdstring
When the resource was created
- ownerIdstring
The id of the user the user which owns the condition
- updatedstring
When the resource was last updated
- tenantIdstring
The tenant id
- bookmarkIdstring
The bookmark corresponding to the selection state to apply to the app at evaluation time
- createdByIdstring
The id of the user which created the condition
- descriptionstring
Description of the condition
- lastReloadTimestring
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.
-
-
-
404
application/json
Resource does not exist.
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
trace id
-
default
application/json
Error response.
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
trace id
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/conditions/{id}" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/conditions/{id}',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
This API is not included yet in qlik-cli
Response
{
"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"
}
}
}
Facts
| Rate limit | Tier 2 (100 requests per minute) |
| Categories | externalbuild |
Path Parameters
- idstringRequired
The id of the condition
Request Body
application/json
A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902.
- application/jsonarray of objects
A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902.
application/json properties
- opstringRequired
The operation to be performed.
Can be one of: "replace""remove""add"
- pathstringRequired
The path for the given resource field to patch.
- valueobject
The value to be used for this operation.
-
Responses
204
The condition was updated
400
application/json
A path or value was invalid
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
trace id
-
404
application/json
Resource does not exist.
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
trace id
-
default
application/json
Error response
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
trace id
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/conditions/{id}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-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"}]'
const https = require('https')
const data = JSON.stringify([{"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"}])
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/conditions/{id}',
'method': 'PATCH',
'headers': {
'Content-type': 'application/json',
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
req.write(data)
This API is not included yet in qlik-cli
Request
[
{
"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"
}
]
Facts
| Rate limit | Tier 2 (100 requests per minute) |
| Categories | externalbuild |
Path Parameters
- idstringRequired
The id of the condition
Responses
204
The record was deleted.
404
application/json
Resource does not exist.
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
trace id
-
default
application/json
Error response
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
trace id
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/conditions/{id}" \
-X DELETE \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/conditions/{id}',
'method': 'DELETE',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
This API is not included yet in qlik-cli
Facts
| Rate limit | Tier 2 (100 requests per minute) |
| Categories | externalbuild |
Path Parameters
- idstringRequired
The id of the condition
Request Body
application/json
- application/jsonobject
application/json properties
- alertIdstring
The id of the alerting task the condition and evaluation is part of
- contextIdstringRequired
Extra context information to carry through to the result if any
- causalEventobjectRequired
causalEvent properties
- dataobject
data properties
- eventIDstring
the event id from eventing service.
- lastReloadTimestring
The time of the last reload
-
- eventIDstring
the event id from eventing
- extensionsobject
extensions properties
- userIDstring
- tenantIDstring
- sessionIDstring
-
- manualTriggerboolean
- manualTriggerIDstring
the manual trigger id from eventing if present
-
-
Responses
201
application/json
Condition evaluation created
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
Error code specific to condition manager.
- metaobject
- titlestring
Error title.
- detailstring
Error cause.
-
- contextIdstring
Extra context information to carry through to the result if any
- evaluationIdstring
Extra context information to carry through to the result if any
-
400
application/json
Bad request body
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
trace id
-
500
application/json
Internal server error.
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
trace id
-
default
application/json
Error response.
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
trace id
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/conditions/{id}/evaluations" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-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"}}'
const https = require('https')
const data = JSON.stringify({"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"}})
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/conditions/{id}/evaluations',
'method': 'POST',
'headers': {
'Content-type': 'application/json',
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
req.write(data)
This API is not included yet in qlik-cli
Request
{
"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
{
"errors": [
{
"code": "string",
"meta": {},
"title": "string",
"detail": "string"
}
],
"contextId": "795c75ba-7812-4c8f-9ced-551b6b006183",
"evaluationId": "795c75ba-7812-4c8f-9ced-551b6b006183"
}
Facts
| Rate limit | Tier 1 (1000 requests per minute) |
| Categories | externalbuild |
Path Parameters
- evaluationIdstringRequired
The id of the evaluation
- idstringRequired
The id of the condition
Responses
200
application/json
The evaluation
Get response returns the evaluation and condition associated
- application/jsonobject
Get response returns the evaluation and condition associated
application/json properties
- conditionobject
only one of compoundCondition or dataCondition should be set
condition properties
- typestringRequired
Indicates the condition type
Can be one of: "compound""data"
- ownerIdstring
UserID of the condition owner
- tenantIdstring
The tenant id
- dataConditionobject
A condition based on data within an app
dataCondition properties
- headersarray of strings
List of header labels
- historyobject
History properties
history properties
- enabledboolean
Is history enabled
-
- measuresarray of objects
List of returned measures
measures properties
- titlestring
Measure title
- qLibraryIdstring
Refers to a measure stored in the library
- qNumFormatobject
Format of the field
-
- dimensionsarray of objects
List of returned dimensions
dimensions properties
- fieldstring
Field referred to the dimension where the selection is made. This may be used to generate deep links.
- titlestring
Dimension title
- qLibraryIdstring
Refers to a dimension stored in the library
-
- selectionsarray of objects
List of fields according to the bookmark definition
selections properties
- countnumber
The count
- fieldstring
Field name
- selectedSummaryarray of strings
Array of selected
-
- conditionBaseobject
A base condition
conditionBase properties
- idstring
The unique id for the resource
- typestring
Indicates the condition type
Can be one of: "compound""data"
- appIdstring
The id of the app the condition is evaluated against
- createdstring
When the resource was created
- ownerIdstring
The id of the user the user which owns the condition
- updatedstring
When the resource was last updated
- tenantIdstring
The tenant id
- bookmarkIdstring
The bookmark corresponding to the selection state to apply to the app at evaluation time
- createdByIdstring
The id of the user which created the condition
- descriptionstring
Description of the condition
- lastReloadTimestring
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.
-
- conditionDataobject
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
-
- compoundConditionobject
A condition made up of other conditions
compoundCondition properties
- dataobject
Condition data
data properties
- historyobject
History properties
history properties
- enabledboolean
Is history enabled
-
- conditionsarray of strings
Array of condition ids
- expressionstring
Boolean expression made up of variable names defined from the conditions section
-
- conditionBaseobject
A base condition
conditionBase properties
- idstring
The unique id for the resource
- typestring
Indicates the condition type
Can be one of: "compound""data"
- appIdstring
The id of the app the condition is evaluated against
- createdstring
When the resource was created
- ownerIdstring
The id of the user the user which owns the condition
- updatedstring
When the resource was last updated
- tenantIdstring
The tenant id
- bookmarkIdstring
The bookmark corresponding to the selection state to apply to the app at evaluation time
- createdByIdstring
The id of the user which created the condition
- descriptionstring
Description of the condition
- lastReloadTimestring
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.
-
-
-
- evaluationobject
evaluation properties
- idstring
The unique id for the resource
- errorsarray of objects
errors properties
- codestring
Error code specific to condition smanager.
- metaobject
meta properties
- fatalboolean
defines whether an error is recoverable or not
-
- titlestring
Error title.
- statusany
Error status.
-
- resultboolean
The final result of the evalution
- statusstring
The status of the evaluation execution
Can be one of: "RUNNING""FAILED""FINISHED""DELETING"
- alertIdstring
The id of the alerting task the condition and evaluation is part of
- endTimestring
The time the evaluation ended
- ownerIdstring
userId of user being impersonated to evaluate the condition
- retriesinteger
number of retries sent to DCE
- tenantIdstring
The tenant id
- conditionobject
only one of compoundCondition or dataCondition should be set
condition properties
- typestringRequired
Indicates the condition type
Can be one of: "compound""data"
- ownerIdstring
UserID of the condition owner
- tenantIdstring
The tenant id
- dataConditionobject
A condition based on data within an app
dataCondition properties
- headersarray of strings
List of header labels
- historyobject
History properties
history properties
- enabledboolean
Is history enabled
-
- measuresarray of objects
List of returned measures
measures properties
- titlestring
Measure title
- qLibraryIdstring
Refers to a measure stored in the library
- qNumFormatobject
Format of the field
-
- dimensionsarray of objects
List of returned dimensions
dimensions properties
- fieldstring
Field referred to the dimension where the selection is made. This may be used to generate deep links.
- titlestring
Dimension title
- qLibraryIdstring
Refers to a dimension stored in the library
-
- selectionsarray of objects
List of fields according to the bookmark definition
selections properties
- countnumber
The count
- fieldstring
Field name
- selectedSummaryarray of strings
Array of selected
-
- conditionBaseobject
A base condition
conditionBase properties
- idstring
The unique id for the resource
- typestring
Indicates the condition type
Can be one of: "compound""data"
- appIdstring
The id of the app the condition is evaluated against
- createdstring
When the resource was created
- ownerIdstring
The id of the user the user which owns the condition
- updatedstring
When the resource was last updated
- tenantIdstring
The tenant id
- bookmarkIdstring
The bookmark corresponding to the selection state to apply to the app at evaluation time
- createdByIdstring
The id of the user which created the condition
- descriptionstring
Description of the condition
- lastReloadTimestring
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.
-
- conditionDataobject
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
-
- compoundConditionobject
A condition made up of other conditions
compoundCondition properties
- dataobject
Condition data
data properties
- historyobject
History properties
history properties
- enabledboolean
Is history enabled
-
- conditionsarray of strings
Array of condition ids
- expressionstring
Boolean expression made up of variable names defined from the conditions section
-
- conditionBaseobject
A base condition
conditionBase properties
- idstring
The unique id for the resource
- typestring
Indicates the condition type
Can be one of: "compound""data"
- appIdstring
The id of the app the condition is evaluated against
- createdstring
When the resource was created
- ownerIdstring
The id of the user the user which owns the condition
- updatedstring
When the resource was last updated
- tenantIdstring
The tenant id
- bookmarkIdstring
The bookmark corresponding to the selection state to apply to the app at evaluation time
- createdByIdstring
The id of the user which created the condition
- descriptionstring
Description of the condition
- lastReloadTimestring
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.
-
-
-
- contextIdstring
Extra context information to carry through to the result if one was included on when the evaluation was triggered
- startTimestring
The time the evaluation started
- resultDataobject
Condition type specific result, one of dataResult or compoundResult
- causalEventobject
Representation of the event that caused the condition to be evaluated if one was included on when the evaluation was triggered
- conditionIdstring
The unique id of the associated condition
- retryPolicystring
what kind of retry policy this evaluation has
Can be one of: "NONE""TOO_MANY_REQUESTS""GENERIC_ERROR"
- reloadEndTimestring
The time when the reload was completed in Engine
- byokMigrationIdstring
internal identifier used when migrating keys
- removalErrorCountinteger
The number of times we have attempted to remove this evaluation data-file
- dataConditionEvaluatorIdstringDeprecated
The unique id for the resource given from Data Condition Evaluator.
-
-
404
application/json
Resource does not exist.
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
trace id
-
default
application/json
Error response.
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
trace id
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/conditions/{id}/evaluations/{evaluationId}" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/conditions/{id}/evaluations/{evaluationId}',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
This API is not included yet in qlik-cli
Response
{
"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": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"errors": [
{
"code": "string",
"meta": {
"fatal": true
},
"title": "string"
}
],
"result": true,
"status": "RUNNING",
"alertId": "5f64885b2e11d23982c09e03",
"endTime": "string",
"ownerId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"retries": 42,
"tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"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": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"retryPolicy": "NONE",
"reloadEndTime": "string",
"byokMigrationId": "string",
"removalErrorCount": 3,
"dataConditionEvaluatorId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69"
}
}
Facts
| Rate limit | Tier 2 (100 requests per minute) |
| Categories | externalbuild |
Path Parameters
- evaluationIdstringRequired
The id of the evaluation
- idstringRequired
The id of the condition
Responses
204
The evaluation was deleted
404
application/json
Resource does not exist.
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
trace id
-
default
application/json
Error response
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
trace id
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/conditions/{id}/evaluations/{evaluationId}" \
-X DELETE \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/conditions/{id}/evaluations/{evaluationId}',
'method': 'DELETE',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
This API is not included yet in qlik-cli
Create condition preview request.
Facts
| Rate limit | Tier 2 (100 requests per minute) |
| Categories | externalbuild |
Request Body
application/json
Create condition preview request
only one of compoundCondition or dataCondition should be set
- application/jsonobject
only one of compoundCondition or dataCondition should be set
application/json properties
- typestringRequired
Indicates the condition type
Can be one of: "compound""data"
- dataConditionobject
A condition based on data within an app
dataCondition properties
- headersarray of strings
List of header labels
- historyobject
History properties
history properties
- enabledboolean
Is history enabled
-
- measuresarray of objects
List of returned measures
measures properties
- titlestring
Measure title
- qLibraryIdstring
Refers to a measure stored in the library
- qNumFormatobject
Format of the field
-
- dimensionsarray of objects
List of returned dimensions
dimensions properties
- fieldstring
Field referred to the dimension where the selection is made. This may be used to generate deep links.
- titlestring
Dimension title
- qLibraryIdstring
Refers to a dimension stored in the library
-
- selectionsarray of objects
List of fields according to the bookmark definition
selections properties
- countnumber
The count
- fieldstring
Field name
- selectedSummaryarray of strings
Array of selected
-
- conditionBaseobject
A base condition
conditionBase properties
- idstring
The unique id for the resource
- typestring
Indicates the condition type
Can be one of: "compound""data"
- appIdstring
The id of the app the condition is evaluated against
- createdstring
When the resource was created
- ownerIdstring
The id of the user the user which owns the condition
- updatedstring
When the resource was last updated
- tenantIdstring
The tenant id
- bookmarkIdstring
The bookmark corresponding to the selection state to apply to the app at evaluation time
- createdByIdstring
The id of the user which created the condition
- descriptionstring
Description of the condition
- lastReloadTimestring
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.
-
- conditionDataobject
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
-
- compoundConditionobject
A condition made up of other conditions
compoundCondition properties
- dataobject
Condition data
data properties
- historyobject
History properties
history properties
- enabledboolean
Is history enabled
-
- conditionsarray of strings
Array of condition ids
- expressionstring
Boolean expression made up of variable names defined from the conditions section
-
- conditionBaseobject
A base condition
conditionBase properties
- idstring
The unique id for the resource
- typestring
Indicates the condition type
Can be one of: "compound""data"
- appIdstring
The id of the app the condition is evaluated against
- createdstring
When the resource was created
- ownerIdstring
The id of the user the user which owns the condition
- updatedstring
When the resource was last updated
- tenantIdstring
The tenant id
- bookmarkIdstring
The bookmark corresponding to the selection state to apply to the app at evaluation time
- createdByIdstring
The id of the user which created the condition
- descriptionstring
Description of the condition
- lastReloadTimestring
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.
-
-
-
Responses
201
application/json
Condition preview request created.
- application/jsonobject
application/json properties
- previewIdstring
When the resource was created
-
400
application/json
Bad request body
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
trace id
-
500
application/json
Internal server error.
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
trace id
-
default
application/json
Error response.
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
trace id
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/conditions/previews" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-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"}}}'
const https = require('https')
const data = JSON.stringify({"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"}}})
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/conditions/previews',
'method': 'POST',
'headers': {
'Content-type': 'application/json',
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
req.write(data)
This API is not included yet in qlik-cli
Request
{
"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
{
"previewId": "467ea9bc-bbd7-11ea-b3de-0242ac130004"
}
Get condition preview response.
Facts
| Rate limit | Tier 1 (1000 requests per minute) |
| Categories | externalbuild |
Path Parameters
- idstringRequired
The id of the condition
Responses
200
application/json
The evaluation
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
Error code specific to condition manager.
- metaobject
- titlestring
Error title.
- detailstring
Error cause.
-
- statusstring
Can be one of: "ACCEPTED""FAILED""RUNNING""SUCCESSFUL"
- conditionobject
only one of compoundCondition or dataCondition should be set
condition properties
- typestringRequired
Indicates the condition type
Can be one of: "compound""data"
- ownerIdstring
UserID of the condition owner
- tenantIdstring
The tenant id
- dataConditionobject
A condition based on data within an app
dataCondition properties
- headersarray of strings
List of header labels
- historyobject
History properties
history properties
- enabledboolean
Is history enabled
-
- measuresarray of objects
List of returned measures
measures properties
- titlestring
Measure title
- qLibraryIdstring
Refers to a measure stored in the library
- qNumFormatobject
Format of the field
-
- dimensionsarray of objects
List of returned dimensions
dimensions properties
- fieldstring
Field referred to the dimension where the selection is made. This may be used to generate deep links.
- titlestring
Dimension title
- qLibraryIdstring
Refers to a dimension stored in the library
-
- selectionsarray of objects
List of fields according to the bookmark definition
selections properties
- countnumber
The count
- fieldstring
Field name
- selectedSummaryarray of strings
Array of selected
-
- conditionBaseobject
A base condition
conditionBase properties
- idstring
The unique id for the resource
- typestring
Indicates the condition type
Can be one of: "compound""data"
- appIdstring
The id of the app the condition is evaluated against
- createdstring
When the resource was created
- ownerIdstring
The id of the user the user which owns the condition
- updatedstring
When the resource was last updated
- tenantIdstring
The tenant id
- bookmarkIdstring
The bookmark corresponding to the selection state to apply to the app at evaluation time
- createdByIdstring
The id of the user which created the condition
- descriptionstring
Description of the condition
- lastReloadTimestring
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.
-
- conditionDataobject
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
-
- compoundConditionobject
A condition made up of other conditions
compoundCondition properties
- dataobject
Condition data
data properties
- historyobject
History properties
history properties
- enabledboolean
Is history enabled
-
- conditionsarray of strings
Array of condition ids
- expressionstring
Boolean expression made up of variable names defined from the conditions section
-
- conditionBaseobject
A base condition
conditionBase properties
- idstring
The unique id for the resource
- typestring
Indicates the condition type
Can be one of: "compound""data"
- appIdstring
The id of the app the condition is evaluated against
- createdstring
When the resource was created
- ownerIdstring
The id of the user the user which owns the condition
- updatedstring
When the resource was last updated
- tenantIdstring
The tenant id
- bookmarkIdstring
The bookmark corresponding to the selection state to apply to the app at evaluation time
- createdByIdstring
The id of the user which created the condition
- descriptionstring
Description of the condition
- lastReloadTimestring
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.
-
-
-
- previewIdstring
When the resource was created
- evaluationobject
evaluation properties
- endTimestring
The time the evaluation ended
- ownerIdstring
userId of user being impersonated to evaluate the condition
- tenantIdstring
The tenant id
- resultUrlstring
URL to download the condition results
- startTimestring
The time the evaluation started
-
-
400
application/json
Bad request body
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
trace id
-
404
application/json
Resource does not exist.
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
trace id
-
500
application/json
Internal server error.
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
trace id
-
default
application/json
Error response.
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
trace id
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/conditions/previews/{id}" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/conditions/previews/{id}',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
This API is not included yet in qlik-cli
Response
{
"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": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"resultUrl": "string",
"startTime": "string"
}
}
Lists api settings.
Facts
| Rate limit | Tier 1 (1000 requests per minute) |
| Categories | externalbuild |
Responses
200
application/json
The api settings have been successfully returned
- application/jsonobject
application/json properties
- tenantIdstring
These persisted api settings are only available for this tenant. Extracted from request JWT.
- enable-conditionsbooleanRequired
Whether API endpoints for condition manager are enabled
-
404
application/json
Resource does not exist.
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
trace id
-
500
application/json
Internal server error.
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
trace id
-
default
application/json
Error response.
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
trace id
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/conditions/settings" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/conditions/settings',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
This API is not included yet in qlik-cli
Response
{
"tenantId": "cgdsAumGmQ6l0Bi7CUKt9V8P_Y9GL0sC",
"enable-conditions": true
}
Updates API configuration. Accessible only by tenant admins.
Facts
| Rate limit | Tier 2 (100 requests per minute) |
| Categories | externalbuild |
Header Parameters
- Authorizationstring
The JWT used for authentication. Send the JWT in the AuthRequest header using the Bearer schema.
Request Body
application/json
Request for updating the api settings
- application/jsonobject
application/json properties
- enable-conditionsbooleanRequired
Whether API endpoints for condition manager are enabled
-
Responses
204
api settings have been successfully updated.
400
application/json
Bad request body
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
trace id
-
500
application/json
Internal server error.
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
trace id
-
default
application/json
Error response.
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
trace id
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/conditions/settings" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{"enable-conditions":true}'
const https = require('https')
const data = JSON.stringify({"enable-conditions":true})
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/conditions/settings',
'method': 'PUT',
'headers': {
'Content-type': 'application/json',
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
req.write(data)
This API is not included yet in qlik-cli
Request
{
"enable-conditions": true
}