Jedox OLAP documentation

home > API > [/database/generate_script] >
request url https://[SERVER]:[PORT]/database/generate_script[?PARAMETER1=value[&...]]
short description Generates new script for a database.
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.
dimensions identifier Dimensions to include in the script. Empty means none, to include all dimensions use asterisk. Comma separated list of dimension identifiers.
name_dimensions string Comma separated list of dimension names. Used only if dimensions parameter is omitted.
cubes identifier Cubes to include in the script. Empty means none, to include all cubes use asterisk. Comma separated list of cube identifiers.
name_cubes string Comma separated list of cube names. Used only if cubes parameter is omitted.
include_elements boolean Generate elements info or do not include elements (default 0).
complete boolean Generate cell values info or do not include cells (default 0).
show_attribute boolean Include all attributes and their values (default 0).
include_local_lists boolean Include local lists (default 0).
include_global_lists boolean Include global lists (default 0).
include_local_subsets boolean Include local subsets (default 0).
include_global_subsets boolean Include global subsets (default 0).
include_local_views boolean Include local views (default 0).
include_global_views boolean Include global views (default 0).
include_dimension_rights boolean Include dimension rights (default 0).
include_cube_rights boolean Include cube rights (default 0).
clear boolean 1 - delete elements and cube cells first in the script (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.
show_rule boolean If 1, then include also rules definition into 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