REST API for Oracle Essbase

Check if Ask Essabse is Enabled

get

/essbase/rest/v1/ai/vectorindex

Checks if the Ask Essabse feature is enabled or not.

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json
application/xml

200 Response

Retrieved vector index successfully.

400 Response

Bad Request

Failed to retrieve vector index.

Examples

The following example shows how to check if the Ask Essbase feature is enabled or not.

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/ai/vectorindex" -H "accept: application/json"-u %User%:%Password%

Example of Response Body

{
    "narrate_index_name": "ASKESSBASE_VECTOR_INDEX_1760603912611",
    "status_code": 200,
    "aiConnection": "PHX-241080-GENAI",
    "narrate_doc_directory": "ASKESSBASE_DOC_1760603912611"
    }