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

Get Global Datasources

get

/essbase/rest/v1/datasources

Returns a list of global-level Datasources, including details such as name, description, connection, and type.

Request

Query Parameters
Back to Top

Response

Supported Media Types

200 Response

OK

List of Datasources returned successfully.

Body ()
Root Schema : DatasourcesList
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : properties
Type: object
Additional Properties Allowed
Show Source
Nested Schema : datasource
Type: object
Show Source
Nested Schema : ColumnsType
Type: object
Show Source
Nested Schema : headers
Type: array
Show Source
Nested Schema : queryParameters
Type: array

Parameter implementation details, if the Datasource query is parameterized. For example, if the query includes a ? placeholder for passing a parameter, as in the following query: select * from profit_data where year=?, then you need define the implementation details.

Show Source
Nested Schema : widths
Type: array
Show Source
Nested Schema : Column
Type: array
Show Source
Nested Schema : ColumnType
Type: object
Show Source
Nested Schema : HeaderType
Type: object
Show Source
Nested Schema : QueryParamsInfo
Type: object
Show Source

  • A fixed, default parameter value that the Datasource should use as a fallback in case the parameter has an invalid context at runtime. Example: Jan. Required only if the Datasource query is parameterized (it includes a ? placeholder for passing a parameter) AND the placeholder is not intended to reference a substitution variable nor a user-defined function developed in the external source.

  • Ordinal index of the Datasource query parameter. For example, 1 for the first parameter, 2 for the second parameter, etc.

  • Optional name for the Datasource query parameter, meaningful for your use case. For example, instead of Param1 you can use param_G_month to indicate that the parameter uses a global variable for the current month, or you can rename it to param_appName_month to indicate that the parameter uses an application-level variable for the current month.

  • true if the Datasource query parameter is required, or false otherwise.

  • If useSubVariable is true, the name of an Essbase substitution variable.

  • Allowed Values: [ "STRING", "DOUBLE", "DATE", "TIMESTAMP", "LONG" ]

    Datatype of the Datasource query parameter.

  • true if the Datasource query parameter references an Essbase substitution variable, or false otherwise.

400 Response

Bad Request

Failed to get Datasources.

Back to Top

Examples

The following example shows how to get a list of global Datasources defined on the Essbase server.

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/datasources?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.

{
  "items" : [ {
    "name" : "delimitedfile_DS",
    "description" : "Datasource to text file using custom delimiter",
    "connection" : "delimitedfile_conn",
    "type" : "DELIMITEDFILE",
    "queryParameters" : [ ],
    "links" : [ ]
  }, {
    "name" : "excelDS",
    "description" : "Datasource to Excel file",
    "connection" : "excel_conn",
    "type" : "EXCELFILE",
    "queryParameters" : [ ],
    "links" : [ ]
  }, {
    "name" : "Orcl_DS",
    "description" : "Datasource to Oracle Database",
    "connection" : "oraConn",
    "type" : "DB",
    "queryParameters" : [ ],
    "links" : [ ]
  }, {
    "name" : "EssbaseDS",
    "description" : "Datasource to Essbase 2",
    "connection" : "essconn",
    "type" : "ESSBASE",
    "queryParameters" : [ ],
    "links" : [ ]
  } ],
  "offset" : 0,
  "limit" : 50,
  "count" :  4,
  "totalResults" :  4,
  "hasMore" : false
}
Back to Top