Generic Dimension API Module

class qe_api_client.api_classes.engine_generic_dimension_api.EngineGenericDimensionApi(socket)[source]

Bases: object

API class for interacting with Qlik Sense engine’s generic dimension objects.

get_dimension(handle, dimension_id)[source]

Retrieves the definition of a specific dimension.

apply_patches(handle: int, patches: list)[source]

Applies a patch to the properties of an object. Allows an update to some of the properties.

Parameters:

  • handle (int) – The handle identifying the generic object.

  • patches (list) – List of patches.

Returns:

Operation succeeded.

Return type:

dict

get_dimension(app_handle: int, dimension_id: str)[source]

Retrieves the definition of a specific dimension from the Qlik Sense engine.

Parameters:

  • app_handle (int) – The handle identifying the application.

  • dimension_id (str) – The unique identifier (qId) of the dimension to retrieve.

Returns:

The definition of the requested dimension (qReturn). In case of an error, returns the error information.

Return type:

dict