1. REST API for Oracle Essbase
  2. Tasks
  3. AI

Enable Ask Essbase

post

/essbase/rest/v1/ai/aiconnection/{aiConnectionName}/job/vectorindex

Enables the Ask Essbase feature.

Request

Supported Media Types
Path Parameters
Back to Top

Response

Supported Media Types

200 Response

OK

Job to build vector index was created successfully.

400 Response

Bad Request

Failed to create a job to build vector index.

Back to Top

Examples

The following example shows how to enable the Ask Essbase feature, using cURL to access the REST API from a Windows shell script.

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 POST -H "accept:application/json" "https://myserver.example.com:9001/essbase/rest/v1/ai/aiconnection/PHX-241080-GENAI/job/vectorindex" -d "" -u %User%:%Password%

Example of Response Body

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

{
  "userName": "weblogic",
  "startTime": 1760603912000,
  "startTimestm": "2025-11-16 08:38:32 UTC",
  "endTime": 1760603912000,
  "statusCode": 100,
  "statusMessgae": "In Progress",
  "jobOutputInfo": {
    "errorMessage": ""
  },
  "jobInputInfo": {
    "ai_connection_name": "PHX-241080-GENAI"
  },
  "elapsedTime": "00:00:01",
  "successJobsCount": -1,
  "runningJobsCount": -1,
  "errorJobsCount": -1,
  "warningJobsCount": -1,
  "jobRecordCount": 0,
  "job_ID": 8,
  "jobtype": "Create vector index",
  "elapsedTimeLong": 57
}
Back to Top