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

Create Application Datasource

post

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

Creates an application-level Datasource based on specified inputs. name, connection, and type are required inputs for all types of Datasource. Other required inputs differ based on the type of Datasource.

Request

Supported Media Types
Path Parameters
Body ()

Datasource details.

Root 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.

Back to Top

Response

Supported Media Types

200 Response

OK

Datasource created successfully.

400 Response

Bad Request

Failed to create Datasource.

Back to Top

Examples

The following example shows how to create an application-level Datasource.

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

curl -X POST "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/datasources" -H Accept:application/json -H Content-Type:application/json --data "@./app_DS_create.json" -u %User%:%Password%

Sample JSON Payload - Oracle Database

The cURL example above delivers the following JSON payload in app_DS_create.json.

This sample Datasource includes runtime parameter in its query. The runtime parameter is set up to use an Essbase substitution variable to filter the Oracle Database source records based on the current month.

{
  "name" : "OracleDB_DS",
  "description" : "Datasource for ORCL current month only",
  "connection" : "Sample.OracleDB",
  "type" : "DB",
  "columns" : {
    "Column" : [ {
      "name" : "DIMENSION_PRODUCT",
      "type" : "STRING",
      "index" : 1,
      "system" : false
    }, {
      "name" : "DIMENSION_MARKET",
      "type" : "STRING",
      "index" : 2,
      "system" : false
    }, {
      "name" : "DIMENSION_YEAR",
      "type" : "STRING",
      "index" : 3,
      "system" : false
    }, {
      "name" : "DIMENSION_SCENARIO",
      "type" : "STRING",
      "index" : 4,
      "system" : false
    }, {
      "name" : "SALES",
      "type" : "DOUBLE",
      "index" : 5,
      "system" : false
    }, {
      "name" : "COGS",
      "type" : "DOUBLE",
      "index" : 6,
      "system" : false
    }, {
      "name" : "MARKETING",
      "type" : "DOUBLE",
      "index" : 7,
      "system" : false
    }, {
      "name" : "PAYROLL",
      "type" : "DOUBLE",
      "index" : 8,
      "system" : false
    }, {
      "name" : "MISC",
      "type" : "DOUBLE",
      "index" : 9,
      "system" : false
    }, {
      "name" : "INITIAL_INVENTORY",
      "type" : "DOUBLE",
      "index" : 10,
      "system" : false
    }, {
      "name" : "ADDITIONS",
      "type" : "DOUBLE",
      "index" : 11,
      "system" : false
    } ]
  },
  "query" : "select * from SB_DATA where dimension_year=?",
  "queryParameters" : [ {
    "index" : 1,
    "name" : "Param1",
    "required" : false,
    "useSubVariable" : true,
    "subVariableName" : "CurrMonth",
    "type" : "STRING"
  } ]
}

For examples of Datasources created for Essbase cubes, Excel workbooks, or flat file sources, see the Create Global Datasource endpoint. The JSON payload specifications are similar.

Back to Top