| home > API > [/dimension/clear] > |
| request url |
https://[SERVER]:[PORT]/dimension/clear[?PARAMETER1=value[&...]] |
| short description |
Clears a dimension |
| long description |
Clears a dimension by removing all elements within
the dimension. The dimension itself remains, however all associated
cubes are also cleared. |
| parameters |
| name |
type |
description |
| 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. |
| type |
integer |
Optional parameter. Clear only elements of specified type (1=NUMERIC, 2=STRING, 4=CONSOLIDATED) |
| sid |
string |
Session identifier for a server connection. Use the /server/login request to get a valid session identifier. |
|
| result |
| # |
name |
type |
description |
| 0 |
dimension |
identifier |
Identifier of the dimension |
| 1 |
name_dimension |
string |
Name of the dimension |
| 2 |
number_elements |
integer |
Number of elements |
| 3 |
maximum_level |
integer |
Maximum level of the dimension |
| 4 |
maximum_indent |
integer |
Maximum indent of the dimension |
| 5 |
maximum_depth |
integer |
Maximum depth of the dimension |
| 6 |
type |
integer |
Type of dimension (0=normal, 1=system, 2=attribute) |
| 7 |
attributes_dimension |
identifier |
Identifier of the attributes dimension of a normal dimension or the
identifier of the normal dimension associated to a attributes dimension. |
| 8 |
attributes_cube |
identifier |
Identifier of the attributes cube. (only for normal dimensions) |
| 9 |
rights_cube |
identifier |
Identifier of the rights cube. (only for normal dimensions) |
| 10 |
dimension_token |
integer |
The dimension token of the dimension |
|
| examples |
|
| further information |
|