Set expressions, or expanders are keywords in the query to process and filter hierarchical dimension structures.
The syntax of the exander:
{"d": "dimension_name","e": "keyword","p": ["parameter","more parameters"]},Example:
The example return element with ID actual from the dimension data_type.
{"d": "data_type","e": "one","p": ["actual"]},List of supported keywords:
- ALL: returns all elements in the dimension; if the number of elements in a dimension is larger than 20000 then the expander returns only nodes (rollups) which you can further use to retrieve leaves for
- ONE: return one or more elements specified in the parameter
- DEP: return all descendants of the specified element
- BAS: return all leaf elements below the specified element
- LDEP: return all descendants of the specified element up to n levels deep, where n must be specified in the parameter
- SDEP: return the specified element and its descendants
- LEX: return all descendants of the specified element up to n levels deep, where n must be specified in the parameter, or return element itself if it is a leaf-level element.
- BEX: return all descendants of the specified element up to n levels deep, where n must be specified in the parameter, or return element itself if it is a leaf-level element.
- FILTER: query elements based on some criteria specified in the parameter
Parameters for each expression:
| Keyword | Parameter | Example |
|---|---|---|
| ALL | empty set | [] |
| ONE | list of element id-s | ["total"] or ["2020","2021"] |
| DEP | element id | ["total"] |
| BAS | element id | ["total"] |
| LDEP | element id and number of levels | ["total", 2] |
| SDEP | element id | ["total"] |
| LEX | element id | ["total"] |
| BEX | element id | ["total"] |
| FILTER | query for filer | [{query content}] |