The Engine API Explorer is a tool that helps you understand the Engine API. It passes information between the Qlik associative engine and clients.
The Engine API Explorer may display methods that are not supported or documented.
It is recommended to use the Engine API Explorer with Google Chrome.
Launching the Engine API Explorer
Select Engine API Explorer from the Navigation menu to launch the Engine API Explorer from Dev Hub.
Connect to the Qlik associative engine and open an app
To connect to the Qlik associative engine and open an app, do the following:
- Click Connect to engine.
- Open an app by selecting an app in the Select an app drop-down menu.
You are connected to the engine and the app is opened. You can now start using the methods available in the Qlik Engine JSON API.
Available API calls
The Select API calls table displays engine objects that you have a handle to. The table is updated right away if the state or handle changes.
| Object | Description | Methods reference |
|---|---|---|
| Global | This object contain all the methods that apply at global level. Available when connected to the Qlik associative engine. |
Engine API: Global class |
| Doc | This object contain all the methods that apply at app level. Available when an app has been selected. |
Engine API: Doc class |
Handles
The protocol uses handles to reference the objects/methods available. When connecting to the Qlik associative engine, you always get the handle -1, which is global and refers to the engine itself.
As you create and get objects, additional handles become available.
Available macros
You must be connected to the Qlik associative engine to have macros available. A number of macros are supplied. Each macro contains a set of methods.
To use a macro, do the following:
- Select a macro in the Select macro drop-down list.
- Click Execute.
The Discovered objects list is populated when a macro has been executed.
| Macro | Description | Object | Methods reference |
|---|---|---|---|
| Get applist |
Available when connected to the engine. Sends a GetDocList request to Qlik associative engine, which returns a list of available apps . |
||
| List dimensions |
Available when connected to an app. Creates a session object of "qType": "DimensionList" and sends a create layout request to the Qlik associative engine. A DimensionList object is returned. The methods available for a DimensionList belong to the GenericObject class. |
DimensionList | |
| List fields |
Available when connected to an app. Creates a session object of "qType": "FieldList" and sends a create layout request to the Qlik associative engine. A FieldList object is returned. The methods available for a FieldList belong to the GenericObject class. |
FieldList | |
| List measures |
Available when connected to an app. Creates a session object of "qType": "MeasureList" and sends a create layout request to the Qlik associative engine. A MeasureList object is returned. The methods available for a MeasureList belong to the GenericObject class. |
MeasureList | |
| List selections |
Available when connected to an app. Creates a session object of "qType": "CurrentSelection" and sends a create layout request to the Qlik associative engine. A CurrentSelection object is returned. The methods available for a CurrentSelection belong to the GenericObject class. |
CurrentSelection | |
| List sheets |
Available when connected to an app. Creates a session object of "qType": "SheetList" and sends a create layout request to Qlik associative engine. A SheetList object is returned. The methods available for a SheetList belong to the GenericObject class. |
SheetList | |
| List variables |
Available when connected to an app. Creates a session object of "qType": "VariableList" and sends a create layout request to Qlik associative engine. A VariableList object is returned. The methods available for a VariableList belong to the GenericObject class. |
VariableList |
Discovered objects
The Discovered objects drop-down lists engine objects that you do not have handles for.
Execution logs
Details of the requests sent to, and the responses returned from, the Qlik associative engine can be viewed in the Execution logs section.
