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

Test New Global Connection

post

/essbase/rest/v1/connections/actions/test

Tests a new or updated global connection, using specified inputs, without saving it.

Request

Supported Media Types
Body ()

Connection details.

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.

Back to Top

Response

Supported Media Types

200 Response

OK

The connection tested successfully.

400 Response

Bad Request

Error occurred while testing connection.

Back to Top

Examples

The following example shows how to test a new global connection before creating it.

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 -i "https://myserver.example.com:9001/essbase/rest/v1/connections/actions/test" -H Accept:application/json -H Content-Type:application/json --data "@./conn_details.json" -u %User%:%Password%

The cURL example above delivers a JSON payload in conn_details.json. The details you include in the payload determine what kind of connection is created. The example below is for testing a DB2 connection.

Sample JSON Payload - IBM DB2

The following sample JSON payload, passed to REST API in conn_details.json, is an example for testing a connection to DB2. The required parameters are name, type, subtype, dbDriver, host + port+ service (OR dbURL), user, and password. 

{
  "name" : "DB2Conn",
  "type" : "DB",
  "subtype" : "DB2",
  "dbDriver" : "com.oracle.bi.jdbc.db2.DB2Driver",
  "host" : db2host.example.com",
  "port" : 50000,
  "user" : "user1",
  "password" : "cGE1NXdvcmQx",
  "service" : "dbname"
}

For more examples of JSON payloads you can use to test, update, and create connections to sources supported by Essbase, see the Create Connection endpoint.

Example of Response Body

Returns header information (if -i was used), beginning with the status code 200 (if the test was successful): 

HTTP/1.1 200 OK
Back to Top