| home > API > [/cube/clear] > |
| request url |
https://[SERVER]:[PORT]/cube/clear[?PARAMETER1=value[&...]] |
| short description |
Clears a cube |
| long description |
Clears a region of a cube. An area of the cube has
to specified. All elements within this area are 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. |
| cube |
identifier |
Identifier of the cube. |
| name_cube |
string |
Name of the cube. Used only if cube parameter is omitted. |
| area |
area |
Comma separated list of element identifier lists. Identifier lists are separated by colons. The area is the cartesian product. |
| 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. |
| complete |
boolean |
(Optional) If complete is "1" then the whole cube - regardless of the specified area - will be cleared. It is not necessary to even specify the parameter "area" in this case. Default is to use "area". |
| sid |
string |
Session identifier for a server connection. Use the /server/login request to get a valid session identifier. |
|
| result |
| # |
name |
type |
description |
| 0 |
cube |
identifier |
Identifier of the cube |
| 1 |
name_cube |
string |
Name of the cube |
| 2 |
number_dimensions |
integer |
Number of dimensions |
| 3 |
dimensions |
identifier |
Comma separated list of dimension identifiers |
| 4 |
number_cells |
double |
Total number of cells |
| 5 |
number_filled_cells |
integer |
Number of filled numeric base cells plus number of filled string cells |
| 6 |
status |
integer |
Status of cube (0=unloaded, 1=loaded and 2=changed) |
| 7 |
type |
integer |
Type of cube (0=normal, 1=system, 2=attribute, 3=user info) |
| 8 |
cube_token |
integer |
The cube token of the cube |
|
| examples |
|
| further information |
|