Essbase REST Java Client

Essbase 21.8 → 26.1

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

Endpoints added in 26.1

• DELETE/ai/applications/{applicationName}/databases/{databaseName}/calculation/conversation/{conversationId}
  Drop a conversation.
• DELETE/ai/applications/{applicationName}/databases/{databaseName}/conversationHistory
  Delete conversation history
• DELETE/federatedoverdatasource/mapping
  deleteMapping
• DELETE/outline/{app}/{cube}/edit
  deleteMember
• DELETE/outline/{app}/{cube}/qedit
  deleteMember_1
• GET/ai/applications/{applicationName}/databases/{databaseName}/calculation/conversation
  List all calculation specific Conversations IDs
• GET/ai/applications/{applicationName}/databases/{databaseName}/calculation/conversation/{conversationId}
  Get all calculation specific conversations.
• GET/ai/applications/{applicationName}/databases/{databaseName}/conversation
  List conversations
• GET/ai/applications/{applicationName}/databases/{databaseName}/conversationHistory
  Get conversation history
• GET/amw
  read
• GET/backup/application/{applicationId}
  getApplicationBackups
• GET/backup/applications
  getApplications
• GET/backup/info
  getBackupInfo
• GET/backup/isrunning
  isRunning
• GET/backup/queue
  getQueueInfo
• GET/backup/settings
  getSettings
• GET/backup/settings/validation
  getSettingsValidator
• GET/backup/system
  getSystemBackups
• GET/catalog_old/{fileName}
  getFileContent
• GET/cfg
  Get Essbase Configuration.
• GET/cloudstorage/config
  Get object storage configuration
• GET/ess-mcp
  doGet
• GET/ess-mcp/tools
  listTools
• GET/fastwriteback/checkSQLload
  checkIfSQLLoad
• GET/federatedoverdatasource/av/avparams
  avParams
• GET/federatedoverdatasource/av/status
  avStatus
• GET/federatedoverdatasource/av/validate
  validate
• GET/federatedoverdatasource/cancel
  cancelRequest
• GET/federatedoverdatasource/factmanaged/settings
  factManagedSettings
• GET/federatedoverdatasource/lastcommit
  getFedVersion
• GET/federatedoverdatasource/mapping
  getMapping
• GET/federatedoverdatasource/mapping/cr
  getMappingCR
• GET/federatedoverdatasource/mapping/denormalized
  getMappingDenormalized
• GET/files/getDatabasesFromLCMZip
  Get database names from LCM zip file
• GET/logs
  Get All Server Types
• GET/logs/stream
  Return Filtered Logs
• GET/logs/{serverType}
  Download Logs for Server Type
• GET/logs/{serverType}/all
  Download All Logs
• GET/logs/{serverType}/latest
  Download Latest Log
• GET/odbc
  read_1
• GET/outline/{app}/{cube}/edit
  getMembers_1
• GET/outline/{app}/{cube}/edit/ancestors/{memberUniqueName}
  getAncestorsMemberInfo
• GET/outline/{app}/{cube}/edit/copy/status
  getCopyMembersStatus
• GET/outline/{app}/{cube}/edit/descendantsCount/{memberUniqueName}
  getDescendantsCount
• GET/outline/{app}/{cube}/edit/getRelatedInfo
  getRelatedInfo
• GET/outline/{app}/{cube}/edit/memberSelection
  memberSelection
• GET/outline/{app}/{cube}/edit/settings/aliases
  getAliasTableNames
• GET/outline/{app}/{cube}/edit/settings/hierarchyDetails
  getHierarchyDetails
• GET/outline/{app}/{cube}/edit/settings/outline
  getOutlineSettings
• GET/outline/{app}/{cube}/edit/settings/smartlist
  getAllSmartList
• GET/outline/{app}/{cube}/edit/shared
  getSharedMembers
• GET/outline/{app}/{cube}/edit/validate
  validate_1
• GET/outline/{app}/{cube}/edit/{memberUniqueName}
  getMemberInfo
• GET/outline/{app}/{cube}/qedit
  getMembers_3
• GET/outline/{app}/{cube}/qedit/ancestors/{memberUniqueName}
  getAncestorsMemberInfo_1
• GET/outline/{app}/{cube}/qedit/descendantsCount/{memberUniqueName}
  getDescendantsCount_1
• GET/outline/{app}/{cube}/qedit/memberSelection
  memberSelection_1
• GET/outline/{app}/{cube}/qedit/settings/aliases
  getAliasTableNames_1
• GET/outline/{app}/{cube}/qedit/settings/outline
  getOutlineSettings_1
• GET/outline/{app}/{cube}/qedit/settings/smartlist
  getAllSmartList_1
• GET/outline/{app}/{cube}/qedit/shared
  getSharedMembers_1
• GET/outline/{app}/{cube}/qedit/validate
  validate_2
• GET/outline/{app}/{cube}/qedit/{memberUniqueName}
  getMemberInfo_1
• GET/service/status
  getStatus
• GET/version
  getVersion
• PATCH/outline/{app}/{cube}/edit
  updateMember
• PATCH/outline/{app}/{cube}/qedit
  updateMember_1
• POST/ai/applications/{applicationName}/databases/{databaseName}/calculation/generate
  Generate calculation script.
• POST/applications/{applicationName}/databases/{databaseName}/scripts/{scriptName}/scriptops/validate
  Validate Calc Script
• POST/backup/applications
  backupApplications
• POST/backup/start
  startBackup
• POST/backup/stop
  stopBackup
• POST/cloudstorage/config/test
  Verify object storage configuration
• POST/ess-mcp
  doPost
• POST/ess-mcp/call
  callTool
• POST/event/{eventName}
  fireEvent
• POST/fastwriteback/adwload
  load
• POST/federatedoverdatasource
  report
• POST/federatedoverdatasource/av/createAv
  createAv
• POST/federatedoverdatasource/clearregions
  clear
• POST/federatedoverdatasource/saveformulas
  saveFormulas
• POST/federatedoverdatasource/saveformulas/cache
  cacheFormulas
• POST/federatedoverdatasource/writeback
  writeback
• POST/federatedsample
  report_1
• POST/outline/{app}/{cube}/edit
  outlineAction
• POST/outline/{app}/{cube}/edit/copy
  copyMembers
• POST/outline/{app}/{cube}/edit/currencyDatabase
  createCurrencyDB
• POST/outline/{app}/{cube}/edit/direct
  outlineEdit
• POST/outline/{app}/{cube}/edit/exportaliastable
  exportAliasTable
• POST/outline/{app}/{cube}/edit/importaliastable
  importAliasTable
• POST/outline/{app}/{cube}/edit/members
  getMembers
• POST/outline/{app}/{cube}/edit/motf
  setMOTF
• POST/outline/{app}/{cube}/qedit
  outlineAction_1
• POST/outline/{app}/{cube}/qedit/currencyDatabase
  createCurrencyDB_1
• POST/outline/{app}/{cube}/qedit/direct
  outlineEdit_1
• POST/outline/{app}/{cube}/qedit/members
  getMembers_2
• POST/outline/{app}/{cube}/qedit/motf
  setMOTF_1
• POST/security/syncwithidp
  syncWithIDP
• POST/service/actions/start
  start
• POST/service/actions/stop
  stop
• PUT/amw
  write
• PUT/applications/{applicationName}/databases/{databaseName}/scripts/{scriptName}/content
  uploadScriptContent
• PUT/backup/settings
  saveSettings
• PUT/cloudstorage/config
  Create or update object storage configuration
• PUT/federatedoverdatasource/mapping
  createMappingLegacy
• PUT/federatedoverdatasource/mapping/cr
  createMappingCR
• PUT/federatedoverdatasource/mapping/denormalized
  createMappingDenormalized
• PUT/federatedoverdatasource/mapping/denormalized/legacytest
  createMappingDenormalizedLegacyTest
• PUT/odbc
  write_1
• PUT/outline/{app}/{cube}/edit
  save
• PUT/outline/{app}/{cube}/qedit
  save_1

Endpoints removed in 26.1

No endpoints removed.

Endpoints changed

• DELETE/centralizedurl
  • removed response `200` - array[CentralizedURL]
• DELETE/performance/files
  • response `200`: InputStream -> object
• GET/applications/actions/name/{appVisiblity}
  • response `200`: Arrays -> object
• GET/applications/{applicationName}/connections/{connectionName}
  • added parameter `assertWallet` in `query` - boolean
• GET/applications/{applicationName}/databases/{databaseName}/partitions
  • parameter `type` in `query`: array[string{TRANSPARENT,REPLICATED,FEDERATED}] -> string{TRANSPARENT,REPLICATED,FEDERATED}
• GET/applications/{application}/databases/{database}/mdx/{name}
  • response `200`: InputStream -> (no content)
• GET/connections/{connectionName}
  • added parameter `assertWallet` in `query` - boolean
• GET/connections/{connection}/getdependentconnections
  • response `default`: (no content) -> (untyped)
• GET/files/getobjectstoreuri
  • response `default`: (no content) -> (untyped)
• GET/files/uploadconfig
  • added parameter `path` in `query` - string
  • response `default`: (no content) -> (untyped)
• GET/jobs
  • added parameter `caseSensitive` in `query` - boolean
  • added parameter `jobDateFrom` in `query` - string
  • added parameter `jobDateTo` in `query` - string
  • added parameter `jobTypeSearch` in `query` - string
  • added parameter `searchBy` in `query` - string
• GET/performance/files/actions/download
  • response `200`: InputStream -> (no content)
• GET/performance/files/{file}
  • response `200`: InputStream -> (no content)
• GET/preferences
  • added response `default` - (untyped)
  • removed response `200` - Preference
• GET/rocluster/{svrName}/appcubelist
  • response `200`: object -> string
• POST/ai/aiconnection/{aiConnectionName}/chat/profile/{profileName}
  • added parameter `description` in `query` - string
• POST/ai/applications/{applicationName}/databases/{databaseName}/mdxgenerator
  • added parameter `` in `body` - MdxGeneratorDTO
  • added parameter `isFeedback` in `query` - boolean
• POST/applications/{application}/databases/{database}/mdx
  • response `200`: InputStream -> (no content)
• POST/centralizedurl
  • removed response `200` - array[CentralizedURL]
• POST/groups/actions/delete
  • response `200`: InputStream -> object
• POST/outline/{app}/{cube}/xml
  • added parameter `app` in `path` - string (required)
  • added parameter `cube` in `path` - string (required)
  • removed parameter `<p>Application name.</p>` in `path` - string (required)
  • removed parameter `<p>Database name.</p>` in `path` - string (required)
  • response `default`: (no content) -> (untyped)
• POST/users/actions/delete
  • response `200`: InputStream -> (no content)
• PUT/files/{path}
  • response `200`: GenericEntity -> object

Models added in 26.1

• AvDdlDTO 3 properties
• AvDimDdlDTO 7 properties
• BackupConfigBean 9 properties
• CalcAssistGeneratorDTO 3 properties
• CloudStorageDetails 8 properties
• CrPartitionSettings 6 properties
• Cron 6 properties
• DenormalizedPartition 4 properties
• DimensionDTO 12 properties
• EssbaseArtifactBuilderObjectObject 0 properties
• EventParameters 2 properties
• FederatedDataDTO 6 properties
• MaintenanceWindow 2 properties
• MdxGeneratorDTO 1 properties
• MemberDTO 11 properties
• OdometerDTO 12 properties

Models removed in 26.1

• Arrays 0 properties
• DatabaseSettings 2 properties
• GenericEntity 2 properties
• InputStream 0 properties
• JAXBElement 5 properties
• JAXBElementObject 5 properties
• QName 3 properties
• SystemMaintainableResource 3 properties
• SystemMaintenanceLimits 2 properties
• Type 1 properties

Models changed

• AppEncryption
  • `key`: array[string(byte)] -> string(byte)
  • `type`: string -> string (required)
• CreateApplication
  • `appType`: string{NATIVE,UTF8} -> string{native,utf8}
• EssbaseASODbCompression
  • added `values` - EssbaseArtifactBuilderObjectObject
• GridOperation
  • `action`: string{ZOOM_IN,ZOOM_OUT,KEEP_ONLY,REMOVE_ONLY,REFRESH,PIVOT,PIVOT_TO_POV,SUBMIT} -> string{zoomin,zoomout,keeponly,removeonly,refresh,pivot,pivotToPOV,submit}
• LayoutDimension
  • `axis`: string{COLUMN,ROW,POV} -> string{Column,Row,POV}
• OtlEditMain
  • `editActions`: array[JAXBElementObject] -> array[object]
• Preferences
  • added `rowSuppression` - RowSuppression
• ROCluster
  • added `nodeVales` - array[array[string]]
• ZoomIn
  • `ancestor`: string{TOP,BOTTOM} -> string{top,bottom}
  • `mode`: string{CHILDREN,DESCENDENTS,BASE} -> string{children,descendents,base}