Jedox OLAP documentation

home > API > [/cube/generate_script] >
request url https://[SERVER]:[PORT]/cube/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.
cube identifier Identifier of the cube.
name_cube string Name of the cube. Used only if cube parameter is omitted.
complete boolean (Optional) If complete is "1" then the whole cube - regardless of the specified area - will be exported to the script.
area area Comma separated list of element identifier lists. Identifier lists are separated by colons. The area is the cartesian product. If not present and complete=0, no cells are exported.
name_area narea Comma separated list of element name lists. Name lists are separated by colons. The area is the cartesian product. Used only if area parameter is omitted.
show_attribute boolean Include all attributes and their values (default 0).
include_local_views boolean Include local views (default 0).
include_global_views boolean Include global views (default 0).
include_cube_rights boolean Include 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 cube cells first in the script (default 0).
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