Skip to content

Qlik Associative Engine API

Qlik Associative Engine API for version 12.171.0.

Qlik Associative Engine API specification

Paths

GET /health

No description.

Metadata Value
Stability Index Locked
Produces application/json

Parameters

No parameters

Responses

Status Description Schema
200 OK No schema

GET /healthcheck

No description.

Metadata Value
Stability Index Locked
Produces application/json

Parameters

No parameters

Responses

Status Description Schema
200 OK HealthcheckStatus

POST /v1/apps/import

Imports an app to the system.

This operation in autoreplace mode is supported only in EFE mode.

Metadata Value
Stability Index Experimental
Produces application/json

Parameters

Parameter In Type Required Description Schema
filedata body undefined true Path of the source app. FileData
name path string true The name of the target app. No schema
mode query string undefined The import mode. In new mode (default), the source app will be imported as a new app with generated meta-data. In autoreplace mode, the meta-data from the source app will be retained and imported with the app. The app-id is extracted from the source app and used as the target app-id. If the app exists, it will be replaced. Approved objects in the target app which are not availble in the source app will be removed. Non-approved objects in the target app will not be removed. One of:
• NEW
• AUTOREPLACE
No schema

Responses

Status Description Schema
200 OK NxApp

GET /v1/apps/{appId}/data/metadata

Retrieves the data model and reload statistics meta data of an app.

Metadata Value
Stability Index Experimental
Produces application/json

Parameters

Parameter In Type Required Description Schema
appId path string true Identifier of the app. No schema

Responses

Status Description Schema
200 OK DataModelMetadata

Definitions

HealthcheckStatus

Type: object

Properties

Name Type Schema Items Format Description
version string No schema No items No format No description.
started string No schema No items No format No description.
mem object MemoryUsage No items No format No description.
cpu object CPUUsage No items No format No description.
session object SessionUsage No items No format No description.
apps object AppUsage No items No format No description.
users object UserUsage No items No format No description.
cache object CacheUsage No items No format No description.
saturated boolean No schema No items No format No description.

MemoryUsage

Type: object

Properties

Name Type Schema Items Format Description
committed number No schema No items double No description.
allocated number No schema No items double No description.
free number No schema No items double No description.

CPUUsage

Type: object

Properties

Name Type Schema Items Format Description
total number No schema No items double No description.

SessionUsage

Type: object

Properties

Name Type Schema Items Format Description
active integer No schema No items int32 No description.
total integer No schema No items int32 No description.

AppUsage

Type: object

Properties

Name Type Schema Items Format Description
active_docs array No schema string No format No description.
loaded_docs array No schema string No format No description.
in_memory_docs array No schema string No format No description.
calls integer No schema No items int32 No description.
selections integer No schema No items int32 No description.

UserUsage

Type: object

Properties

Name Type Schema Items Format Description
active integer No schema No items int32 No description.
total integer No schema No items int32 No description.

CacheUsage

Type: object

Properties

Name Type Schema Items Format Description
hits integer No schema No items int32 No description.
lookups integer No schema No items int32 No description.
added integer No schema No items int32 No description.
replaced integer No schema No items int32 No description.
bytes_added integer No schema No items int32 No description.

FileData

Type: string

Format: binary

NxApp

Type: object

Properties

Name Type Schema Items Format Description
appId string No schema No items No format ID of the app.
attributes object NxAttributes No items No format App attributes.
meta object NxMeta No items No format App meta-data.

NxAttributes

Type: object

Properties

Name Type Schema Items Format Description
name string No schema No items No format App name.
description string No schema No items No format App description.
thumbnail string No schema No items No format App thumbnail.
tags array No schema string No format App tags.
lastReloadTime string No schema No items No format Date and time of the last reload of the app in ISO format.
createdDate string No schema No items No format The date when the app was created.

NxMeta

Type: object

Properties

Name Type Schema Items Format Description
Name string No schema No items No format Name. This property is optional.

DataModelMetadata

Type: object

Properties

Name Type Schema Items Format Description
reload_meta object LastReloadMetadata No items No format Meta data for the last app reload.
static_byte_size integer No schema No items int64 Static memory usage for the app.
fields array No schema FieldMetadata No format List of field descriptions.
tables array No schema TableMetadata No format List of table descriptions.

LastReloadMetadata

Type: object

Properties

Name Type Schema Items Format Description
cpu_time_spent_ms integer No schema No items int64 Number of CPU milliseconds it took to reload the app.
hardware object HardwareMeta No items No format Hardware available for the engine doing the reload.

HardwareMeta

Type: object

Properties

Name Type Schema Items Format Description
logical_cores integer No schema No items int32 Number of logical cores available.
total_memory integer No schema No items int64 RAM available.

FieldMetadata

Type: object

Properties

Name Type Schema Items Format Description
name string No schema No items No format Name of the field.
src_tables array No schema string No format List of table names.
is_system boolean No schema No items No format If set to true, it means that the field is a system field. The default value is false.
is_hidden boolean No schema No items No format If set to true, it means that the field is hidden. The default value is false.
is_semantic boolean No schema No items No format If set to true, it means that the field is a semantic. The default value is false.
distinct_only boolean No schema No items No format If set to true, only distinct field values are shown. The default value is false.
cardinal integer No schema No items int32 Number of distinct field values.
total_count integer No schema No items int64 Total number of field values.
is_locked boolean No schema No items No format If set to true, it means that the field is locked. The default value is false.
always_one_selected boolean No schema No items No format If set to true, it means that the field has one and only one selection (not 0 and not more than 1). If this property is set to true, the field cannot be cleared anymore and no more selections can be performed in that field. The default value is false.
is_numeric boolean No schema No items No format Is set to true if the value is a numeric. The default value is false.
comment string No schema No items No format Field comment.
tags array No schema string No format Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII.
byte_size integer No schema No items int64 Static RAM memory used in bytes.

TableMetadata

Type: object

Properties

Name Type Schema Items Format Description
name string No schema No items No format Name of the table.
is_system boolean No schema No items No format If set to true, it means that the table is a system table. The default value is false.
is_semantic boolean No schema No items No format If set to true, it means that the table is a semantic. The default value is false.
is_loose boolean No schema No items No format If set to true, it means that the table is loose due to circular connection. The default value is false.
no_of_rows integer No schema No items int64 Number of rows.
no_of_fields integer No schema No items int32 Number of fields.
no_of_key_fields integer No schema No items int32 Number of key fields.
comment string No schema No items No format Table comment.
byte_size integer No schema No items int64 Static RAM memory used in bytes.