REST API for Oracle Essbase

Get Supported Partition Types

get

/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/partitions/supportedfederatedtypes

Returns supported federated partition types.

Federated partition feature requires the following infrastructure: Essbase and Oracle Autonomous Database Serverless (with Autonomous Data Warehouse workload type) are deployed together in a shared OCI tenancy. The Autonomous Data Warehouse is the repository database for Essbase's RCU schemas.

This API returns [ "ANALYTIC_VIEW" ] if federated partitions are supported in the current environment, and an empty result otherwise.

Request

Path Parameters

applicationName(required): string

Application name.
databaseName(required): string

Database name.

Response

Supported Media Types

application/json
application/xml

200 Response

Returned supported partition types successfully.

400 Response

Bad Request

Failed to get supported types.

500 Response

Internal Server Error.

Examples

The following example shows how to determine if federated partitions are supported on an Essbase cube.

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://192.0.2.1:443/essbase/rest/v1/applications/Sample/databases/Basic/partitions/supportedfederatedtypes -H "Accept:application/json" -u %User%:%Password%

Example of Response Body

The following result means that federated partitions are supported in the current environment.

[ "ANALYTIC_VIEW" ]