REST API for Oracle Essbase

Get Application Connection

get

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

Returns details about the specified application-level connection.

Request

Path Parameters

applicationName(required): string

Application name.
connectionName(required): string

Connection name.

Query Parameters

password: boolean

If set to true, the encrypted password is returned in the result.

Response

Supported Media Types

application/json
application/xml

200 Response

Connection details returned successfully.

Root Schema : connection

Type: object

Show Source

aiConnection: string
availability: string
catalog: boolean
chatCredential: string
chatModel: string
datasource: string
dbDriver: string

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.
dbURL: string

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.
description: string

A descriptive string for this connection.
embedModel: string
encrypted: boolean
hidden: boolean
host: string

Host server name or IP. Required for Oracle Database connections. Required for Essbase connections, unless dbURL is used instead.
links: array links
maxPoolSize: integer(int32)

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.
minPoolSize: integer(int32)

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.
name(required): string

A name for this connection.
narrateDocDirectory: string
narrateIndexName: string
narrateProfileName: string
ociAPIFormat(required): string
ociCompartmentId: string
password: string

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

Required for file type connections. Catalog path to the file source of data. Example: /gallery/Technical/Drill Through/DrillthroughDS.csv
port: integer(int32)

Port number on the remote host. Required for connections when host is given.
region: string
repoWallet: boolean

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.
schema: string
service: string

Service name, if you are defining an Oracle Database connection.
sid: string

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

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

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

Allowed Values: [ "FILE", "DB", "ESSBASE", "BI", "AI" ]

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.
url: string
user: string

Required. User ID with authorization to access the remote source for this connection.
vectorCredential: string
walletPath: string

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.

{
    "type":"object",
    "required":[
        "name",
        "ociAPIFormat",
        "type"
    ],
    "properties":{
        "description":{
            "type":"string",
            "description":"<p>A descriptive string for this connection.</p>"
        },
        "name":{
            "type":"string",
            "description":"<p>A name for this connection.</p>"
        },
        "type":{
            "type":"string",
            "description":"<p>Required. Type of connection. <code>FILE</code> to connect to a file on the server, <code>DB</code> to connect to an external source system, or <code>ESSBASE</code> to connect to another cube.</p>",
            "enum":[
                "FILE",
                "DB",
                "ESSBASE",
                "BI",
                "AI"
            ]
        },
        "path":{
            "type":"string",
            "description":"<p>Required for file type connections. Catalog path to the file source of data. Example: /gallery/Technical/Drill Through/DrillthroughDS.csv</p>"
        },
        "catalog":{
            "type":"boolean"
        },
        "host":{
            "type":"string",
            "description":"<p>Host server name or IP. Required for Oracle Database connections. Required for Essbase connections, unless <i>dbURL</i> is used instead.</p>"
        },
        "port":{
            "type":"integer",
            "format":"int32",
            "description":"<p>Port number on the remote host. Required for connections when <i>host</i> is given.</p>"
        },
        "user":{
            "type":"string",
            "description":"<p>Required. User ID with authorization to access the remote source for this connection.</p>"
        },
        "password":{
            "type":"string",
            "description":"<p>Required. Password of the user ID with authorization to access the remote source for this connection.</p>"
        },
        "encrypted":{
            "type":"boolean"
        },
        "token":{
            "type":"string"
        },
        "sid":{
            "type":"string",
            "description":"<p>The Oracle System ID (SID) that uniquely identifies an Oracle Database. Required for Oracle Database connections unless <i>service</i> is used instead.</p>"
        },
        "service":{
            "type":"string",
            "description":"<p>Service name, if you are defining an Oracle Database connection.</p>"
        },
        "schema":{
            "type":"string"
        },
        "dbURL":{
            "type":"string",
            "description":"<p>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 <i>host</i> and <i>port</i>. Example of Essbase discovery URL <code>https://192.0.2.1:443/essbase/agent</code>. For examples of other uses, see documentation for global Get Connection endpoint.</p>"
        },
        "dbDriver":{
            "type":"string",
            "description":"<p>Optional. If <i>type</i> is <code>DB</code> and you are configuring Essbase to use a generic JDBC driver, provide the fully qualified class name of the JDBC driver. For example, <code>oracle.jdbc.driver.OracleDriver</code>.</p>"
        },
        "datasource":{
            "type":"string"
        },
        "subtype":{
            "type":"string",
            "description":"<p>The type of external source. Supported sources and versions are listed in the Database section of the certification matrix (Platform SQL table).</p>",
            "enum":[
                "TEMPLATE",
                "EXCELFILE",
                "DB",
                "DELIMITEDFILE",
                "FIXEDWIDTHFILE",
                "BI",
                "ESSBASE",
                "JDBC",
                "SPARK",
                "MS_SQL",
                "MYSQL",
                "DB2",
                "ORACLE",
                "FILE",
                "AI"
            ]
        },
        "walletPath":{
            "type":"string",
            "description":"<p>Path to a wallet file, if required for your connection to Autonomous Data Warehouse (if <i>repoWallet</i> = false). Example: <code>/system/wallets/EssbaseADWS</code>. 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.</p>"
        },
        "repoWallet":{
            "type":"boolean",
            "description":"<p>Set to <b>true</b> 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.</p>"
        },
        "minPoolSize":{
            "type":"integer",
            "format":"int32",
            "description":"<p>Minimum connection pool size. Default is 5. If you get connection errors you may need to adjust minimum and maximum connection pool sizes. See <b>About Controlling the Pool Size in UCP</b> in <i>Universal Connection Pool Developer's Guide</i>.</p>"
        },
        "maxPoolSize":{
            "type":"integer",
            "format":"int32",
            "description":"<p>Maximum connection pool size. Default is 50. If you get connection errors you may need to adjust minimum and maximum connection pool sizes. See <b>About Controlling the Pool Size in UCP</b> in <i>Universal Connection Pool Developer's Guide</i>.</p>"
        },
        "hidden":{
            "type":"boolean"
        },
        "availability":{
            "type":"string"
        },
        "aiConnection":{
            "type":"string",
            "xml":{
                "name":"ai_connection"
            }
        },
        "chatCredential":{
            "type":"string",
            "xml":{
                "name":"chat_credential"
            }
        },
        "vectorCredential":{
            "type":"string",
            "xml":{
                "name":"vector_credential"
            }
        },
        "chatModel":{
            "type":"string",
            "xml":{
                "name":"chat_model"
            }
        },
        "ociCompartmentId":{
            "type":"string",
            "xml":{
                "name":"oci_compartment_id"
            }
        },
        "region":{
            "type":"string"
        },
        "url":{
            "type":"string"
        },
        "embedModel":{
            "type":"string",
            "xml":{
                "name":"embed_model"
            }
        },
        "transferTimeout":{
            "type":"string",
            "xml":{
                "name":"transfer_timeout"
            }
        },
        "ociAPIFormat":{
            "type":"string",
            "xml":{
                "name":"oci_apiformat"
            }
        },
        "narrateIndexName":{
            "type":"string",
            "xml":{
                "name":"narrate_index_name"
            }
        },
        "narrateProfileName":{
            "type":"string",
            "xml":{
                "name":"narrate_profile_name"
            }
        },
        "narrateDocDirectory":{
            "type":"string",
            "xml":{
                "name":"narrate_doc_directory"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "xml":{
        "name":"connection"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

href: string
method: string
rel: string
type: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

400 Response

Bad Request

Failed to get connection details.

Examples

The following examples show how to get details about a specific application-level 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 - Oracle Database Connection

The following example gets details about an Oracle Database connection defined on application Sample.

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/connections/OracleDB" -H Accept:application/json -u %User%:%Password%

Example of Response Body

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

{
  "name" : "OracleDB",
  "description" : "Connection to Database",
  "type" : "DB",
  "subtype" : "ORACLE",
  "minPoolSize" : 5,
  "maxPoolSize" : 50,
  "host" : "dbhostname.example.com",
  "port" : 1521,
  "user" : "essbase"
  "sid" : "orcl",
  "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"
  } ]
}

Script with cURL Command - Connection to Autonomous Data Warehouse

The following example shows details about a connection to Autonomous Data Warehouse on Shared Infrastructure that is set up to enable Essbase to work with federated partitions. Federated partitions are supported only for Essbase deployment on Oracle Cloud Infrastructure.

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

Example of Response Body

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

{
  "name" : "FedPart_conn",
  "description" : "Connection for federated partition to Autonomous Data Warehouse",
  "type" : "DB",
  "subtype" : "ORACLE",
  "walletPath" : "/system/wallets/Sample/FedPart_conn",
  "minPoolSize" : 5,
  "maxPoolSize" : 50,
  "user" : "essbase",
  "service" : "adwsql_low",
  "links" : [ ]
}