| The Cube Panelīs API 2.2 Reference Guide: Accessing Cube Panel's WebServices | ||
|---|---|---|
| Prev | Chapter 2. API Reference Guide | Next |
Input parameters:
- [search] : string : filter the search by name of database.
- [orderArray] : OrderArray : results order structure.
Output parameters:
- Returns an ArrayOfSQLServerInfo
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_SQLSERVER_GETSQLSERVERDBS
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: domain
Necessary permissions: PERM_DOMAIN_MSSQLDBS
Remarks:
- Lists MySQL databases created for the domain accessing the web service.
- The results may be ordered by the following criteria:
- login : database name
- date : database creation date
Examples:
.NET Java PHP
Input parameters:
- [login] : string : name of database to be created
- password : string : password to be assigned to the database
- totalSize : int : size of database (MB)
- transSize : int : size of transaction register (MB)
Output parameters:
- Return a Boolean with true value if the database has been created correctly.
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_PROCESSOR_DOMAIN_LOCKED
- ERROR_PROCESSOR_LIMIT_RESOURCES
- ERROR_SQLSERVER_NEWSQLSERVER
- ERROR_SQLSERVER_DBNAMEEXISTS
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: domain
Necessary permissions: PERM_DOMAIN_MSSQLDBS
Remarks:
- Create a new SQL Server database.
- If the login is null, an auto-generated sequential name will be assigned to the database.
Examples:
.NET Java PHP
Input parameters:
- sqlServerID : int : SQL Server database ID
- newPassword : string : new password to be assigned to the database
Output parameters:
- Returns a boolean a with true value if the password has been changed.
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_PROCESSOR_DOMAIN_LOCKED
- ERROR_SQLSERVER_SQLSERVERNOTEXISTS
- ERROR_SQLSERVER_CHANGEPASSWORD
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: domain
Necessary permissions: PERM_DOMAIN_MSSQLDBS
Remarks:
- Assign a new password to a database
Examples:
.NET Java PHP
Input parameters:
- arrayId : Array : array of SQL Server database ID
Output parameters:
- Return a boolean with true value if the databases has been deleted correctly.
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_PROCESSOR_DOMAIN_LOCKED
- ERROR_SQLSERVER_SQLSERVERNOTEXISTS
- ERROR_SQLSERVER_DELDATABASE
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: domain
Necessary permissions: none
Remarks:
- Delete the SQL Server databases indicated in the array arrayId.
Examples:
.NET Java PHP