1. REST API for Oracle Essbase
  2. Tasks
  3. Global Connections

Get Connection

get

/essbase/rest/v1/connections/{connectionName}

Returns details about the specified global connection.

Request

Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

OK

Connection details returned successfully.

Body ()
Root Schema : connection
Type: object
Show Source

  • Optional. If type is DB and you are configuring Essbase to use a generic JDBC driver, provide the fully qualified class name of the JDBC driver. For example, oracle.jdbc.driver.OracleDriver.

  • URL to an external RDBMS database, or, discovery URL to an Essbase instance. For connections to other Essbase instances, this parameter is an alternative to providing the host and port. Example of Essbase discovery URL https://192.0.2.1:443/essbase/agent. For examples of other uses, see documentation for global Get Connection endpoint.

  • A descriptive string for this connection.

  • Host server name or IP. Required for Oracle Database connections. Required for Essbase connections, unless dbURL is used instead.

  • links

  • Maximum connection pool size. Default is 50. If you get connection errors you may need to adjust minimum and maximum connection pool sizes. See About Controlling the Pool Size in UCP in Universal Connection Pool Developer's Guide.

  • Minimum connection pool size. Default is 5. If you get connection errors you may need to adjust minimum and maximum connection pool sizes. See About Controlling the Pool Size in UCP in Universal Connection Pool Developer's Guide.

  • A name for this connection.

  • Required. Password of the user ID with authorization to access the remote source for this connection.

  • Required for file type connections. Catalog path to the file source of data. Example: /gallery/Technical/Drill Through/DrillthroughDS.csv

  • Port number on the remote host. Required for connections when host is given.

  • Set to true if you are using an Autonomous Data Warehouse connection which is already available (a repository connection). In this case, you do not need to upload a wallet.

  • Service name, if you are defining an Oracle Database connection.

  • The Oracle System ID (SID) that uniquely identifies an Oracle Database. Required for Oracle Database connections unless service is used instead.

  • Allowed Values: [ "TEMPLATE", "EXCELFILE", "DB", "DELIMITEDFILE", "FIXEDWIDTHFILE", "ESSBASE", "JDBC", "SPARK", "MS_SQL", "MYSQL", "DB2", "ORACLE", "FILE" ]

    The type of external source. Supported sources and versions are listed in the Database section of the certification matrix (Platform SQL table).

  • Allowed Values: [ "FILE", "DB", "ESSBASE" ]

    Required. Type of connection. FILE to connect to a file on the server, DB to connect to an external source system, or ESSBASE to connect to another cube.

  • Required. User ID with authorization to access the remote source for this connection.

  • Path to a wallet file, if required for your connection to Autonomous Data Warehouse (if repoWallet = false). Example: /system/wallets/EssbaseADWS. Obtain a wallet file by selecting Download Client Credentials (Wallet) from your Autonomous Data Warehouse Administration page in Oracle Cloud Infrastructure. If you are using a connection which is already available (a repository connection), you do not need to upload a wallet.

400 Response

Bad Request

Failed to get connection details.

Back to Top

Examples

The following examples show how to get details about a specific global connection.

These examples use 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

The following example gets details about a global connection named oraConn.

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/connections/oraConn?links=none" -H Accept:application/json -u %User%:%Password%

Example of Response Body - Oracle Database Connection

The following example shows the contents of the response body in JSON format, if the connection is to Oracle Database.

{
  "name" : "oraConn",
  "description" : "Oracle Database connection",
  "type" : "DB",
  "subtype" : "ORACLE",
  "minPoolSize" : 5,
  "maxPoolSize" : 50,
  "host" : "dbhost.example.com",
  "port" : 1521,
  "user" : "SAMPLE",
  "sid" : "orcl",
  "links" : [ ]
}

Example of Response Body - File Connection

The following example shows the contents of a response body in JSON format, if the connection is to a file.

{
  "name" : "fileConn",
  "description" : "CSV file connection",
  "type" : "FILE",
  "subtype" : "FILE",
  "path" : "/shared/Dim_Year.csv",
  "minPoolSize" : 5,
  "maxPoolSize" : 50,
  "links" : [ ]
}

Example of Response Body - Essbase Connection

The following example shows the contents of a response body in JSON format, if the connection is to another Essbase cube.

{
  "name" : "essConn",
  "description" : "Essbase 2 connection",
  "type" : "ESSBASE",
  "subtype" : "ESSBASE",
  "minPoolSize" : 5,
  "maxPoolSize" : 50,
  "dbURL" : "https://esscube.example.com:9001/essbase/agent",
  "user" : "admin",
  "links" : [ ]
}

Example of Response Body - IBM DB2 Connection

{
  "name" : "DB2Conn",
  "description" : "IBM DB2 connection",
  "type" : "DB",
  "subtype" : "DB2",
  "dbURL" : "jdbc:oracle:db2://db2host.example.com:50000;DatabaseName=tbc",
  "dbDriver" : "com.oracle.bi.jdbc.db2.DB2Driver",
  "host" : db2host.example.com",
  "port" : 50000,
  "user" : "user1",
  "service" : "svcname",
  "links" : [ ]
}

Example of Response Body - Microsoft SQL Connection

{
  "name" : "MSSQLConn",
  "description" : "Microsoft SQL connection",
  "type" : "DB",
  "subtype" : "MS_SQL",
  "dbURL" : "jdbc:oracle:sqlserver://mssqlhost.example.com:1433",
  "dbDriver" : "com.oracle.bi.jdbc.sqlserver.SQLServerDriver",
  "host" : "mssqlhost.example.com",
  "port" : 1433,
  "user" : "user1",
  "links" : [ ]
}

Example of Response Body - MySQL Connection

{
  "name" : "MySQLConn",
  "description" : "MySQL connection",
  "type" : "DB",
  "subtype" : "MYSQL",
  "dbURL" : "jdbc:oracle:mysql://mysqlhost.example.com:3306",
  "dbDriver" : "com.oracle.bi.jdbc.mysql.MySQLDriver",
  "host" : "mysqlhost.example.com",
  "port" : 3306,
  "user" : "user1",
  "links" : [ ]
}

Example of Response Body - Spark Connection

{
  "name" : "SparkConn",
  "description" : "Spark connection",
  "type" : "DB",
  "subtype" : "SPARK",
  "dbURL" : "jdbc:oracle:sparksql://sparkhost.example.com:10000",
  "dbDriver" : "com.oracle.bi.jdbc.sparksql.SparkSQLDriver",
  "host" : "sparkhost.example.com",
  "port" : 10000,
  "user" : "user1",
  "links" : [ ]
}

Example of Response Body - Oracle JDBC Connection

{
  "name" : "oracle_jdbc",
  "description" : "Oracle JDBC driver connection",
  "type" : "DB",
  "subtype" : "JDBC",
  "dbURL" : "jdbc:oracle:thin:@dbhost.example.com:1521/orclpdb.example.com",
  "dbDriver" : "oracle.jdbc.driver.OracleDriver",
  "user" : "user1",
  "links" : [ ]
}

Example of Response Body - Microsoft SQL JDBC Connection

{
  "name" : "mssql_jdbc",
  "description" : "Microsoft SQL JDBC driver connection",
  "type" : "DB",
  "subtype" : "JDBC",
  "dbURL" : "jdbc:sqlserver://mysqlhost.example.com:1433;databaseName=TBC",
  "dbDriver" : "com.microsoft.sqlserver.jdbc.SQLServerDriver",
  "user" : "TBC",
  "links" : [ ]
}

Example of Response Body - Teradata JDBC Connection

{
  "name" : "tera_jdbc",
  "description" : "Teradata JDBC driver connection",
  "type" : "DB",
  "subtype" : "JDBC",
  "dbURL" : "jdbc:teradata://10.x.x.x/TBC",
  "dbDriver" : "com.teradata.jdbc.TeraDriver",
  "user" : "TBC",
  "links" : [ ]
}
Back to Top