| home > API > [/hold/create] > |
| request url |
https://[SERVER]:[PORT]/hold/create[?PARAMETER1=value[&...]] |
| short description |
Creates a hold |
| long description |
|
| 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 identifiers lists. Each element identifiers list is colon separated. The area is the cartesian product. |
| name_area |
narea |
Comma separated list of element names lists. Each element names list is colon separated. The area is the cartesian product. Used only if area is omitted. |
| sid |
string |
Session identifier for a server connection. Use the /server/login request to get a valid session identifier. |
|
| result |
| # |
name |
type |
description |
| 0 |
hold |
identifier |
Identifier of the hold. |
| 1 |
area |
area |
Comma separated list of element identifiers lists. Each element identifiers list is colon separated. The area is the cartesian product. |
| 2 |
user |
string |
The name of the user who created the hold. |
| 3 |
timestamp |
string |
creation time of the hold in seconds since 1970-01-01. |
|
| examples |
|
| further information |
|