Jedox OLAP documentation

home > API > [/dimension/generate_script] >
request url https://[SERVER]:[PORT]/dimension/generate_script[?PARAMETER1=value[&...]]
short description Generates new script for a dimension.
long description
parameters
name type description
sid string Session identifier for a server connection. Use the /server/login request to get a valid session identifier.
database identifier Identifier of the database
name_database string Name of the database. Used only if database parameter is omitted.
dimension identifier Identifier of the dimension
name_dimension string Name of the dimension. Used only if dimension parameter is omitted.
complete boolean (Optional) If complete is "1" then the whole dimension - regardless of the specified elements list - will be exported to the script.
elements identifier Comma separated list of element identifiers (optional). Generate info just for these elements. If empty or not present and complete=0, no elements are exported.
name_elements string Comma separated list of element names (optional). Used only if elements parameter is omitted.
show_attribute boolean Include all attributes and their values (default 0).
include_local_subsets boolean Include local subsets (default 0).
include_global_subsets boolean Include global subsets (default 0).
include_dimension_rights boolean Include dimension rights (default 0).
languages string Languages (translations) to include in the script. Comma separated list of languages. Empty for default language only, asterisk symbol for all languages.
clear boolean 1 - delete dimension elements first in the script (default 0).
script_create_clause integer 0 (default) - ERROR_IF_EXISTS, 1 - ERROR_IF_DIFFERS, 2 - NO_ERROR
script_modify_clause integer 0 (default) - ERROR_IF_NOT_EXISTS, 1 - NO_ERROR
result
# name type description
0 script string Content of the new script.
examples
description
create a script for whole database
further information