Essbase REST Java Client

Essbase 21.7 → 21.8

Description and summary text changes are ignored; everything below is a change to the shape of the API.

Endpoints added in 21.8

• DELETE/ai/aiconnection/{aiConnectionName}/chat/profile/{profileName}
  Drop OCI chat profile
• DELETE/ai/aiconnection/{aiConnectionName}/job/vectorindex
  Create a job to drop the vector index
• DELETE/ai/applications/{applicationName}/connection
  Dissociate AI connection
• DELETE/ai/dbconnection/{dbConnectionName}/chat/credential/{credentialName}
  Drop OCI chat credential
• DELETE/ai/dbconnection/{dbConnectionName}/vector/credential/{credentialName}
  Drop OCI vector credential
• GET/ai/aiconnection/{aiConnectionName}/vectorindex/{vectorIndexName}/narrate/{profileName}
  AI Narrate
• GET/ai/connection
  Get AI connection
• GET/ai/vectorindex
  Get vector index
• GET/applications/{applicationName}/datasources/{datasourceName}
  Get Application Datasource
• GET/connections/{connection}/getdependentconnections
  List dependamt connection names
• GET/datasources/{datasourceName}
  Get Global Datasource
• GET/files/getobjectstoreuri
  getObjectStoreURI
• GET/outline/{app}/{cube}/pivotDimension
  Get Pivot dimension
• POST/ai/aiconnection/{aiConnectionName}/chat/profile/{profileName}
  Create OCI chat profile
• POST/ai/aiconnection/{aiConnectionName}/job/vectorindex
  Create a job to build vector index
• POST/ai/applications/{applicationName}/chat/passThrough
  AI pass through
• POST/ai/applications/{applicationName}/connection/{connectionName}
  Associate AI connection
• POST/ai/applications/{applicationName}/databases/{databaseName}/listSampleQueries
  List Sample Queries
• POST/ai/applications/{applicationName}/databases/{databaseName}/mdxgenerator
  MDX Generator
• POST/ai/applications/{applicationName}/databases/{databaseName}/nnearestneighboursearch
  N-Nearest Neighbour Search
• POST/ai/applications/{applicationName}/databases/{databaseName}/semanticsearch
  Semantic Search
• POST/ai/applications/{applicationName}/databases/{databaseName}/vectorizationDate
  Vectorization Date
• POST/ai/applications/{applicationName}/job/vectorize/databases/{databaseName}
  Vectorize outline job
• POST/ai/dbconnection/{dbConnectionName}/chat/credential/signingkey/{credentialName}
  Create OCI chat credential using singing key
• POST/ai/dbconnection/{dbConnectionName}/vector/credential/{credentialName}
  Create OCI vector credential
• PUT/applications/{applicationName}/datasources/{datasourceName}
  Update Application Datasource
• PUT/applications/{application}/databases/{database}/queries/rename
  Rename MDX report.
• PUT/datasources/{datasourceName}
  Update Global Datasource

Endpoints removed in 21.8

• GET/applications/{applicationName}/datasources/{datasouceName}
  Get Application Datasource
• GET/datasources/{datasouceName}
  Get Global Datasource
• GET/settings/database
  Get Database Settings
• PUT/applications/{applicationName}/datasources/{datasouceName}
  Update Application Datasource
• PUT/datasources/{datasouceName}
  Update Global Datasource
• PUT/settings/database
  Store Database Settings

Endpoints changed

• DELETE/jobs/purge
  • added response `400` - (no content)
• GET/applications
  • added parameter `orderBy` in `query` - string
• GET/applications/{applicationName}/configurations
  • added parameter `orderBy` in `query` - string
• GET/applications/{applicationName}/databases
  • added parameter `orderBy` in `query` - string
• GET/applications/{applicationName}/databases/{databaseName}/reports
  • added parameter `orderBy` in `query` - string
• GET/applications/{applicationName}/databases/{databaseName}/scripts
  • added parameter `orderBy` in `query` - string
• GET/applications/{applicationName}/databases/{databaseName}/variables
  • added parameter `orderBy` in `query` - string
• GET/applications/{applicationName}/variables
  • added parameter `orderBy` in `query` - string
• GET/applications/{application}/databases/{database}/mdx/{name}
  • added parameter `aliasTable` in `query` - string
• GET/files/{path}
  • added parameter `orderBy` in `query` - string
• GET/outline/{app}/{cube}/settings/smartlist
  • parameter `applicationNameForConnection` in `query`: string -> string (required)
  • parameter `connection` in `query`: string -> string (required)
  • added response `200` - (no content)
  • removed response `default` - (no content)
• GET/variables
  • added parameter `orderBy` in `query` - string
• POST/applications/{applicationName}/connections/actions/test
  • added parameter `validateName` in `query` - boolean
• POST/applications/{applicationName}/databases/{databaseName}/grid
  • added parameter `svParity` in `query` - boolean
• POST/connections/actions/test
  • added parameter `validateName` in `query` - boolean
• POST/files/upload-commit/{path}
  • parameter `` in `body`: object -> object (required)
  • parameter `uploadId` in `query`: string -> string (required)

Models added in 21.8

• NNearestNeighbourDTO 1 properties
• OCIChatCredentialSigningKeyDTO 6 properties
• OCIVectorCredentialDTO 7 properties
• PassThroughDTO 1 properties

Models removed in 21.8

None.

Models changed

• AppEncryption
  • `type`: string (required) -> string
• Application
  • added `aiConnection` - string
• Connection
  • added `aiConnection` - string
  • added `chatCredential` - string
  • added `chatModel` - string
  • added `embedModel` - string
  • added `narrateDocDirectory` - string
  • added `narrateIndexName` - string
  • added `narrateProfileName` - string
  • added `ociAPIFormat` - string (required)
  • added `ociCompartmentId` - string
  • added `region` - string
  • added `transferTimeout` - string
  • added `url` - string
  • added `vectorCredential` - string
  • `subtype`: string{TEMPLATE,EXCELFILE,DB,DELIMITEDFILE,FIXEDWIDTHFILE,BI,ESSBASE,JDBC,SPARK,MS_SQL,MYSQL,DB2,ORACLE,FILE} -> string{TEMPLATE,EXCELFILE,DB,DELIMITEDFILE,FIXEDWIDTHFILE,BI,ESSBASE,JDBC,SPARK,MS_SQL,MYSQL,DB2,ORACLE,FILE,AI}
  • `type`: string{FILE,DB,ESSBASE,BI} (required) -> string{FILE,DB,ESSBASE,BI,AI} (required)
• Datasource
  • `type`: string{TEMPLATE,EXCELFILE,DB,DELIMITEDFILE,FIXEDWIDTHFILE,BI,ESSBASE,JDBC,SPARK,MS_SQL,MYSQL,DB2,ORACLE,FILE} (required) -> string{TEMPLATE,EXCELFILE,DB,DELIMITEDFILE,FIXEDWIDTHFILE,BI,ESSBASE,JDBC,SPARK,MS_SQL,MYSQL,DB2,ORACLE,FILE,AI} (required)
• Dimension
  • `aggregateLevelUsage`: integer(int32) -> string{DEFAULT,ALLLEVELS,NOAGGREGATION,TOPLEVELONLY,NOINTERMEDIATELEVELS,BOTTOMLEVELONLY}
  • `storageType`: string{EXISTING,STORE,NEVER_SHARE,LABEL_ONLY,DYNAMIC_CALC_STORE,DYNAMIC_CALC} -> string{EXISTING,STORE,NEVER_SHARE,LABEL_ONLY,DYNAMIC_CALC}
• EssToDsMapDTO
  • added `pivotDimension` - Dimension
• Generation
  • `columnName`: string (required) -> string
• NamedQueriesPreferences
  • added `aliasTableName` - string
• ParametersBean
  • added `backupPath` - string
  • added `pivotdimension` - string
• Query
  • added `nlq` - string
• QueryMetadata
  • added `aiGenerated` - boolean
  • added `description` - string