| home > API > [/server/locks] > |
| request url |
https://[SERVER]:[PORT]/server/locks[?PARAMETER1=value[&...]] |
| short description |
Lists the locked cube areas |
| long description |
|
| parameters |
| name |
type |
description |
| complete |
boolean |
(Optional) If 1 then all locks otherwise only locks defined by the current user are listed (default is 0). |
| sid |
string |
Session identifier for a server connection. Use the /server/login request to get a valid session identifier. |
|
| result |
| # |
name |
type |
description |
| 0 |
database |
identifier |
Identifier of the database |
| 1 |
cube |
identifier |
Identifier of the cube |
| 2 |
lock |
integer |
Indentifier of the locked area |
| 3 |
area |
area |
Comma separated list of element identifiers lists. Each element identifiers list is colon separated. The area is the cartesian product. |
| 4 |
user |
string |
The name of the user who locked the cube |
| 5 |
steps |
integer |
Number of steps |
|
| examples |
|
| further information |
|