Database Connection Management

This API provides methods to create, change, and delete connections to external databases. It also allows managing users permissions.

Actions
DbConnection_Delete	Deletes the database connection given by the name.
DbConnection_TestConnection	Tests a database connection with the given parameters.
DbConnection_GrantUserAccess	Grants a user with a permission level to use the database connection.
DbConnection_Get	Returns the database connection.
DbConnection_GetUserAccess	Returns the user permissions to use a database connection.
DbConnection_RevokeRoleAccess	Revokes the role permissions to use the database connection.
DbConnection_Rename	Renames an database connection. This may have impact on all running application that use this database connection.
DbConnection_GetRoleAccess	Returns the role permissions to use a database connection.
DbConnection_Edit	Updates the configuration of the database connection.
DbConnection_ListProviders	The list of database providers that a user can associate to a database connection.
DbConnection_PermissionLevel_List	Returns the list of permission levels.
DbConnection_ListAll	Returns a list with all database connections.
DbConnection_Create	Creates a new database connection.
DbConnection_GrantRoleAccess	Grants a role with a permission level to use the database connection.
DbConnection_RevokeUserAccess	Revokes the user permissions to use the database connection.

Actions

DbConnection_Delete

Inputs

Authentication: Type: mandatory, WebServiceSimpleAuthentication.
The authentication required to use this API. Specify a valid platform username and password, or use the LoginService API to acquire a session token.

EnvironmentKey: Type: mandatory, Text.
An environment unique identifier.

DbConnectionName: Type: mandatory, Text.
The name of the database connection .

DbConnection_TestConnection

Inputs

Authentication: Type: mandatory, WebServiceSimpleAuthentication.
The authentication required to use this API. Specify a valid Platform username and password, or use the LoginService API to acquire a session token.

EnvironmentKey: Type: mandatory, Text.
An environment unique identifier.

ProviderKey: Type: mandatory, Text.
The key of the database provider associated with the new database connection. See method DBConnection_ListProviders.

DBUsername: Type: mandatory, Text.
The username to log in to the external database.

DBPassword: Type: mandatory, Text.
The password to log in to the external database.

DBConfigParams: Type: mandatory, Text.
Parameters for the connection string. Separate them using ';'.

DbConnection_GrantUserAccess

Inputs

Authentication: Type: mandatory, WebServiceSimpleAuthentication.
The authentication required to use this API. Specify a valid platform username and password, or use the LoginService API to acquire a session token.

EnvironmentKey: Type: mandatory, Text.
An environment unique identifier.

DbConnectionName: Type: mandatory, Text.
The name of the database connection.

Username: Type: mandatory, Text.
The username of the user to grant permissions.

PermissionLevelId: Type: mandatory, DbConnectionPermissionLevel Identifier.
The permission level to be granted. See method DbConnection_PermissionLevel_List.

DbConnection_Get

Inputs

Authentication: Type: mandatory, WebServiceSimpleAuthentication.
The authentication required to use this API. Specify a valid platform username and password, or use the LoginService API to acquire a session token.

EnvironmentKey: Type: mandatory, Text.
An environment unique identifier.

DbConnectionName: Type: mandatory, Text.
The name of the database connection.

Outputs

DbConnection: Type: .
The database connection.

Success: Type: Boolean.
True if the database connection was got.

Status: Type: APIStatus.
The status of invoking this API. This status contains an error code and human-readable error messages.

DbConnection_GetUserAccess

Inputs

Authentication: Type: mandatory, WebServiceSimpleAuthentication.
The authentication required to use this API. Specify a valid platform username and password, or use the LoginService API to acquire a session token.

EnvironmentKey: Type: mandatory, Text.
An environment unique identifier.

DbConnectionName: Type: mandatory, Text.
The name of the database connection.

Username: Type: mandatory, Text.
The username of the user.

Outputs

PermissionLevel: Type: .
The user's permission level.

Success: Type: Boolean.
True if the permissions were got.

Status: Type: APIStatus.
The status of invoking this API. This status contains an error code and human-readable error messages.

DbConnection_RevokeRoleAccess

Inputs

Authentication: Type: mandatory, WebServiceSimpleAuthentication.
The authentication required to use this API. Specify a valid platform username and password, or use the LoginService API to acquire a session token.

EnvironmentKey: Type: mandatory, Text.
An environment unique identifier.

DbConnectionName: Type: mandatory, Text.
The name of the database connection.

RoleName: Type: mandatory, Text.
The name of the role to revoke permissions.

DbConnection_Rename

Renames an database connection. This may have impact on all running application that use this database connection.

Inputs

Authentication: Type: mandatory, WebServiceSimpleAuthentication.
The authentication required to use this API. Specify a valid platform username and password, or use the LoginService API to acquire a session token.

EnvironmentKey: Type: mandatory, Text.
An environment unique identifier.

CurrentName: Type: mandatory, Text.
The current name of the database connection.

NewName: Type: mandatory, Text.
The new name for the database connection.

DbConnection_GetRoleAccess

Inputs

Authentication: Type: mandatory, WebServiceSimpleAuthentication.
The authentication required to use this API. Specify a valid platform username and password, or use the LoginService API to acquire a session token.

EnvironmentKey: Type: mandatory, Text.
An environment unique identifier.

DbConnectionName: Type: mandatory, Text.
The name of the database connection.

RoleName: Type: mandatory, Text.
The name of the role.

Outputs

PermissionLevel: Type: .
The role's permission level.

Success: Type: Boolean.
True if the permissions were got.

Status: Type: APIStatus.
The status of invoking this API. This status contains an error code and human-readable error messages.

DbConnection_Edit

Inputs

Authentication: Type: mandatory, WebServiceSimpleAuthentication.
The authentication required to use this API. Specify a valid platform username and password, or use the LoginService API to acquire a session token.

EnvironmentKey: Type: mandatory, Text.
An environment unique identifier.

DbConnectionName: Type: mandatory, Text.
The name of the database connection.

ProviderKey: Type: mandatory, Text.
The key of the database provider associated with the new database connection. See method DBConnection_ListProviders.

Description: Type: mandatory, Text.
The database connection description.

DBUsername: Type: mandatory, Text.
The username to log in to the external database.

DBPassword: Type: mandatory, Text.
The password to log in to the external database.

DBConfigParams: Type: mandatory, Text.
Parameters for the connection string. Separate them using ';'.

TestConnection: Type: mandatory, Boolean.
If True, the database connection is only updated after being tested with sucess.

DbConnection_ListProviders

The list of database providers that a user can associate to a database connection.

Inputs

Authentication: Type: mandatory, WebServiceSimpleAuthentication.
The authentication required to use this API. Specify a valid Platform username and password, or use the LoginService API to acquire a session token.

Outputs

Providers: Type: DbProvider List.
The list of allowed database providers.

Success: Type: Boolean.
True if the authentication succeeds and a list of providers is returned.

Status: Type: APIStatus.
The status of invoking this API. This status contains an error code and human-readable error message.

DbConnection_PermissionLevel_List

Inputs

Authentication: Type: mandatory, WebServiceSimpleAuthentication.
The authentication required to use this API. Specify a valid platform username and password, or use the LoginService API to acquire a session token.

Outputs

Success: Type: Boolean.
True if the authentication succeeds and a list of permission levels is returned.

Status: Type: APIStatus.
The status of invoking this API. This status contains an error code and human-readable error messages.

DbConnectionPermissionLevels: Type: DbConnectionPermissionLevel List.
The list of permission levels.

DbConnection_ListAll

Inputs

Authentication: Type: mandatory, WebServiceSimpleAuthentication.
The authentication required to use this API. Specify a valid platform username and password, or use the LoginService API to acquire a session token.

EnvironmentKey: Type: mandatory, Text.
An environment unique identifier.

Outputs

DbConnections: Type: DatabaseConnection List.
The list of all database connections.

Success: Type: Boolean.
True if the list of database connections is filled.

Status: Type: APIStatus.
The status of invoking this API. This status contains an error code and human-readable error messages.

DbConnection_Create

Inputs

Authentication: Type: mandatory, WebServiceSimpleAuthentication.
The authentication required to use this API. Specify a valid Platform username and password, or use the LoginService API to acquire a session token.

EnvironmentKey: Type: mandatory, Text.
The environment unique identifier.

Name: Type: mandatory, Text.
The name of the new database connection.

ProviderKey: Type: mandatory, Text.
The key of the database provider associated with the new database connection. See method DBConnection_ListProviders.

Description: Type: mandatory, Text.
The description of the new database connection.

DBUsername: Type: mandatory, Text.
The username to log in to the external database.

DBPassword: Type: mandatory, Text.
The password to log in to the external database.

DBConfigParams: Type: mandatory, Text.
Parameters for the connection string. Separate them using ';'.

TestConnection: Type: mandatory, Boolean.
If True, the database connection is only created after being tested with success.

Outputs

DbConnection: Type: .
The database connection that was created.

Success: Type: Boolean.
True if the database connection was created.

Status: Type: APIStatus.
The status of invoking this API. This status contains an error code and human-readable error messages.

DbConnection_GrantRoleAccess

Inputs

Authentication: Type: mandatory, WebServiceSimpleAuthentication.
The authentication required to use this API. Specify a valid platform username and password, or use the LoginService API to acquire a session token.

EnvironmentKey: Type: mandatory, Text.
An environment unique identifier.

DbConnectionName: Type: mandatory, Text.
The name of the database connection.

RoleName: Type: mandatory, Text.
The name of the role of users to grant permissions.

PermissionLevelId: Type: mandatory, DbConnectionPermissionLevel Identifier.
The permission level to be granted. See method DbConnection_PermissionLevel_List.

DbConnection_RevokeUserAccess

Inputs

Authentication: Type: mandatory, WebServiceSimpleAuthentication.
The authentication required to use this API. Specify a valid platform username and password, or use the LoginService API to acquire a session token.

EnvironmentKey: Type: mandatory, Text.
An environment unique identifier.

DbConnectionName: Type: mandatory, Text.
The name of the database connection.

Username: Type: mandatory, Text.
The username of the user to revoke permissions.