Create Application and Database
/essbase/rest/v1/applications
Creates an application and database (cube) with the specified details.
Request
Application details.
object
-
allowDuplicates:
boolean
true if duplicate member names are permitted. When you enable duplicate member names in an Essbase outline, then member names do not have to be unique. You can have multiple members using the same name in the outline.
-
applicationName:
string
The application name must not exceed 30 characters. Avoid using spaces. Application names are not case-sensitive.
-
appType:
string
Allowed Values:
[ "NATIVE", "UTF8" ]
-
databaseName:
string
The database (cube) name. The name is not case sensitive. Do not use spaces in the name. Only the following special characters are allowed in the name:
%$-{}()!~`#&@^
. -
databaseType:
string
The type of database (cube) to create. Values: BSO for block storage cube, or ASO for aggregate storage cube.
-
dbType:
string
Allowed Values:
[ "NORMAL", "CURRENCY", "ASO" ]
-
enableScenario:
boolean
true if cubes can be enabled for scenario management. Note that scenario management is supported only for block storage cubes. For aggregate storage cubes, the only supported value for this parameter is false.
-
memberCount:
integer(int32)
-
memberPrefix:
string
Response
- application/json
- application/xml
200 Response
OK
Application created successfully.
400 Response
Bad Request
Failed to create application.
500 Response
Internal Server Error.
Examples
The following example shows how to create an Essbase application and database (cube) using the REST API.
This example uses cURL to access the REST API from a Windows shell script. The calling user's ID and password are variables whose values are set in properties.bat
.
Script with cURL Command
call properties.bat
curl -X POST https://myserver.example.com:9001/essbase/rest/v1/applications -H "Accept:application/json" -H "Content-Type:application/json" -d '{"applicationName": "MyApp", "databaseName":"Basic", "databaseType":"ASO", "allowDuplicates": true, "enableScenario": false}' -u %User%:%Password%