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

List Application Connections

get

/essbase/rest/v1/applications/{applicationName}/connections

Returns a list of connections for the application, including details such as name, description, and type.

A connection stores information about an external server and the login credentials that are required to access it. By defining one connection that can be used by multiple processes and artifacts, you can simplify many aspects of your analytics.

Request

Path Parameters
Query Parameters

  • Type of connections to return, if provided

  • Maximum number of connections to return. Default is 50.

    Default Value: 50

  • Number of connections to omit from the start of the result set.

    Default Value: 0

  • Used in conjunction with connType param. If set to true, returns repository-based Autonomous Data Warehouse connections. Default is false.

    Default Value: false

  • Used in conjunction with connType param. If set to true, returns wallet-based Autonomous Data Warehouse connections. Default is false.

    Default Value: false
Back to Top

Response

Supported Media Types

200 Response

OK

List of connections returned successfully.

Body ()
Root Schema : ConnectionsList
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : properties
Type: object
Additional Properties Allowed
Show Source
Nested 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 list connections.

Back to Top

Examples

The following example shows how to get a list of connections for an Essbase application.

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 GET "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/connections" -H Accept:application/json -u %User%:%Password%

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "items" : [ {
    "name" : "Essbase2",
    "description" : "Connection to Essbase instance 2",
    "type" : "ESSBASE",
    "subtype" : "ESSBASE",
    "minPoolSize" : 5,
    "maxPoolSize" : 50,
    "links" : [ {
      "rel" : "self",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/connections/Essbase2",
      "method" : "GET"
    }, {
      "rel" : "edit",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/connections/Essbase2",
      "method" : "PUT"
    }, {
      "rel" : "delete",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/connections/Essbase2",
      "method" : "DELETE"
    }, {
      "rel" : "self",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/connections/Essbase2/actions/test",
      "method" : "POST"
    } ]
  }, {
    "name" : "OracleDB",
    "description" : "Connection to Database",
    "type" : "DB",
    "subtype" : "ORACLE",
    "minPoolSize" : 5,
    "maxPoolSize" : 50,
    "links" : [ {
      "rel" : "self",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/connections/OracleDB",
      "method" : "GET"
    }, {
      "rel" : "edit",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/connections/OracleDB",
      "method" : "PUT"
    }, {
      "rel" : "delete",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/connections/OracleDB",
      "method" : "DELETE"
    }, {
      "rel" : "self",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/connections/OracleDB/actions/test",
      "method" : "POST"
    } ]
  }, {
    "name" : "UserDetails",
    "description" : "CSV file of user details",
    "type" : "FILE",
    "subtype" : "FILE",
    "minPoolSize" : 5,
    "maxPoolSize" : 50,
    "links" : [ {
      "rel" : "self",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/connections/UserDetails",
      "method" : "GET"
    }, {
      "rel" : "edit",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/connections/UserDetails",
      "method" : "PUT"
    }, {
      "rel" : "delete",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/connections/UserDetails",
      "method" : "DELETE"
    }, {
      "rel" : "self",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/connections/UserDetails/actions/test",
      "method" : "POST"
    } ]
  } ],
  "offset" : 0,
  "limit" : 50,
  "count" : 3,
  "totalResults" : 3,
  "hasMore" : false
}
Back to Top