Returns the roles available in Essbase. Valid type values are application and server. If type is empty, then both application and server roles are returned.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
", "operationId":"Roles.getRoles", "parameters":[ { "name":"type", "in":"query", "description":"Valid type values are application and server.
OK
Returns roles for the specified type.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Roles" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Roles" } } } } }, "x-internal-id":"roles-get", "x-filename-id":"roles-get" } }, "/ai/applications/{applicationName}/connection/{connectionName}":{ "post":{ "tags":[ "AI" ], "summary":"Associate AI Connection", "description":"Associates the AI connection for the specified application.
", "operationId":"AI.associateConnection", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"connectionName", "in":"path", "description":"Connection name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
AI connection associated successfully.
" }, "400":{ "description":"Bad Request
Failed to associate AI connection.
" } }, "x-internal-id":"ai-applications-{applicationName}-connection-{connectionName}-post", "x-filename-id":"ai-applications-applicationname-connection-connectionname-post" } }, "/ai/dbconnection/{dbConnectionName}/chat/credential/signingkey/{credentialName}":{ "post":{ "tags":[ "AI" ], "summary":"Create OCI Chat Credential using Signing Key", "description":"Creates OCI chat credential against the specified database connection using the signing key.
", "operationId":"AI.createOCIChatCredentialUsingSingingKey", "parameters":[ { "name":"dbConnectionName", "in":"path", "description":"DB connection name.
", "required":true, "schema":{ "type":"string" } }, { "name":"credentialName", "in":"path", "description":"Credential name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"OCI credential details: signing key.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/OCIChatCredentialSigningKeyDTO" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/OCIChatCredentialSigningKeyDTO" } } }, "required":true }, "responses":{ "200":{ "description":"OK
OCI chat credential using signing key created successfully.
" }, "400":{ "description":"Bad Request
Failed to create OCI chat credential using signing key.
" } }, "x-internal-id":"ai-dbconnection-{dbConnectionName}-chat-credential-signingkey-{credentialName}-post", "x-filename-id":"ai-dbconnection-dbconnectionname-chat-credential-signingkey-credentialname-post" } }, "/ai/aiconnection/{aiConnectionName}/chat/profile/{profileName}":{ "post":{ "tags":[ "AI" ], "summary":"Create OCI Chat Profile", "description":"Creates the OCI chat profile for the specified application.
", "operationId":"AI.createOCIChatProfile", "parameters":[ { "name":"aiConnectionName", "in":"path", "description":"AI Connection Name.
", "required":true, "schema":{ "type":"string" } }, { "name":"profileName", "in":"path", "description":"OCI chat profile name.
", "required":true, "schema":{ "type":"string" } }, { "name":"description", "in":"query", "description":"Description.
", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
OCI chat profile created successfully.
" }, "400":{ "description":"Bad Request
Failed to create OCI chat profile.
" } }, "x-internal-id":"ai-aiconnection-{aiConnectionName}-chat-profile-{profileName}-post", "x-filename-id":"ai-aiconnection-aiconnectionname-chat-profile-profilename-post" }, "delete":{ "tags":[ "AI" ], "summary":"Delete OCI Chat Profile", "description":"Deletes the OCI chat profile.
", "operationId":"AI.dropOCIChatProfile", "parameters":[ { "name":"aiConnectionName", "in":"path", "description":"AI Connection Name.
", "required":true, "schema":{ "type":"string" } }, { "name":"profileName", "in":"path", "description":"OCI chat profile name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
OCI chat profile dropped successfully.
" }, "400":{ "description":"Bad Request
Failed to drop OCI chat profile.
" } }, "x-internal-id":"ai-aiconnection-{aiConnectionName}-chat-profile-{profileName}-delete", "x-filename-id":"ai-aiconnection-aiconnectionname-chat-profile-profilename-delete" } }, "/ai/dbconnection/{dbConnectionName}/vector/credential/{credentialName}":{ "post":{ "tags":[ "AI" ], "summary":"Create OCI Vector Credential", "description":"Creates the OCI vector credential for the specified application.
", "operationId":"AI.createOCIVectorCredential", "parameters":[ { "name":"dbConnectionName", "in":"path", "description":"DB Connection name.
", "required":true, "schema":{ "type":"string" } }, { "name":"credentialName", "in":"path", "description":"Credential name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"OCI vector credential details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/OCIVectorCredentialDTO" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/OCIVectorCredentialDTO" } } }, "required":true }, "responses":{ "200":{ "description":"OK
OCI vector credential created successfully.
" }, "400":{ "description":"Bad Request
Failed to create OCI vector credential.
" } }, "x-internal-id":"ai-dbconnection-{dbConnectionName}-vector-credential-{credentialName}-post", "x-filename-id":"ai-dbconnection-dbconnectionname-vector-credential-credentialname-post" }, "delete":{ "tags":[ "AI" ], "summary":"Delete OCI Vector Credential", "description":"Deletes the OCI vector credential for the specified application.
", "operationId":"AI.dropOCIVectorCredential", "parameters":[ { "name":"dbConnectionName", "in":"path", "description":"DB Connection Name.
", "required":true, "schema":{ "type":"string" } }, { "name":"credentialName", "in":"path", "description":"Credential Name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
OCI vector credential dropped successfully.
" }, "400":{ "description":"Bad Request
Failed to drop OCI vector credential.
" } }, "x-internal-id":"ai-dbconnection-{dbConnectionName}-vector-credential-{credentialName}-delete", "x-filename-id":"ai-dbconnection-dbconnectionname-vector-credential-credentialname-delete" } }, "/ai/aiconnection/{aiConnectionName}/job/vectorindex":{ "post":{ "tags":[ "AI" ], "summary":"Enable Ask Essbase", "description":"Enables the Ask Essbase feature.
", "operationId":"AI.createVectorIndexJob", "parameters":[ { "name":"aiConnectionName", "in":"path", "description":"AI connection name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Job to build vector index was created successfully.
" }, "400":{ "description":"Bad Request
Failed to create a job to build vector index.
" } }, "x-internal-id":"ai-aiconnection-{aiConnectionName}-job-vectorindex-post", "x-filename-id":"ai-aiconnection-aiconnectionname-job-vectorindex-post" }, "delete":{ "tags":[ "AI" ], "summary":"Disable Ask Essbase", "description":"Disables the Ask Essbase feature.
", "operationId":"AI.dropVectorIndexJob", "parameters":[ { "name":"aiConnectionName", "in":"path", "description":"AI connection name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Job to drop the vector index was created successfully.
" }, "400":{ "description":"Bad Request
Failed to create a job to drop the vector index.
" } }, "x-internal-id":"ai-aiconnection-{aiConnectionName}-job-vectorindex-delete", "x-filename-id":"ai-aiconnection-aiconnectionname-job-vectorindex-delete" } }, "/ai/applications/{applicationName}/databases/{databaseName}/calculation/generate":{ "post":{ "tags":[ "AI" ], "summary":"Generate Calculation Script", "description":"Generates the calculation script.
", "operationId":"AI.generateCalculationScript", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Body details for generating calculation script.
", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/CalcAssistGeneratorDTO" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Calculation script generated successfully.
" }, "400":{ "description":"Bad Request
Failed to generate calculation script.
" } }, "x-internal-id":"ai-applications-{applicationName}-databases-{databaseName}-calculation-generate-post", "x-filename-id":"ai-applications-applicationname-databases-databasename-calculation-generate-post" } }, "/ai/applications/{applicationName}/databases/{databaseName}/calculation/conversation":{ "get":{ "tags":[ "AI" ], "summary":"List Calculation-specific Conversations IDs", "description":"Lists all calculation specific conversation IDs.
", "operationId":"AI.listCalculationConversations", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Conversation IDs retrieved successfully.
" }, "400":{ "description":"Bad Request
Failed to retrieve Conversations IDs.
" } }, "x-internal-id":"ai-applications-{applicationName}-databases-{databaseName}-calculation-conversation-get", "x-filename-id":"ai-applications-applicationname-databases-databasename-calculation-conversation-get" } }, "/ai/applications/{applicationName}/databases/{databaseName}/calculation/conversation/{conversationId}":{ "get":{ "tags":[ "AI" ], "summary":"Get Calculation-specific Conversation History", "description":"Gets convesation history for a specified conversations.
", "operationId":"AI.getCalculationConversations", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"conversationId", "in":"path", "description":"Conversation ID.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Conversations retrieved successfully.
" }, "400":{ "description":"Bad Request
Failed to retrieve conversations.
" } }, "x-internal-id":"ai-applications-{applicationName}-databases-{databaseName}-calculation-conversation-{conversationId}-get", "x-filename-id":"ai-applications-applicationname-databases-databasename-calculation-conversation-conversationid-get" }, "delete":{ "tags":[ "AI" ], "summary":"Delete Calculation-specific Conversation", "description":"Deletes the specified conversation.
", "operationId":"AI.deleteCalculationConversations", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"conversationId", "in":"path", "description":"Conversation ID.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Conversation dropped successfully.
" }, "400":{ "description":"Bad Request
Failed to drop conversation.
" } }, "x-internal-id":"ai-applications-{applicationName}-databases-{databaseName}-calculation-conversation-{conversationId}-delete", "x-filename-id":"ai-applications-applicationname-databases-databasename-calculation-conversation-conversationid-delete" } }, "/ai/applications/{applicationName}/databases/{databaseName}/conversation":{ "get":{ "tags":[ "AI" ], "summary":"List Conversations", "description":"Lists all conversations for the user.
", "operationId":"AI.listConversations", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Conversations retrieved successfully.
" }, "400":{ "description":"Bad Request
Failed to retrieve conversations.
" } }, "x-internal-id":"ai-applications-{applicationName}-databases-{databaseName}-conversation-get", "x-filename-id":"ai-applications-applicationname-databases-databasename-conversation-get" } }, "/ai/applications/{applicationName}/databases/{databaseName}/conversationHistory":{ "get":{ "tags":[ "AI" ], "summary":"Get Conversation History", "description":"Gets full query/response sequence for a conversation.
", "operationId":"AI.getConversationHistory", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"profileName", "in":"query", "description":"Profile name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Conversation history retrieved successfully.
" }, "400":{ "description":"Bad Request
Failed to retrieve conversation history.
" } }, "x-internal-id":"ai-applications-{applicationName}-databases-{databaseName}-conversationHistory-get", "x-filename-id":"ai-applications-applicationname-databases-databasename-conversationhistory-get" }, "delete":{ "tags":[ "AI" ], "summary":"Delete Conversation History", "description":"Deletes conversation history for the specified outline and chat profile.
", "operationId":"AI.deleteConversationHistory", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"profileName", "in":"query", "description":"profile name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Conversation history deleted successfully.
" }, "400":{ "description":"Bad Request
Failed to delete conversation history.
" } }, "x-internal-id":"ai-applications-{applicationName}-databases-{databaseName}-conversationHistory-delete", "x-filename-id":"ai-applications-applicationname-databases-databasename-conversationhistory-delete" } }, "/ai/applications/{applicationName}/connection":{ "delete":{ "tags":[ "AI" ], "summary":"Dissociate AI Connection", "description":"Dissociates the AI connection from the specified application.
", "operationId":"AI.dissociateConnection", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
AI connection dissociated successfully.
" }, "400":{ "description":"Bad Request
Failed to dissociate AI connection.
" } }, "x-internal-id":"ai-applications-{applicationName}-connection-delete", "x-filename-id":"ai-applications-applicationname-connection-delete" } }, "/ai/dbconnection/{dbConnectionName}/chat/credential/{credentialName}":{ "delete":{ "tags":[ "AI" ], "summary":"Delete OCI Chat Credential", "description":"Deletes the specified OCI chat credential.
", "operationId":"AI.dropOCIChatCredential", "parameters":[ { "name":"dbConnectionName", "in":"path", "description":"DB Connection Name.
", "required":true, "schema":{ "type":"string" } }, { "name":"credentialName", "in":"path", "description":"Credential Name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
OCI chat credential dropped successfully.
" }, "400":{ "description":"Bad Request
Failed to drop OCI chat credential.
" } }, "x-internal-id":"ai-dbconnection-{dbConnectionName}-chat-credential-{credentialName}-delete", "x-filename-id":"ai-dbconnection-dbconnectionname-chat-credential-credentialname-delete" } }, "/ai/connection":{ "get":{ "tags":[ "AI" ], "summary":"Get AI Connection", "description":"Retrieves the AI connection details.
", "operationId":"AI.getConnection", "parameters":[ { "name":"application", "in":"query", "description":"application name", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Retrieved AI connection successfully.
" }, "400":{ "description":"Bad Request
Failed to retrieve AI connection.
" } }, "x-internal-id":"ai-connection-get", "x-filename-id":"ai-connection-get" } }, "/ai/vectorindex":{ "get":{ "tags":[ "AI" ], "summary":"Check If Ask Essbase Is Enabled", "description":"Checks if the Ask Essbase feature is enabled or not.
", "operationId":"AI.getVectorIndex", "responses":{ "200":{ "description":"OK
Retrieved vector index successfully.
" }, "400":{ "description":"Bad Request
Failed to retrieve vector index.
" } }, "x-internal-id":"ai-vectorindex-get", "x-filename-id":"ai-vectorindex-get" } }, "/ai/applications/{applicationName}/databases/{databaseName}/listSampleQueries":{ "post":{ "tags":[ "AI" ], "summary":"List Sample Queries", "description":"Retrieves sample queries for an outline.
", "operationId":"AI.listSampleQueries", "parameters":[ { "name":"applicationName", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successfully retrieved sample queries." }, "400":{ "description":"Bad request. Required parameters may be missing or invalid." } }, "x-internal-id":"ai-applications-{applicationName}-databases-{databaseName}-listSampleQueries-post", "x-filename-id":"ai-applications-applicationname-databases-databasename-listsamplequeries-post" } }, "/ai/applications/{applicationName}/databases/{databaseName}/mdxgenerator":{ "post":{ "tags":[ "AI" ], "summary":"MDX Generator", "description":"Generates MDX.
", "operationId":"AI.MDXGenerator", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"profileName", "in":"query", "description":"Profile name.
", "required":true, "schema":{ "type":"string" } }, { "name":"isConvStart", "in":"query", "description":"Is Conversation Start.
", "required":true, "schema":{ "type":"boolean" } }, { "name":"nlq", "in":"query", "description":"NLQ.
", "required":true, "schema":{ "type":"string" } }, { "name":"includeAttributesInNlq", "in":"query", "description":"Include Attributes in NLQ.
", "required":true, "schema":{ "type":"boolean" } }, { "name":"prompt", "in":"query", "description":"Prompt.
", "schema":{ "type":"string" } }, { "name":"isFeedback", "in":"query", "description":"Is Feedback.
", "schema":{ "type":"boolean" } } ], "requestBody":{ "description":"Feedback details.
", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/MdxGeneratorDTO" } } } }, "responses":{ "200":{ "description":"OK
MDX Generated successfully.
" }, "400":{ "description":"Bad Request
Failed to generate MDX.
" } }, "x-internal-id":"ai-applications-{applicationName}-databases-{databaseName}-mdxgenerator-post", "x-filename-id":"ai-applications-applicationname-databases-databasename-mdxgenerator-post" } }, "/ai/applications/{applicationName}/databases/{databaseName}/nnearestneighboursearch":{ "post":{ "tags":[ "AI" ], "summary":"N-Nearest-Neighbour Search", "description":"Retrieve the N-Nearest-Neighbour.
", "operationId":"AI.nNearestNeighbourSearch", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"responseParam", "in":"query", "description":"Response parameter.
", "required":true, "schema":{ "type":"string" } }, { "name":"aliasType", "in":"query", "description":"Alias Table Name.
", "schema":{ "type":"string" } }, { "name":"topMatches", "in":"query", "description":"Top matches.
", "required":true, "schema":{ "type":"integer", "format":"int32", "default":1 } }, { "name":"threshold", "in":"query", "description":"Threshold.
", "schema":{ "type":"number", "format":"double", "default":1 } } ], "requestBody":{ "description":"N-Nearest neighbour body data.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/NNearestNeighbourDTO" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/NNearestNeighbourDTO" } } }, "required":true }, "responses":{ "200":{ "description":"OK
N-Nearest neighbour retrieved successfully.
" }, "400":{ "description":"Bad Request
Failed to retrieve n-nearest neighbour.
" } }, "x-internal-id":"ai-applications-{applicationName}-databases-{databaseName}-nnearestneighboursearch-post", "x-filename-id":"ai-applications-applicationname-databases-databasename-nnearestneighboursearch-post" } }, "/ai/aiconnection/{aiConnectionName}/vectorindex/{vectorIndexName}/narrate/{profileName}":{ "get":{ "tags":[ "AI" ], "summary":"Chat with Ask Essbase", "description":"The AI prompt to interact with the Ask Essbase feature.
", "operationId":"AI.narrateVectorIndex", "parameters":[ { "name":"aiConnectionName", "in":"path", "description":"AI connection name.
", "required":true, "schema":{ "type":"string" } }, { "name":"vectorIndexName", "in":"path", "description":"Vector index name.
", "required":true, "schema":{ "type":"string" } }, { "name":"profileName", "in":"path", "description":"Profile name.
", "required":true, "schema":{ "type":"string" } }, { "name":"docDirName", "in":"query", "description":"Name of directory where all the doc files are kept.
", "required":true, "schema":{ "type":"string" } }, { "name":"prompt", "in":"query", "description":"Prompt.
", "required":true, "schema":{ "type":"string" } }, { "name":"isConvStart", "in":"query", "description":"Is Conversation Start.
", "required":true, "schema":{ "type":"boolean" } } ], "responses":{ "200":{ "description":"OK
AI Narrate successful.
" }, "400":{ "description":"Bad Request
Failed to perform AI Narrate.
" } }, "x-internal-id":"ai-aiconnection-{aiConnectionName}-vectorindex-{vectorIndexName}-narrate-{profileName}-get", "x-filename-id":"ai-aiconnection-aiconnectionname-vectorindex-vectorindexname-narrate-profilename-get" } }, "/ai/applications/{applicationName}/chat/passThrough":{ "post":{ "tags":[ "AI" ], "summary":"AI Pass Through", "description":"Performs AI pass through for the specified application.
", "operationId":"AI.passThrough", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"profileName", "in":"query", "description":"Profile name.
", "required":true, "schema":{ "type":"string" } }, { "name":"isConvStart", "in":"query", "description":"Is Conversation Start.
", "required":true, "schema":{ "type":"boolean" } } ], "requestBody":{ "description":"Pass through prompt details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PassThroughDTO" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/PassThroughDTO" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Pass through was successful.
" }, "400":{ "description":"Bad Request
Failed to perform pass through.
" } }, "x-internal-id":"ai-applications-{applicationName}-chat-passThrough-post", "x-filename-id":"ai-applications-applicationname-chat-passthrough-post" } }, "/ai/applications/{applicationName}/databases/{databaseName}/semanticsearch":{ "post":{ "tags":[ "AI" ], "summary":"Semantic Search", "description":"Retrieves the semantic search.
", "operationId":"AI.semanticSearch", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"responseParam", "in":"query", "description":"Response Parameter.
", "required":true, "schema":{ "type":"string" } }, { "name":"aliasType", "in":"query", "description":"Alias Table Name.
", "schema":{ "type":"string" } }, { "name":"nlq", "in":"query", "description":"NLQ.
", "required":true, "schema":{ "type":"string" } }, { "name":"profileName", "in":"query", "description":"Profile Name.
", "required":true, "schema":{ "type":"string" } }, { "name":"isConvStart", "in":"query", "description":"Is Conversation Start.
", "required":true, "schema":{ "type":"boolean" } } ], "responses":{ "200":{ "description":"OK
Semantic search retrieved successfully.
" }, "400":{ "description":"Bad Request
Failed to retrieve semantic search.
" } }, "x-internal-id":"ai-applications-{applicationName}-databases-{databaseName}-semanticsearch-post", "x-filename-id":"ai-applications-applicationname-databases-databasename-semanticsearch-post" } }, "/ai/applications/{applicationName}/databases/{databaseName}/vectorizationDate":{ "post":{ "tags":[ "AI" ], "summary":"Vectorization Date", "description":"Retrieves the vectorization date for the specified application and database.
", "operationId":"AI.vectorizationDate", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Vectorization Date retrieved successfully.
" }, "400":{ "description":"Bad Request
Failed to retrieve Vectorization date.
" } }, "x-internal-id":"ai-applications-{applicationName}-databases-{databaseName}-vectorizationDate-post", "x-filename-id":"ai-applications-applicationname-databases-databasename-vectorizationdate-post" } }, "/ai/applications/{applicationName}/job/vectorize/databases/{databaseName}":{ "post":{ "tags":[ "AI" ], "summary":"Vectorize Outline Job", "description":"Vectorizes the outline job for the specified application and database.
", "operationId":"AI.vectorizeOutlineJob", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Vectorized outline successfully.
" }, "400":{ "description":"Bad Request
Failed to vectorize outline.
" } }, "x-internal-id":"ai-applications-{applicationName}-job-vectorize-databases-{databaseName}-post", "x-filename-id":"ai-applications-applicationname-job-vectorize-databases-databasename-post" } }, "/files/abort/{path}":{ "delete":{ "tags":[ "Files" ], "summary":"Abort Multipart File Upload", "description":"Terminates the multipart upload operation of a file and deletes all the uploaded parts.
", "operationId":"Files.abortUpload", "parameters":[ { "name":"path", "in":"path", "description":"Catalog path of the folder for which to terminate the multipart upload.
", "required":true, "schema":{ "pattern":".+", "type":"string" } }, { "name":"uploadId", "in":"query", "description":"Upload ID of partial file upload initiation.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"No Content
The file upload operation was terminated successfully.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"files-abort-{path}-delete", "x-filename-id":"files-abort-path-delete" } }, "/files/{path}":{ "get":{ "tags":[ "Files" ], "summary":"List or Download Files", "description":"Returns a list of files or downloads the specified file. To list files, use Accept='application/json' for the Accept header. To download, use Accept='application/octet-stream' for the Accept header.
Catalog path, starting with applications, shared, or users. If listing files, this is the folder path. If downloading files, this is the file path.
Examples:
applications/samplesharedusers/ksmithNumber of items to omit from the start of the result set. Default value is 0. Applicable only for listing files.
", "schema":{ "type":"integer", "format":"int32" } }, { "name":"limit", "in":"query", "description":"Maximum number of files to return. Applicable only for listing files.
", "schema":{ "type":"integer", "format":"int32" } }, { "name":"type", "in":"query", "description":"List files by type. If type is not specified, returns all files. Applicable only for listing files.
", "schema":{ "type":"string" } }, { "name":"orderBy", "in":"query", "description":"Order By specification in format:column:direction. For example, name:asc.
If true, overwrite files. If false, any existing file is validated but not overwritten. Applicable only with query parameters action=validateUpload and Accept='application/json' or Accept='application/xml' . Default value is false.
Validates the upload. Supported action values are validateUpload and 'Accept=application/json' or 'Accept=application/xml'.
Validates whether enough free space is available. Applicable only with query parameters action='validateUpload' and Accept='application/json' or Accept='application/xml'.
Filter the list of files.
", "schema":{ "type":"string" } }, { "name":"recursive", "in":"query", "description":"Recursive param to get search result as recursive.
", "schema":{ "type":"boolean", "default":false } } ], "responses":{ "200":{ "description":"OK
Response type can be either JSON/XML or stream, depending on the Accept header. If Accept=application/json or Accept=application/xml, the response lists files and current folder details. If Accept=application/octet-stream, the response is returned as a stream. If query parameters include action=validateUpload and Accept='application/json' or Accept='application/xml', the response is empty.
Bad Request
Logged in user may not have appropriate permissions, or the file may already exist when query parameters include action=validateUpload and Accept='application/json' or Accept='application/xml'.
Internal Server Error.
" } }, "x-internal-id":"files-{path}-get", "x-filename-id":"files-path-get" }, "put":{ "tags":[ "Files" ], "summary":"Upload File Or Create Folder", "description":"Uploads a file to Essbase.
Supported file types include text files, rules files, calculation script files, and MaxL script files.
If there is no content type, and a folder name is specified in the URL, a folder is created.
To upload a file as a single stream, the file size must be known in advance. Most HTTP clients set the Content-Length header automatically. With chunked uploads, however, the client does not send the Content-Length. In those cases, the client must set the CLI-Content-Length to the file size in bytes for a successful upload. Otherwise, the server rejects the request with File upload failed. File is empty. error.
Catalog path. If Content-Type=application/octet-stream, this is a file name. Otherwise, it is a folder name.
Applicable only for adding a file. Overwriting folders is not supported.
", "required":true, "schema":{ "type":"boolean", "default":false } }, { "name":"append", "in":"header", "description":"Append to existing file?
", "schema":{ "type":"boolean", "default":false } } ], "responses":{ "200":{ "description":"OK
The file uploaded successfully (if Content-Type is application/octet-stream), or the folder was created successfully (if there is no Content-Type).",
"content":{
"application/json":{
"schema":{
"type":"object",
"properties":{
"type":{
"type":"object",
"properties":{
"typeName":{
"type":"string"
}
}
},
"entity":{
"type":"object"
}
}
}
},
"application/xml":{
"schema":{
"type":"object",
"properties":{
"type":{
"type":"object",
"properties":{
"typeName":{
"type":"string"
}
}
},
"entity":{
"type":"object"
}
}
}
}
}
},
"400":{
"description":"
Bad Request
Logged in user may not have appropriate permissions, or the file or folder may already exist.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"files-{path}-put", "x-filename-id":"files-path-put" }, "delete":{ "tags":[ "Files" ], "summary":"Delete File Or Folder", "description":"Deletes the file or folder specified in the path.
", "operationId":"Files.deleteFile", "parameters":[ { "name":"path", "in":"path", "description":"Path of file/folder to delete", "required":true, "schema":{ "pattern":".+", "type":"string" } } ], "responses":{ "204":{ "description":"No Content
The file or folder was removed successfully.
" }, "400":{ "description":"Bad Request
Logged in user may not have appropriate permissions.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"files-{path}-delete", "x-filename-id":"files-path-delete" } }, "/files/upload-commit/{path}":{ "post":{ "tags":[ "Files" ], "summary":"Commit Multipart File Upload", "description":"Commits the upload of one or more parts from a multipart file upload. Include the part number and corresponding ETag (entity tag) value for each part.
", "operationId":"Files.uploadCommit", "parameters":[ { "name":"path", "in":"path", "description":"Catalog path of the folder to which you want to upload the file.
", "required":true, "schema":{ "pattern":".+", "type":"string" } }, { "name":"uploadId", "in":"query", "description":"Upload ID of partial file upload initiation.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Request body for committing a partial file upload. Must include an array of all part numbers and corresponding Etags (entity tags). Example: {"1":"9ac601f6-cc23-437a-9a55-93d581a150e1","2":"9ac601f6-cc23-437a-9a55-93d581a151e1"}
OK
Returns ETag for the file.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CommitFilePartUploadResponse" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/CommitFilePartUploadResponse" } } } }, "400":{ "description":"Bad Request
Error occurred while merging all the parts.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"files-upload-commit-{path}-post", "x-filename-id":"files-upload-commit-path-post" } }, "/files/actions/copy":{ "post":{ "tags":[ "Files" ], "summary":"Copy File", "description":"Copies a file from source to destination.
", "operationId":"Files.copyResource", "parameters":[ { "name":"overwrite", "in":"query", "description":"Overwrite existing file.
", "schema":{ "type":"boolean", "default":false } } ], "requestBody":{ "description":"File path details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/FilePathDetail" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/FilePathDetail" } } }, "required":true }, "responses":{ "200":{ "description":"OK
File copied successfully.
" }, "400":{ "description":"Bad Request
Logged in user may not have appropriate permissions.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"files-actions-copy-post", "x-filename-id":"files-actions-copy-post" } }, "/files/actions/extract":{ "post":{ "tags":[ "Files" ], "summary":"Extract Zip File", "description":"Extracts a zip file on same location. Supported for applications, users, and shared folders.
", "operationId":"Files.extract", "parameters":[ { "name":"overwrite", "in":"query", "description":"Overwrite existing file. Not applicable for folder.
", "schema":{ "type":"boolean", "default":false } } ], "requestBody":{ "description":"Zip file path details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ZipFileDetails" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ZipFileDetails" } } }, "required":true }, "responses":{ "200":{ "description":"OK
The file operation completed successfully.
" }, "400":{ "description":"Bad Request
Contains an invalid special character.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"files-actions-extract-post", "x-filename-id":"files-actions-extract-post" } }, "/files/actions/extractJob":{ "post":{ "tags":[ "Files" ], "summary":"Extract Zip File Using Job", "description":"Extracts a zip file on the current Essbase catalog, using a system job. Supported for applications, users and shared folders.
This endpoint is similar to Extract Zip File, except it initiates a system job you can monitor using Get Job List. Use this endpoint if you experience failures with Extract Zip File.
", "operationId":"Files.extractJob", "parameters":[ { "name":"overwrite", "in":"query", "description":"Overwrite existing file. Not applicable for folder.
", "schema":{ "type":"boolean", "default":false } } ], "requestBody":{ "description":"Zip file path details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ZipFileDetails" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ZipFileDetails" } } }, "required":true }, "responses":{ "200":{ "description":"OK
The zip file extractor job is submitted successfully.
" }, "400":{ "description":"Bad Request
The submission of zip file extractor job failed.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"files-actions-extractJob-post", "x-filename-id":"files-actions-extractjob-post" } }, "/files/getDatabasesFromLCMZip":{ "get":{ "tags":[ "Files" ], "summary":"Get Database Names from LCM Zip File", "description":"Extracts database names from the Databases folder in an LCM zip file", "operationId":"Files.getDatabasesFromLCMZip", "parameters":[ { "name":"zipFileName", "in":"query", "description":"Zip file path", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "type":"string" } }, "application/xml":{ "schema":{ "type":"string" } } } }, "400":{ "description":"Validation Failed" }, "500":{ "description":"Internal Server Error" } }, "x-internal-id":"files-getDatabasesFromLCMZip-get", "x-filename-id":"files-getdatabasesfromlcmzip-get" } }, "/files/getobjectstoreuri":{ "get":{ "tags":[ "Files" ], "summary":"Get Object Storage Uri", "description":"Gets Object Storage URI.
", "operationId":"getObjectStoreURI", "parameters":[ { "name":"path", "in":"query", "schema":{ "type":"string" } } ], "responses":{ "default":{ "description":"default response", "content":{ "text/plain":{ }, "application/xml":{ } } } }, "x-internal-id":"files-getobjectstoreuri-get", "x-filename-id":"files-getobjectstoreuri-get" } }, "/files/sharedpath":{ "get":{ "tags":[ "Files" ], "summary":"Get Shared Path", "description":"Gets the shared path in the Essbase file catalog. This directory is a safe location to store files and artifacts that you can use in more than one cube. Its contents are accessible to all users.
", "operationId":"Files.getSharedPath", "responses":{ "200":{ "description":"OK
The shared path was returned successfully.
", "content":{ "application/json":{ "schema":{ "type":"string" } }, "application/xml":{ "schema":{ "type":"string" } } } }, "400":{ "description":"Bad Request
Logged in user may not have appropriate permissions.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"files-sharedpath-get", "x-filename-id":"files-sharedpath-get" } }, "/files/uploadconfig":{ "get":{ "tags":[ "Files" ], "summary":"Get Upload Configuration", "description":"Gets upload configuration for a specified path.
The path parameter is optional. Disk properties (minimum and maximum sizes) are returned only when path is specified. If path is not provided, the default values are returned: 1 for the minimum size and -1 for the maximum size, indicating that no size limits are enforced.
Note: The upper limit is only applicable to implementations handled through disk. It is not applicable for object storage or DB storage.
", "operationId":"getUploadConfig", "parameters":[ { "name":"path", "in":"query", "description":"Catalog path of the folder to which you want to upload the file.
", "schema":{ "type":"string", "default":"" } } ], "responses":{ "default":{ "description":"default response", "content":{ "application/json":{ }, "application/xml":{ } } } }, "x-internal-id":"files-uploadconfig-get", "x-filename-id":"files-uploadconfig-get" } }, "/files/homepath":{ "get":{ "tags":[ "Files" ], "summary":"Get Home Path", "description":"Gets the home path of the current logged in user.
", "operationId":"Files.getUserHomePath", "responses":{ "200":{ "description":"OK
User home path.
", "content":{ "application/json":{ "schema":{ "type":"string" } }, "application/xml":{ "schema":{ "type":"string" } } } }, "400":{ "description":"Bad Request
Logged in user may not have appropriate permissions.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"files-homepath-get", "x-filename-id":"files-homepath-get" } }, "/files":{ "get":{ "tags":[ "Files" ], "summary":"List Root Folders", "description":"Lists catalog root folders.
", "operationId":"Files.listRootFolders", "parameters":[ { "name":"filter", "in":"query", "description":"Filter the list of files.
", "schema":{ "type":"string" } }, { "name":"recursive", "in":"query", "description":"Return search results recursively.
", "schema":{ "type":"boolean", "default":false } } ], "responses":{ "200":{ "description":"OK
Folder list.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CollectionResponse" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/CollectionResponse" } } } }, "400":{ "description":"Bad Request
Invalid path.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"files-get", "x-filename-id":"files-get" } }, "/files/actions/move":{ "post":{ "tags":[ "Files" ], "summary":"Move or Rename File", "description":"Either moves a file from source to destination or renames a file or folder. Moving a folder is not supported. Renaming a folder is supported only if the folder is not in the applications directory.
", "operationId":"Files.moveResource", "parameters":[ { "name":"overwrite", "in":"query", "description":"Overwrite existing file. Only applicable for moving or renaming a file.
", "schema":{ "type":"boolean", "default":false } } ], "requestBody":{ "description":"File path details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/FilePathDetail" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/FilePathDetail" } } }, "required":true }, "responses":{ "200":{ "description":"OK
The file operation completed successfully.
" }, "400":{ "description":"Bad Request
Logged in user may not have appropriate permissions.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"files-actions-move-post", "x-filename-id":"files-actions-move-post" } }, "/files/upload-create/{path}":{ "post":{ "tags":[ "Files" ], "summary":"Create Multipart File Upload", "description":"Initializes a file upload in parts. This operation registers the file object and returns a unique upload ID, which must be included in any request related to this file-part upload.
Multipart file upload can improve performance of uploads by parallelizing them into threads. Multipart upload also protects against needing to restart large uploads in case of network failures.
This operation is the first step in the multi-part file upload process. The next steps are to upload the file parts, and then commit the upload.
See Also
", "operationId":"Files.createUpload", "parameters":[ { "name":"path", "in":"path", "description":"Catalog path of the folder to which you want to upload the file.
", "required":true, "schema":{ "pattern":".+", "type":"string" } }, { "name":"overwrite", "in":"query", "description":"Overwrite if file exists?
", "required":true, "schema":{ "type":"boolean", "default":false } }, { "name":"append", "in":"header", "description":"Append to an existing file?
", "required":true, "schema":{ "type":"boolean", "default":false } } ], "responses":{ "200":{ "description":"OK
File registered successfully. Returns unique ID.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CreateFilePartUploadResponse" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/CreateFilePartUploadResponse" } } } }, "400":{ "description":"Bad Request
Logged in user may not have appropriate permissions, or the file may already exist.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"files-upload-create-{path}-post", "x-filename-id":"files-upload-create-path-post" } }, "/files/upload-part/{path}":{ "put":{ "tags":[ "Files" ], "summary":"Upload File Part", "description":"Uploads part of a file in a multipart file upload. You must have already initiated a multipart file upload. Provide the upload path, a part number (integer), and the unique upload ID that was returned from the Create Multipart File Upload operation.
Note: If multiple object parts are uploaded using the same upload ID and part number, the latest upload overwrites the previous.
", "operationId":"Files.uploadPart", "parameters":[ { "name":"path", "in":"path", "description":"Catalog path of the folder to which you want to upload the file.
", "required":true, "schema":{ "pattern":".+", "type":"string" } }, { "name":"partNum", "in":"query", "description":"Part number for partial file upload.
", "required":true, "schema":{ "type":"integer", "format":"int32" } }, { "name":"uploadId", "in":"query", "description":"Upload ID of partial file upload initiation.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Returns a unique ETag (entity tag). Both the part number and corresponding ETag value for each part when commit the uploaded.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UploadFilePartResponse" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/UploadFilePartResponse" } } } }, "400":{ "description":"Bad Request
If any issue while uploading parts, it returns error and all parts get clean.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"files-upload-part-{path}-put", "x-filename-id":"files-upload-part-path-put" } }, "/centralizedurl":{ "get":{ "tags":[ "CentralizedURL" ], "summary":"Get Essbase Server List", "description":"Returns the list of Essbase servers configured to access through centralized URL.
", "operationId":"centraliazedurl.getSingleURLList", "parameters":[ { "name":"filter", "in":"query", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Centralized URL list retrieved successfully.
", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/CentralizedURLRes" } } }, "application/xml":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/CentralizedURLRes" } } } } }, "400":{ "description":"Bad Request
Failed to retrieve the centralized URL list.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"centralizedurl-get", "x-filename-id":"centralizedurl-get" }, "put":{ "tags":[ "CentralizedURL" ], "summary":"Update Essbase Server in Centralized URL List", "description":"Updates the single/multiple Essbase Server URLs in the Centralized URL list.", "operationId":"CentralizedUrl.updateSingleURLProperties", "requestBody":{ "description":"Centralized URL entry", "content":{ "*/*":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/CentralizedURL" } } } }, "required":true }, "responses":{ "200":{ "description":"
OK
Updated the agent URLs successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CentralizedURL" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/CentralizedURL" } } } }, "400":{ "description":"Bad Request
Failed to update the entries. The JSON may be incorrect or provided url already exist in the list.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"centralizedurl-put", "x-filename-id":"centralizedurl-put" }, "post":{ "tags":[ "CentralizedURL" ], "summary":"Add Essbase Server to Centralized URL List", "description":"Adds new alias and agent-url pair to centralized url list", "operationId":"CentralizedUrl.addHostSingleURL", "requestBody":{ "description":"CentralizedURL entry", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/CentralizedURL" } } }, "required":true }, "responses":{ "204":{ "description":"
OK
Added alias and agent URL pair successfully to the centralized URL list.
" }, "400":{ "description":"Bad Request
Failed to add new entry to Centralized URL list. The JSON may be incorrect, or the given alias name may already exist or url specified is not an agent url.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"centralizedurl-post", "x-filename-id":"centralizedurl-post" }, "delete":{ "tags":[ "CentralizedURL" ], "summary":"Delete Essbase Server URL from Centralized URL List", "description":"Removes the single entry from Centralized URL List. You need to provide the URL encoded string value as input(aliasName).
", "operationId":"CentralizedUrl.deletSingleURLProperties", "parameters":[ { "name":"aliasName", "in":"query", "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"OK
Successfully removed the entry from the centralized URL list.
" }, "400":{ "description":"Bad Request
Failed to delete entry from centralized url list. Name specified may be incorrect or not exist.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"centralizedurl-delete", "x-filename-id":"centralizedurl-delete" } }, "/applications/{applicationName}/configurations":{ "get":{ "tags":[ "Application Configuration" ], "summary":"Get Application Configuration", "description":"Returns all the configuration properties currently set for the specified application.
", "operationId":"ApplicationConfiguration.getConfigurations", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"orderBy", "in":"query", "description":"Order By specification in format:column:direction. For example, key:asc. ",
"schema":{
"type":"string",
"default":""
}
}
],
"responses":{
"200":{
"description":"OK
Configuration properties retrieved successfully. Returns all the configuration properties which are set for the application, and the links to get, edit, or delete each property.
", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/ApplicationConfigList" } } }, "application/xml":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/ApplicationConfigList" } } } } }, "400":{ "description":"Bad Request
Failed to get the configuration properties. The application name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-configurations-get", "x-filename-id":"applications-applicationname-configurations-get" }, "put":{ "tags":[ "Application Configuration" ], "summary":"Update Application Configurations", "description":"Updates the application configurations and returns the updated configuration details.
", "operationId":"ApplicationConfiguration.setConfigurations", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Configuration property value entries.
", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/ApplicationConfigEntry" } } }, "application/xml":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/ApplicationConfigEntry" } } } }, "required":true }, "responses":{ "200":{ "description":"OK
Configurations were updated successfully. Returns the configuration details and the links to get, edit, or delete the configurations.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApplicationConfigList" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApplicationConfigList" } } } }, "400":{ "description":"Bad Request
Failed to update the configurations. The application name or configuration entries is invalid, or the given configuration property has not been added to the application.
" }, "415":{ "description":"Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-configurations-put", "x-filename-id":"applications-applicationname-configurations-put" }, "post":{ "tags":[ "Application Configuration" ], "summary":"Add Application Configuration", "description":"Adds the configuration property to the application and returns the added configuration property name.
", "operationId":"ApplicationConfiguration.addConfiguration", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Configuration property entry.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApplicationConfigEntry" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApplicationConfigEntry" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Configuration property added successfully. Returns the configuration details and the links to get, edit, or delete the configuration.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApplicationConfigEntry" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApplicationConfigEntry" } } } }, "400":{ "description":"Bad Request
Failed to add the configuration property. The application name or the configuration property JSON could be incorrect, or the configuration property might already have been added to the application.
" }, "415":{ "description":"Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-configurations-post", "x-filename-id":"applications-applicationname-configurations-post" } }, "/applications/{applicationName}/configurations/{configId}":{ "get":{ "tags":[ "Application Configuration" ], "summary":"Get Application Configuration Property", "description":"Returns configuration (based on configuration property name) from the specified application.
", "operationId":"ApplicationConfiguration.getConfiguration", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"configId", "in":"path", "description":"Configuration property name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
The configuration was retrieved successfully. Returns the configuration details and the links to get, edit, or delete the configuration.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApplicationConfigEntry" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApplicationConfigEntry" } } } }, "400":{ "description":"Bad Request
Failed to get the configuration information. The application name or configuration property is invalid.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-configurations-{configId}-get", "x-filename-id":"applications-applicationname-configurations-configid-get" }, "put":{ "tags":[ "Application Configuration" ], "summary":"Update Application Configuration", "description":"Updates the application configuration and returns the updated configuration details.
", "operationId":"ApplicationConfiguration.setConfiguration", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"configId", "in":"path", "description":"Configuration property name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Configuration property value entry.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApplicationConfigEntry" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApplicationConfigEntry" } } }, "required":true }, "responses":{ "200":{ "description":"OK
The configuration was updated successfully. Returns the configuration details and the links to get, edit, or delete the configuration.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApplicationConfigEntry" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApplicationConfigEntry" } } } }, "400":{ "description":"Bad Request
Failed to update the configuration. The application name or configuration property is invalid, or the specified configuration property has not been added to the application.
" }, "415":{ "description":"Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-configurations-{configId}-put", "x-filename-id":"applications-applicationname-configurations-configid-put" }, "delete":{ "tags":[ "Application Configuration" ], "summary":"Delete Application Configuration", "description":"Deletes the specified configuration property from the specified application.
", "operationId":"ApplicationConfiguration.deleteConfiguration", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"configId", "in":"path", "description":"Configuration property name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"No Content
The configuration was deleted successfully.
" }, "400":{ "description":"Bad Request
Failed to delete the configuration. The application name or configuration property is invalid.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-configurations-{configId}-delete", "x-filename-id":"applications-applicationname-configurations-configid-delete" } }, "/applications/{applicationName}/configurationkeys":{ "get":{ "tags":[ "Application Configuration" ], "summary":"Get Application Configuration Filtered", "description":"Returns all the configuration properties currently set for the specified application, with option to filter by configured value.
", "operationId":"ApplicationConfiguration.getConfigurationKeys", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"key", "in":"query", "description":"Filter key to refine the configuration property results.
", "schema":{ "type":"string", "default":"*" } }, { "name":"configured", "in":"query", "description":"Specify all to return all configured properties. Specify true to return enabled configuration properties. Specify false to return configuration properties that are turned off.
OK
The configuration properties were retrieved successfully.
", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/ApplicationConfigList" } } }, "application/xml":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/ApplicationConfigList" } } } } }, "400":{ "description":"Bad Request
Failed to get the configuration properties. The application name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-configurationkeys-get", "x-filename-id":"applications-applicationname-configurationkeys-get" } }, "/cubedesigner/analyze":{ "post":{ "tags":[ "Cube designer" ], "summary":"Analyze Schema", "description":"Analyzes the given fact table(s) to find column -> dimension/measure mapping.", "operationId":"aicd.analyzeschema", "parameters":[ { "name":"sessionId", "in":"query", "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AnalyzeRequest" } } } }, "responses":{ "default":{ "description":"default response", "content":{ "application/json":{ } } } }, "x-internal-id":"cubedesigner-analyze-post", "x-filename-id":"cubedesigner-analyze-post" } }, "/cubedesigner/sessions/cleanup":{ "post":{ "tags":[ "Cube designer" ], "summary":"Cleanup Sessions", "description":"Deletes idle Cube designer sessions that have not been active for the requested number of minutes.", "operationId":"aicd.cleanupsessions", "parameters":[ { "name":"idleMinutes", "in":"query", "schema":{ "type":"integer", "format":"int32" } } ], "responses":{ "default":{ "description":"default response", "content":{ "application/json":{ } } } }, "x-internal-id":"cubedesigner-sessions-cleanup-post", "x-filename-id":"cubedesigner-sessions-cleanup-post" } }, "/cubedesigner/session":{ "post":{ "tags":[ "Cube designer" ], "summary":"Create Session", "description":"Creates a new Cube designer session", "operationId":"aicd.createsession", "responses":{ "default":{ "description":"default response", "content":{ "application/json":{ } } } }, "x-internal-id":"cubedesigner-session-post", "x-filename-id":"cubedesigner-session-post" }, "delete":{ "tags":[ "Cube designer" ], "summary":"Delete Session", "description":"Deletes a Cube designer session", "operationId":"aicd.deletesession", "parameters":[ { "name":"sessionId", "in":"query", "schema":{ "type":"string" } } ], "responses":{ "default":{ "description":"default response", "content":{ "application/json":{ } } } }, "x-internal-id":"cubedesigner-session-delete", "x-filename-id":"cubedesigner-session-delete" } }, "/cubedesigner/deploy":{ "post":{ "tags":[ "Cube designer" ], "summary":"Deploy Cube", "description":"From given cube structure, creates outline rule files. and load data into the cube.", "operationId":"aicd.deploycube", "parameters":[ { "name":"sessionId", "in":"query", "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ExecuteRequest" } } } }, "responses":{ "default":{ "description":"default response", "content":{ "application/json":{ } } } }, "x-internal-id":"cubedesigner-deploy-post", "x-filename-id":"cubedesigner-deploy-post" } }, "/cubedesigner/discover":{ "post":{ "tags":[ "Cube designer" ], "summary":"Discover Relations Between Two Or More Tables", "description":"From a list of tables or full schema discovers relationships that can be used to construct dimensions", "operationId":"aicd.discover", "parameters":[ { "name":"sessionId", "in":"query", "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DiscoverRequest" } } } }, "responses":{ "default":{ "description":"default response", "content":{ "application/json":{ } } } }, "x-internal-id":"cubedesigner-discover-post", "x-filename-id":"cubedesigner-discover-post" } }, "/cubedesigner/export-osi":{ "post":{ "tags":[ "Cube designer" ], "summary":"Export Cube Creator Template", "description":"Generates an Open Semantic Interchange YAML template from the reviewed cube mapping without deploying the cube.", "operationId":"aicd.exportositemplate", "parameters":[ { "name":"sessionId", "in":"query", "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ExecuteRequest" } } } }, "responses":{ "default":{ "description":"default response", "content":{ "application/json":{ } } } }, "x-internal-id":"cubedesigner-export-osi-post", "x-filename-id":"cubedesigner-export-osi-post" } }, "/cubedesigner/analyze-logs":{ "get":{ "tags":[ "Cube designer" ], "summary":"Get Analyze Logs", "description":"Streams live analyze logs for the current cube designer session.", "operationId":"aicd.getanalyzelogs", "parameters":[ { "name":"sessionId", "in":"query", "schema":{ "type":"string" } } ], "responses":{ "default":{ "description":"default response", "content":{ "text/event-stream":{ } } } }, "x-internal-id":"cubedesigner-analyze-logs-get", "x-filename-id":"cubedesigner-analyze-logs-get" } }, "/cubedesigner/personas":{ "get":{ "tags":[ "Cube designer" ], "summary":"List Personas", "description":"Gets a list of personas available to the cube designer", "operationId":"aicd.getpersonas", "responses":{ "default":{ "description":"default response", "content":{ "application/json":{ } } } }, "x-internal-id":"cubedesigner-personas-get", "x-filename-id":"cubedesigner-personas-get" } }, "/cubedesigner/result":{ "get":{ "tags":[ "Cube designer" ], "summary":"Get Pipeline Result", "description":"Gets the latest Cube Creator pipeline status and result for a session, including YAML after completion.", "operationId":"aicd.getresult", "parameters":[ { "name":"sessionId", "in":"query", "schema":{ "type":"string" } } ], "responses":{ "default":{ "description":"default response", "content":{ "application/json":{ } } } }, "x-internal-id":"cubedesigner-result-get", "x-filename-id":"cubedesigner-result-get" } }, "/cubedesigner/recommend":{ "post":{ "tags":[ "Cube designer" ], "summary":"List Scenarios", "description":"Gets a list of scenarios available to the persona/user role", "operationId":"aicd.getscenarios", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RecommendRequest" } } } }, "responses":{ "default":{ "description":"default response", "content":{ "application/json":{ } } } }, "x-internal-id":"cubedesigner-recommend-post", "x-filename-id":"cubedesigner-recommend-post" } }, "/cubedesigner/scenarios":{ "get":{ "tags":[ "Cube designer" ], "summary":"List Scenarios", "description":"Gets a list of scenarios available to the persona/user role", "operationId":"aicd.getscenarios_1", "parameters":[ { "name":"persona", "in":"query", "schema":{ "type":"string" } } ], "responses":{ "default":{ "description":"default response", "content":{ "application/json":{ } } } }, "x-internal-id":"cubedesigner-scenarios-get", "x-filename-id":"cubedesigner-scenarios-get" } }, "/cubedesigner/import-osi":{ "post":{ "tags":[ "Cube designer" ], "summary":"Import OSI Schema", "description":"Imports an Open Semantic Interchange YAML document into the current cube designer session and return the inferred preview.", "operationId":"aicd.importosischema", "parameters":[ { "name":"sessionId", "in":"query", "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "text/plain":{ "schema":{ "type":"string" } } } }, "responses":{ "default":{ "description":"default response", "content":{ "application/json":{ } } } }, "x-internal-id":"cubedesigner-import-osi-post", "x-filename-id":"cubedesigner-import-osi-post" } }, "/cubedesigner/sessions":{ "get":{ "tags":[ "Cube designer" ], "summary":"List Sessions", "description":"Lists active cube designer sessions.", "operationId":"aicd.listsessions", "responses":{ "default":{ "description":"default response", "content":{ "application/json":{ } } } }, "x-internal-id":"cubedesigner-sessions-get", "x-filename-id":"cubedesigner-sessions-get" } }, "/cubedesigner/logs":{ "get":{ "tags":[ "Cube designer" ], "summary":"Get Pipeline Logs", "description":"From a pipeline id, gets live logs.", "operationId":"aicd.getlogs", "parameters":[ { "name":"pipelineid", "in":"query", "schema":{ "type":"string" } } ], "responses":{ "default":{ "description":"default response", "content":{ "text/event-stream":{ } } } }, "x-internal-id":"cubedesigner-logs-get", "x-filename-id":"cubedesigner-logs-get" } }, "/cubedesigner/validate-osi-schema":{ "post":{ "tags":[ "Cube designer" ], "summary":"Validate OSI Schema", "description":"Validates an Open Semantic Interchange YAML document against the bundled OSI schema.", "operationId":"aicd.validateosischema", "requestBody":{ "content":{ "text/plain":{ "schema":{ "type":"string" } } } }, "responses":{ "default":{ "description":"default response", "content":{ "application/json":{ } } } }, "x-internal-id":"cubedesigner-validate-osi-schema-post", "x-filename-id":"cubedesigner-validate-osi-schema-post" } }, "/cubedesigner/validate":{ "post":{ "tags":[ "Cube designer" ], "summary":"Validate Connection", "description":"Validates connection for select AI capability and if successful return list of tables.", "operationId":"aicd.validateconnection", "parameters":[ { "name":"sessionId", "in":"query", "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ConnectRequest" } } } }, "responses":{ "default":{ "description":"default response", "content":{ "application/json":{ } } } }, "x-internal-id":"cubedesigner-validate-post", "x-filename-id":"cubedesigner-validate-post" } }, "/applications/{applicationName}/connections":{ "get":{ "tags":[ "Application Connections" ], "summary":"List Application Connections", "description":"Returns a list of connections for the application, including details such as name, description, and type.
A connection stores information about an external server and the login credentials that are required to access it. By defining one connection that can be used by multiple processes and artifacts, you can simplify many aspects of your analytics.
", "operationId":"ApplicationConnections.getConnections", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"offset", "in":"query", "description":"Number of connections to omit from the start of the result set.
", "schema":{ "type":"integer", "format":"int32", "default":0 } }, { "name":"limit", "in":"query", "description":"Maximum number of connections to return. Default is 50.
", "schema":{ "type":"integer", "format":"int32", "default":50 } }, { "name":"connType", "in":"query", "description":"Type of connections to return, if provided
", "schema":{ "type":"string" } }, { "name":"repoConn", "in":"query", "description":"Used in conjunction with connType param. If set to true, returns repository-based Autonomous Data Warehouse connections. Default is false.
", "schema":{ "type":"boolean", "default":false } }, { "name":"walletConn", "in":"query", "description":"Used in conjunction with connType param. If set to true, returns wallet-based Autonomous Data Warehouse connections. Default is false.
", "schema":{ "type":"boolean", "default":false } } ], "responses":{ "200":{ "description":"OK
List of connections returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ConnectionsList" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ConnectionsList" } } } }, "400":{ "description":"Bad Request
Failed to list connections.
" } }, "x-internal-id":"applications-{applicationName}-connections-get", "x-filename-id":"applications-applicationname-connections-get" }, "post":{ "tags":[ "Application Connections" ], "summary":"Create Application Connection", "description":"Creates an application-level connection based on specified inputs. name and type are required inputs for all types of connections. Other required inputs differ based on the type of the connection. You must be an application manager, or a power user with application management permission to the specified application.
A connection stores information about an external server and the login credentials that are required to access it. By defining one connection that can be used by multiple processes and artifacts, you can simplify many aspects of your analytics.
If you are creating a connection to Autonomous Data Warehouse, see also Upload Application Connection Wallet File.
", "operationId":"ApplicationConnections.createConnection", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Connection details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Connection" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Connection" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Connection created successfully.
" }, "400":{ "description":"Bad Request
Failed to create connection.
" } }, "x-internal-id":"applications-{applicationName}-connections-post", "x-filename-id":"applications-applicationname-connections-post" } }, "/applications/{applicationName}/connections/{connectionName}":{ "get":{ "tags":[ "Application Connections" ], "summary":"Get Application Connection", "description":"Returns details about the specified application-level connection.
", "operationId":"ApplicationConnections.getConnectionDetails", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"password", "in":"query", "description":"If set to true, the encrypted password is returned in the result.
", "schema":{ "type":"boolean" } }, { "name":"assertWallet", "in":"query", "schema":{ "type":"boolean", "default":true } }, { "name":"connectionName", "in":"path", "description":"Connection name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Connection details returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Connection" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Connection" } } } }, "400":{ "description":"Bad Request
Failed to get connection details.
" } }, "x-internal-id":"applications-{applicationName}-connections-{connectionName}-get", "x-filename-id":"applications-applicationname-connections-connectionname-get" }, "put":{ "tags":[ "Application Connections" ], "summary":"Update Application Connection", "description":"Updates the named application connection. If successful, returns details of the updated connection. type is a required input for all connections. Other required inputs differ, depending on the type of the connection.
Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"connectionName", "in":"path", "description":"Connection name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Connection details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Connection" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Connection" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Connection updated successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Connection" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Connection" } } } }, "400":{ "description":"Bad Request
Failed to update connection.
" } }, "x-internal-id":"applications-{applicationName}-connections-{connectionName}-put", "x-filename-id":"applications-applicationname-connections-connectionname-put" }, "delete":{ "tags":[ "Application Connections" ], "summary":"Delete Application Connection", "description":"Deletes a saved application connection by name.
", "operationId":"ApplicationConnections.deleteConnection", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"connectionName", "in":"path", "description":"Connection name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"No Content
The connection was deleted successfully.
" }, "400":{ "description":"Bad Request
Failed to delete connection.
" } }, "x-internal-id":"applications-{applicationName}-connections-{connectionName}-delete", "x-filename-id":"applications-applicationname-connections-connectionname-delete" } }, "/applications/{applicationName}/connections/{connectionName}/wallet":{ "put":{ "tags":[ "Application Connections" ], "summary":"Upload Application Connection Wallet File", "description":"Uploads a wallet file for an application-level connection.
", "operationId":"ApplicationConnections.wallets", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"connectionName", "in":"path", "description":"Connection name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Return the wallet file location in catalog.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/WalletLocation" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/WalletLocation" } } } }, "400":{ "description":"Bad Request
Unable to process wallet file.
" } }, "x-internal-id":"applications-{applicationName}-connections-{connectionName}-wallet-put", "x-filename-id":"applications-applicationname-connections-connectionname-wallet-put" } }, "/applications/{applicationName}/connections/{connectionName}/actions/test":{ "post":{ "tags":[ "Application Connections" ], "summary":"Test Saved Application Connection", "description":"Tests the saved application-level connection with the specified name.
", "operationId":"ApplicationConnections.testConnectionExisting", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"connectionName", "in":"path", "description":"Saved connection name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
The connection tested successfully.
" }, "400":{ "description":"Bad Request
Error occurred while testing connection.
" } }, "x-internal-id":"applications-{applicationName}-connections-{connectionName}-actions-test-post", "x-filename-id":"applications-applicationname-connections-connectionname-actions-test-post" } }, "/applications/{applicationName}/connections/actions/test":{ "post":{ "tags":[ "Application Connections" ], "summary":"Test New Application Connection", "description":"Tests a new or updated application connection, using specified inputs, without saving it.
", "operationId":"ApplicationConnections.testConnection", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"validateName", "in":"query", "description":"Validate if connection name already exists.
", "schema":{ "type":"boolean", "default":false } } ], "requestBody":{ "description":"Connection details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Connection" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Connection" } } }, "required":true }, "responses":{ "200":{ "description":"OK
The connection tested successfully.
" }, "400":{ "description":"Bad Request
Error occurred while testing connection.
" } }, "x-internal-id":"applications-{applicationName}-connections-actions-test-post", "x-filename-id":"applications-applicationname-connections-actions-test-post" } }, "/connections/clone":{ "post":{ "tags":[ "Global Connections" ], "summary":"Clone Connection", "description":"Clones a connection from the specified source connection and application context to the specified target connection and application context.
", "operationId":"clone", "parameters":[ { "name":"from", "in":"query", "schema":{ "type":"string" } }, { "name":"fromapp", "in":"query", "schema":{ "type":"string" } }, { "name":"to", "in":"query", "schema":{ "type":"string" } }, { "name":"toapp", "in":"query", "schema":{ "type":"string" } } ], "responses":{ "default":{ "description":"default response", "content":{ "*/*":{ } } } }, "x-internal-id":"connections-clone-post", "x-filename-id":"connections-clone-post" } }, "/connections":{ "get":{ "tags":[ "Global Connections" ], "summary":"List Global Connections", "description":"Returns global connections list, including details such as name, description, and type.
", "operationId":"GlobalConnections.getConnections", "parameters":[ { "name":"offset", "in":"query", "description":"Number of connections to omit from the start of the result set.
", "schema":{ "type":"integer", "format":"int32", "default":0 } }, { "name":"limit", "in":"query", "description":"Maximum number of connections to return. Default is 50.
", "schema":{ "type":"integer", "format":"int32", "default":50 } }, { "name":"connType", "in":"query", "description":"Type of connections to return, if provided
", "schema":{ "type":"string" } }, { "name":"repoConn", "in":"query", "description":"Used in conjunction with connType param. If set to true, returns repository-based Autonomous Data Warehouse connections. Default is false
", "schema":{ "type":"boolean", "default":false } }, { "name":"walletConn", "in":"query", "description":"Used in conjunction with connType param. If set to true, returns wallet-based Autonomous Data Warehouse connections. Default is false
", "schema":{ "type":"boolean", "default":false } } ], "responses":{ "200":{ "description":"OK
List of connections returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ConnectionsList" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ConnectionsList" } } } }, "400":{ "description":"Bad Request
Failed to list connections.
" } }, "x-internal-id":"connections-get", "x-filename-id":"connections-get" }, "post":{ "tags":[ "Global Connections" ], "summary":"Create Global Connection", "description":"Creates a connection based on specified inputs. name and type are required inputs for all types of connections. Other required inputs differ based on the type of connection.
If you are creating a connection to Autonomous Data Warehouse, see also Upload Connection Wallet File.
", "operationId":"GlobalConnections.createConnection", "requestBody":{ "description":"Connection details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Connection" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Connection" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Connection created successfully.
" }, "400":{ "description":"Bad Request
Failed to create connection.
" } }, "x-internal-id":"connections-post", "x-filename-id":"connections-post" } }, "/connections/{connectionName}":{ "get":{ "tags":[ "Global Connections" ], "summary":"Get Global Connection", "description":"Returns details about the specified global connection.
", "operationId":"GlobalConnections.getConnectionDetails", "parameters":[ { "name":"password", "in":"query", "description":"If set to true, the encrypted password is returned in the result.
", "schema":{ "type":"boolean" } }, { "name":"assertWallet", "in":"query", "schema":{ "type":"boolean", "default":true } }, { "name":"connectionName", "in":"path", "description":"Connection name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Connection details returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Connection" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Connection" } } } }, "400":{ "description":"Bad Request
Failed to get connection details.
" } }, "x-internal-id":"connections-{connectionName}-get", "x-filename-id":"connections-connectionname-get" }, "put":{ "tags":[ "Global Connections" ], "summary":"Update Global Connection", "description":"Updates the named global connection. If the update is successful, returns details about the updated connection. type is a required input for all types of connections. Other required inputs differ based on the type of the connection.
Connection name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Connection details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Connection" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Connection" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Connection updated successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Connection" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Connection" } } } }, "400":{ "description":"Bad Request
Failed to update connection.
" } }, "x-internal-id":"connections-{connectionName}-put", "x-filename-id":"connections-connectionname-put" }, "delete":{ "tags":[ "Global Connections" ], "summary":"Delete Global Connection", "description":"Deletes a named global connection.
", "operationId":"GlobalConnections.deleteConnection", "parameters":[ { "name":"connectionName", "in":"path", "description":"Connection name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"No Content
The connection was deleted successfully.
" }, "400":{ "description":"Bad Request
Failed to delete the connection.
" } }, "x-internal-id":"connections-{connectionName}-delete", "x-filename-id":"connections-connectionname-delete" } }, "/connections/{connectionName}/wallet":{ "put":{ "tags":[ "Global Connections" ], "summary":"Upload Global Connection Wallet File", "description":"Uploads a connection wallet file for a global connection. Oracle client credentials (wallet files) are downloaded from Autonomous Data Warehouse by a service administrator. If you are not an Autonomous Data Warehouse administrator, your administrator should provide you with the client credentials.
", "operationId":"GlobalConnections.wallets", "parameters":[ { "name":"connectionName", "in":"path", "description":"Connection name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Return the wallet file location in catalog.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/WalletLocation" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/WalletLocation" } } } }, "400":{ "description":"Bad Request
Unable to process wallet file.
" } }, "x-internal-id":"connections-{connectionName}-wallet-put", "x-filename-id":"connections-connectionname-wallet-put" } }, "/connections/{connection}/getdependentconnections":{ "get":{ "tags":[ "Global Connections" ], "summary":"List Dependent Connection Names", "description":"Returns the names of connections that depend on the specified global connection.
", "operationId":"GlobalConnections.dependantconnections", "parameters":[ { "name":"connection", "in":"path", "required":true, "schema":{ "type":"string" } } ], "responses":{ "default":{ "description":"default response", "content":{ "application/json":{ } } } }, "x-internal-id":"connections-{connection}-getdependentconnections-get", "x-filename-id":"connections-connection-getdependentconnections-get" } }, "/connections/{connectionName}/actions/test":{ "post":{ "tags":[ "Global Connections" ], "summary":"Test Saved Global Connection", "description":"Tests a saved global connection by name.
", "operationId":"GlobalConnections.testConnectionExisting", "parameters":[ { "name":"connectionName", "in":"path", "description":"Connection name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
The connection tested successfully.
" }, "400":{ "description":"Bad Request
Error occurred while testing connection.
" } }, "x-internal-id":"connections-{connectionName}-actions-test-post", "x-filename-id":"connections-connectionname-actions-test-post" } }, "/connections/actions/test":{ "post":{ "tags":[ "Global Connections" ], "summary":"Test New Global Connection", "description":"Tests a new or updated global connection, using specified inputs, without saving it.
", "operationId":"GlobalConnections.testConnection", "parameters":[ { "name":"validateName", "in":"query", "description":"Validate if connection name already exists.
", "schema":{ "type":"boolean", "default":false } } ], "requestBody":{ "description":"Connection details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Connection" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Connection" } } }, "required":true }, "responses":{ "200":{ "description":"OK
The connection tested successfully.
" }, "400":{ "description":"Bad Request
Error occurred while testing connection.
" } }, "x-internal-id":"connections-actions-test-post", "x-filename-id":"connections-actions-test-post" } }, "/applications/{applicationName}/datasources":{ "get":{ "tags":[ "Application Datasources" ], "summary":"Get Application Datasources", "description":"Returns a list of application-level datasources, including details such as name, description, connection, and type.
", "operationId":"ApplicationDatasources.getDatasources", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"offset", "in":"query", "description":"Number of Datasources to omit from the start of the result set.
", "schema":{ "type":"integer", "format":"int32", "default":0 } }, { "name":"limit", "in":"query", "description":"Maximum number of Datasources to return. Default is 50.
", "schema":{ "type":"integer", "format":"int32", "default":50 } } ], "responses":{ "200":{ "description":"OK
List of Datasources returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatasourcesList" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/DatasourcesList" } } } }, "400":{ "description":"Bad Request
Failed to get Datasources.
" } }, "x-internal-id":"applications-{applicationName}-datasources-get", "x-filename-id":"applications-applicationname-datasources-get" }, "post":{ "tags":[ "Application Datasources" ], "summary":"Create Application Datasource", "description":"Creates an application-level datasource based on specified inputs. name, connection, and type are required inputs for all types of Datasource. Other required inputs differ based on the type of Datasource.
Application name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Datasource details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Datasource" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Datasource" } } } }, "responses":{ "200":{ "description":"OK
Datasource created successfully.
" }, "400":{ "description":"Bad Request
Failed to create Datasource.
" } }, "x-internal-id":"applications-{applicationName}-datasources-post", "x-filename-id":"applications-applicationname-datasources-post" } }, "/applications/{applicationName}/datasources/{datasourceName}":{ "get":{ "tags":[ "Application Datasources" ], "summary":"Get Application Datasource", "description":"Returns details about the specified application-level datasource.
", "operationId":"ApplicationDatasources.getDatasourceDetails", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"datasourceName", "in":"path", "description":"Datasource name
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Datasource details returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Datasource" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Datasource" } } } }, "400":{ "description":"Bad Request
Failed to get Datasource details.
" } }, "x-internal-id":"applications-{applicationName}-datasources-{datasourceName}-get", "x-filename-id":"applications-applicationname-datasources-datasourcename-get" }, "put":{ "tags":[ "Application Datasources" ], "summary":"Update Application Datasource", "description":"Updates the named application-level datasource. If the update is successful, returns details about the updated datasource. The type and connection are required inputs for all types of datasources. Other required inputs differ based on the type of the datasource.
Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"datasourceName", "in":"path", "description":"Datasource name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Updated datasource details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Datasource" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Datasource" } } } }, "responses":{ "200":{ "description":"OK
Datasource was updated successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Datasource" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Datasource" } } } }, "400":{ "description":"Bad Request
Failed to update the Datasource.
" } }, "x-internal-id":"applications-{applicationName}-datasources-{datasourceName}-put", "x-filename-id":"applications-applicationname-datasources-datasourcename-put" }, "delete":{ "tags":[ "Application Datasources" ], "summary":"Delete Application Datasource", "description":"Deletes the named application-level Datasource.
", "operationId":"ApplicationDatasources.deleteDatasource", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"datasourceName", "in":"path", "description":"Datasource name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"No Content
Datasource was deleted successfully.
" }, "400":{ "description":"Bad Request
Failed to delete Datasource.
" } }, "x-internal-id":"applications-{applicationName}-datasources-{datasourceName}-delete", "x-filename-id":"applications-applicationname-datasources-datasourcename-delete" } }, "/applications/{applicationName}/datasources/query/stream":{ "post":{ "tags":[ "Application Datasources" ], "summary":"Get Streamed Datasource Results", "description":"Returns results in stream from an application-level datasource.
", "operationId":"ApplicationDatasources.getDataStream", "parameters":[ { "name":"includeHeaders", "in":"query", "description":"Include headers with query results? If true, the first record of the results will consist of column headers.
", "schema":{ "type":"boolean", "default":false } }, { "name":"metaDataOnly", "in":"query", "description":"Stream metadata only?
", "schema":{ "type":"boolean", "default":false } }, { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Query information. Object specifying the SQL query if used, the record delimiter used in the source data, and information about any parameters associated with the Datasource.
", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/DatasourceQueryInfo" } } } }, "responses":{ "200":{ "description":"OK
Results fetched successfully.
" }, "400":{ "description":"Bad Request
Failed to stream results.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-datasources-query-stream-post", "x-filename-id":"applications-applicationname-datasources-query-stream-post" } }, "/datasources":{ "get":{ "tags":[ "Global Datasources" ], "summary":"Get Global Datasources", "description":"Returns a list of global-level Datasources, including details such as name, description, connection, and type.
", "operationId":"GlobalDatasources.getDatasources", "parameters":[ { "name":"offset", "in":"query", "description":"Number of Datasources to omit from the start of the result set.
", "schema":{ "type":"integer", "format":"int32", "default":0 } }, { "name":"limit", "in":"query", "description":"Maximum number of Datasources to return. Default is 50.
", "schema":{ "type":"integer", "format":"int32", "default":50 } } ], "responses":{ "200":{ "description":"OK
List of Datasources returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatasourcesList" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/DatasourcesList" } } } }, "400":{ "description":"Bad Request
Failed to get Datasources.
" } }, "x-internal-id":"datasources-get", "x-filename-id":"datasources-get" }, "post":{ "tags":[ "Global Datasources" ], "summary":"Create Global Datasource", "description":"Creates a global-level Datasource based on specified inputs. name, connection, and type are required inputs for all types of Datasources. Other required inputs differ based on the type of Datasource.
Datasource details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Datasource" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Datasource" } } } }, "responses":{ "200":{ "description":"OK
Datasource created successfully.
" }, "400":{ "description":"Bad Request
Failed to create Datasource.
" } }, "x-internal-id":"datasources-post", "x-filename-id":"datasources-post" } }, "/datasources/{datasourceName}":{ "get":{ "tags":[ "Global Datasources" ], "summary":"Get Global Datasource", "description":"Returns details about the specified global Datasource.
", "operationId":"GlobalDatasources.getDatasourceDetails", "parameters":[ { "name":"datasourceName", "in":"path", "description":"Datasource name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Datasource details returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Datasource" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Datasource" } } } }, "400":{ "description":"Bad Request
Failed to get Datasource details.
" } }, "x-internal-id":"datasources-{datasourceName}-get", "x-filename-id":"datasources-datasourcename-get" }, "put":{ "tags":[ "Global Datasources" ], "summary":"Update Global Datasource", "description":"Updates the named global-level Datasource. If the update is successful, returns details about the updated Datasource. type and connection are required inputs for all types of Datasources. Other required inputs differ based on the type of the Datasource.
Datasource name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Updated Datasource details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Datasource" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Datasource" } } } }, "responses":{ "200":{ "description":"OK
Datasource was updated successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Datasource" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Datasource" } } } }, "400":{ "description":"Bad Request
Failed to update the Datasource.
" } }, "x-internal-id":"datasources-{datasourceName}-put", "x-filename-id":"datasources-datasourcename-put" }, "delete":{ "tags":[ "Global Datasources" ], "summary":"Delete Global Datasource", "description":"Deletes the named global-level Datasource.
", "operationId":"GlobalDatasources.deleteDatasource", "parameters":[ { "name":"datasourceName", "in":"path", "description":"Datasource name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"No Content
Datasource was deleted successfully.
" }, "400":{ "description":"Bad Request
Failed to delete Datasource.
" } }, "x-internal-id":"datasources-{datasourceName}-delete", "x-filename-id":"datasources-datasourcename-delete" } }, "/datasources/customdelimited/query/stream":{ "post":{ "tags":[ "Global Datasources" ], "summary":"Get Streamed Global Datasource Results", "description":"Returns results in stream from a global-level Datasource.
", "operationId":"GlobalDatasources.getDataStream", "parameters":[ { "name":"includeHeaders", "in":"query", "description":"Include headers.
", "schema":{ "type":"boolean", "default":false } }, { "name":"metaDataOnly", "in":"query", "description":"Metadata Only.
", "schema":{ "type":"boolean", "default":false } } ], "requestBody":{ "description":"Query information.
", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/DatasourceQueryInfo" } } } }, "responses":{ "200":{ "description":"OK
Results fetched successfully.
" }, "400":{ "description":"Bad Request
Failed to stream results.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"datasources-customdelimited-query-stream-post", "x-filename-id":"datasources-customdelimited-query-stream-post" } }, "/datasources/query/data/{streamId}":{ "get":{ "tags":[ "Global Datasources" ], "summary":"Get Streamed Global Datasource Results By ID", "description":"Returns results from a global-level Datasource associated with the specified stream id.
", "operationId":"GlobalDatasources.getData", "parameters":[ { "name":"streamId", "in":"path", "description":"Stream id.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Results fetched successfully.
" }, "400":{ "description":"Bad Request
Failed to stream results.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"datasources-query-data-{streamId}-get", "x-filename-id":"datasources-query-data-streamid-get" } }, "/datasources/query/stream":{ "post":{ "tags":[ "Global Datasources" ], "summary":"Get Streamed Global Datasource Results", "description":"Returns results in stream from a global-level Datasource.
", "operationId":"GlobalDatasources.getDataStream_1", "parameters":[ { "name":"includeHeaders", "in":"query", "description":"Include headers.
", "schema":{ "type":"boolean", "default":false } }, { "name":"metaDataOnly", "in":"query", "description":"Metadata Only.
", "schema":{ "type":"boolean", "default":false } } ], "requestBody":{ "description":"Query information.
", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/DatasourceQueryInfo" } } } }, "responses":{ "200":{ "description":"OK
Results fetched successfully.
" }, "400":{ "description":"Bad Request
Failed to stream results.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"datasources-query-stream-post", "x-filename-id":"datasources-query-stream-post" } }, "/datasources/query":{ "post":{ "tags":[ "Global Datasources" ], "summary":"Stream Global Datasource Results", "description":"Returns column headers of the Datasource, and a link to fetch the streamed results in CSV (comma-separated) or TSV (tab-separated) formats.
", "operationId":"GlobalDatasources.getResults", "parameters":[ { "name":"pageSize", "in":"query", "description":"Number of records to return. If not passed, all records are returned.
", "schema":{ "type":"integer", "format":"int32", "default":-1 } } ], "requestBody":{ "description":"Query information.
", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/DatasourceQueryInfo" } } } }, "responses":{ "200":{ "description":"OK
Streaming information returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResultBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ResultBean" } } } }, "400":{ "description":"Bad Request
Failed to get streaming information.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"datasources-query-post", "x-filename-id":"datasources-query-post" } }, "/applications/{applicationName}/databases/{databaseName}/reports":{ "get":{ "tags":[ "Drill Through Reports" ], "summary":"Get Drill Through Reports", "description":"Returns all the drill through reports from the specified application and database.
", "operationId":"DrillThroughReports.getReports_1", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"keyword", "in":"query", "description":"Filter the list of drill-through reports using a keyword.
",
"schema":{
"type":"string",
"default":""
}
},
{
"name":"orderBy",
"in":"query",
"description":"Order By specification in format:column:direction. For example, name:asc.
OK
The drill through reports were retrieved successfully. Returns the links to get, edit, or delete the reports.
", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/ReportList" } } }, "application/xml":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/ReportList" } } } } }, "400":{ "description":"Bad Request
Failed to get the drill through reports. The application or database name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-reports-get", "x-filename-id":"applications-applicationname-databases-databasename-reports-get" }, "post":{ "tags":[ "Drill Through Reports" ], "summary":"Create Drill Through Report", "description":"Creates a drill through report definition in the specified application and database and returns details about the report. Drill through is useful when the cube contains aggregated values and an external source system has more detailed data. A drill through report definition determines the access users should have to information in the external source system.
Drill through report definitions are associated with a cube, and include a column mapping (required), a drillable region (required), and a mapping for runtime parameters (optional - can be used if the Datasource query is parameterized).
To create a drill through report definition, you must be a Database Manager or higher.
", "operationId":"DrillThroughReports.create", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Drill through report definition details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DrillthroughBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/DrillthroughBean" } } }, "required":true }, "responses":{ "200":{ "description":"OK
The drill through report definition was created successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DrillthroughBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/DrillthroughBean" } } } }, "400":{ "description":"Bad Request
Failed to create the drill through report definition. The application or database name may be incorrect, or the report may already exist.
" }, "415":{ "description":"Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-reports-post", "x-filename-id":"applications-applicationname-databases-databasename-reports-post" } }, "/applications/{applicationName}/databases/{databaseName}/reports/{name}":{ "get":{ "tags":[ "Drill Through Reports" ], "summary":"Get Drill Through Report", "description":"Returns the specified drill through report from the specified application and database.
", "operationId":"DrillThroughReports.getReport", "parameters":[ { "name":"applicationName", "in":"path", "description":"
Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"name", "in":"path", "description":"Drill through report name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
The drill through report was retrieved successfully. Returns the links to get, edit, or delete the report.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DrillthroughBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/DrillthroughBean" } } } }, "400":{ "description":"Bad Request
Failed to get the report. The application name, database name, or report name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-reports-{name}-get", "x-filename-id":"applications-applicationname-databases-databasename-reports-name-get" }, "put":{ "tags":[ "Drill Through Reports" ], "summary":"Update Drill Through Report", "description":"Updates the drill through report in the specified application and database and returns details of the updated report.
", "operationId":"DrillThroughReports.updateReport", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"name", "in":"path", "description":"Drill through report name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Drill through report details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DrillthroughBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/DrillthroughBean" } } }, "required":true }, "responses":{ "200":{ "description":"OK
The drill through report was updated successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DrillthroughBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/DrillthroughBean" } } } }, "400":{ "description":"Bad Request
Failed to update the report. The application name, database name, or report name may be incorrect, or the specified report name may not exist.
" }, "415":{ "description":"Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-reports-{name}-put", "x-filename-id":"applications-applicationname-databases-databasename-reports-name-put" }, "post":{ "tags":[ "Drill Through Reports" ], "summary":"Execute Drill Through Report", "description":"Executes a drill through report in the specified application and database, and returns records.
", "operationId":"DrillThroughReports.execute", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"name", "in":"path", "description":"Drill through report name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Drill through metadata. In the example request body, dtrContext corresponds to the intersection of cells in Smart View.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DrillthroughMetadataBean" } } }, "required":true }, "responses":{ "200":{ "description":"OK
The drillthrough report was executed successfully. Result is a JSON array where the first node is the datatype of each column, the second node is the column names, and the remaining nodes are the data nodes corresponding to each record in the report.
" }, "400":{ "description":"Bad Request
Failed to execute the drillthrough report.
" }, "415":{ "description":"Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-reports-{name}-post", "x-filename-id":"applications-applicationname-databases-databasename-reports-name-post" }, "delete":{ "tags":[ "Drill Through Reports" ], "summary":"Delete Drill Through Report", "description":"Deletes the specified drill through report from the specified application and database. To delete a drill through report definition, you must be a Database Manager or higher.
", "operationId":"DrillThroughReports.delete", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"name", "in":"path", "description":"Drill through report name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"No Content
The drill through report was deleted successfully.
" }, "400":{ "description":"Bad Request
Failed to delete the drill through report. The report name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-reports-{name}-delete", "x-filename-id":"applications-applicationname-databases-databasename-reports-name-delete" } }, "/applications/{applicationName}/databases/{databaseName}/dtreports/list":{ "post":{ "tags":[ "Drill Through Reports" ], "summary":"List Drill Through Reports for Given Cell Intersections", "description":"Gets a list of allowed drill through reports for provided cell intersections.
", "operationId":"DrillThroughReports.getReports", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DrillthroughMetadataBean" } } } }, "responses":{ "200":{ "description":"OK
The list of allowed drill through reports, for specified cell intersections, are fetched successfully.
" }, "400":{ "description":"Bad Request
Failed to fetch the drill through reports for specified cell intersections.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-dtreports-list-post", "x-filename-id":"applications-applicationname-databases-databasename-dtreports-list-post" } }, "/email/imap":{ "get":{ "tags":[ "Email" ], "summary":"Get Imap Configuration", "description":"Returns IMAP server configuration details. IMAP is the protocol Essbase uses for sending e-mails related to scenario management workflow and approval.
", "operationId":"Email.getIMAPServerDetail", "responses":{ "200":{ "description":"OK
The e-mail configuration was retrieved successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ServerConfiguration" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ServerConfiguration" } } } }, "400":{ "description":"Bad Request
Logged in user must be a service administrator to execute this request.
" }, "404":{ "description":"Not Found
The e-mail configuration is not present.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"email-imap-get", "x-filename-id":"email-imap-get" }, "put":{ "tags":[ "Email" ], "summary":"Add Imap Configuration", "description":"Configures IMAP e-mail server information. IMAP is the protocol Essbase uses for sending e-mails related to scenario management workflow and approval.
", "operationId":"Email.addIMAPDetails", "requestBody":{ "description":"IMAP server configuration details. Provide the host name, port, user e-mail address, and encoded password.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ServerConfiguration" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ServerConfiguration" } } } }, "responses":{ "200":{ "description":"OK
The e-mail configuration was updated successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ListLinkResponseObject" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ListLinkResponseObject" } } } }, "400":{ "description":"Bad Request
Logged in user must be a service administrator to execute this request.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"email-imap-put", "x-filename-id":"email-imap-put" }, "delete":{ "tags":[ "Email" ], "summary":"Delete Imap Configuration", "description":"Deletes the IMAP server configuration details. IMAP is the protocol Essbase uses to send e-mails related to scenario management workflow and approval.
", "operationId":"Email.deleteIMAPDetails", "responses":{ "204":{ "description":"No Content
The e-mail configuration was deleted successfully.
" }, "400":{ "description":"Bad Request
Logged in user must be a service administrator to execute this request.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"email-imap-delete", "x-filename-id":"email-imap-delete" } }, "/email/smtp":{ "get":{ "tags":[ "Email" ], "summary":"Get Smtp Configuration", "description":"Returns SMTP server configuration details. SMTP is the protocol Essbase uses for receiving e-mails related to scenario management workflow and approval.
", "operationId":"Email.getSMTPServerDetail", "responses":{ "200":{ "description":"OK
The e-mail configuration was retrieved successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ServerConfiguration" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ServerConfiguration" } } } }, "400":{ "description":"Bad Request
Logged in user must be a service administrator to execute this request.
" }, "404":{ "description":"Not Found
The e-mail configuration is not present.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"email-smtp-get", "x-filename-id":"email-smtp-get" }, "put":{ "tags":[ "Email" ], "summary":"Add Smtp Configuration", "description":"Configures SMTP e-mail server information. SMTP is the protocol Essbase uses for receiving e-mails related to scenario management workflow and approval.
", "operationId":"Email.addSMTPDetails", "requestBody":{ "description":"SMTP server configuration details. Provide the host name, port, user e-mail address, and encoded password.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ServerConfiguration" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ServerConfiguration" } } } }, "responses":{ "200":{ "description":"OK
The e-mail configuration was updated successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ListLinkResponseObject" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ListLinkResponseObject" } } } }, "400":{ "description":"Bad Request
Logged in user must be a service administrator to execute this request.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"email-smtp-put", "x-filename-id":"email-smtp-put" }, "delete":{ "tags":[ "Email" ], "summary":"Delete Smtp Configuration", "description":"Deletes the SMTP server configuration details. SMTP is the protocol Essbase uses for receiving e-mails related to scenario management workflow and approval.
", "operationId":"Email.deleteSMTPDetails", "responses":{ "204":{ "description":"No Content
The e-mail configuration was deleted successfully.
" }, "400":{ "description":"Bad Request
Logged in user must be a service administrator to execute this request.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"email-smtp-delete", "x-filename-id":"email-smtp-delete" } }, "/email":{ "get":{ "tags":[ "Email" ], "summary":"Get Email Configuration", "description":"Returns a URL to access the saved SMTP and IMAP server details. SMTP is the protocol Essbase uses for sending e-mails related to scenario management. IMAP is the protocol for receiving e-mails.
", "operationId":"Email.getEmailLinks", "responses":{ "200":{ "description":"OK
The e-mail configuration was retrieved successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ListLinkResponseObject" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ListLinkResponseObject" } } } }, "400":{ "description":"Bad Request
Logged in user must be a service administrator to execute this request.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"email-get", "x-filename-id":"email-get" } }, "/excel/utils/dataformat":{ "get":{ "tags":[ "Workbook Utilities" ], "summary":"Get Workbook Format", "description":"Returns details about the application workbook: application name, cube name, and whether the workbook's format is structured or unstructured (tabular).
", "operationId":"ExcelUtilities.analyzeDataFormat", "parameters":[ { "name":"path", "in":"query", "description":"Catalog path of the workbook file.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
The workbook information was retrieved successfully.
" }, "400":{ "description":"Bad Request
Failed to get the workbook details. The file path may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"excel-utils-dataformat-get", "x-filename-id":"excel-utils-dataformat-get" } }, "/applications/{applicationName}/databases/{databaseName}/filters/{filterName}/permissions":{ "get":{ "tags":[ "Filters" ], "summary":"Get Permissions", "description":"Retrieves permissions associated with the named filter.
", "operationId":"Filters.getFilterPermissions", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"filterName", "in":"path", "description":"Filter name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
The filter permissions were retrieved successfully.
", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/UserGroupProvisionInfoList" } } }, "application/xml":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/UserGroupProvisionInfoList" } } } } }, "400":{ "description":"Bad Request
Failed to get the filter permissions. The application name, database name, or filter name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-filters-{filterName}-permissions-get", "x-filename-id":"applications-applicationname-databases-databasename-filters-filtername-permissions-get" }, "put":{ "tags":[ "Filters" ], "summary":"Replace Filter Permissions", "description":"Replaces all the users and groups assigned to the filter with a new list of users and groups.
", "operationId":"Filters.replaceFilterPermission", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"filterName", "in":"path", "description":"Filter name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"User or group details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UserGroupProvisionInfoList" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/UserGroupProvisionInfoList" } } }, "required":true }, "responses":{ "200":{ "description":"OK
The filter permissions were edited successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UserGroupProvisionInfo" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/UserGroupProvisionInfo" } } } }, "400":{ "description":"Bad Request
Failed to modify the filter permissions. The application name, database name, filter name, or user or group name may be incorrect, or the specified user or group may not have enough privileges.
" }, "415":{ "description":"Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-filters-{filterName}-permissions-put", "x-filename-id":"applications-applicationname-databases-databasename-filters-filtername-permissions-put" }, "post":{ "tags":[ "Filters" ], "summary":"Add Permissions in Filter", "description":"Adds permissions in the named filter for the named user or group.
", "operationId":"Filters.addFilterPermission", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"filterName", "in":"path", "description":"Filter name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"User or group details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UserGroupProvisionInfo" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/UserGroupProvisionInfo" } } }, "required":true }, "responses":{ "200":{ "description":"OK
The filter permissions were added successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UserGroupProvisionInfo" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/UserGroupProvisionInfo" } } } }, "400":{ "description":"Bad Request
Failed to add the filter permissions. The application name, database name, filter name, or user or group name may be incorrect, or the specified user or group may not have enough privileges.
" }, "415":{ "description":"Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-filters-{filterName}-permissions-post", "x-filename-id":"applications-applicationname-databases-databasename-filters-filtername-permissions-post" } }, "/applications/{applicationName}/databases/{databaseName}/filters/filterops/copy":{ "post":{ "tags":[ "Filters" ], "summary":"Copy Filter", "description":"Copies a filter in the specified application and database and returns the new filter.
", "operationId":"Filters.copyFilter", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Filter copy details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/FilterCopy" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/FilterCopy" } } }, "required":true }, "responses":{ "200":{ "description":"OK
The filter was copied successfully. Returns filter details and links to get, edit, or delete the filter, and to get the filter rows.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/FilterBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/FilterBean" } } } }, "400":{ "description":"Bad Request
Failed to copy the filter. The application name, database name, or filter name may be incorrect, or a filter with the specified name already exists.
" }, "415":{ "description":"Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-filters-filterops-copy-post", "x-filename-id":"applications-applicationname-databases-databasename-filters-filterops-copy-post" } }, "/applications/{applicationName}/databases/{databaseName}/filters":{ "get":{ "tags":[ "Filters" ], "summary":"Get Filters", "description":"Returns all the filters from the specified application and database.
", "operationId":"Filters.listFilters", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Filters were retrieved successfully. Returns filter details and links to get, edit, or delete the filters, and to get the filter rows.
", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/FilterList" } } }, "application/xml":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/FilterList" } } } } }, "400":{ "description":"Bad Request
Failed to get filters. The application name or database name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-filters-get", "x-filename-id":"applications-applicationname-databases-databasename-filters-get" }, "post":{ "tags":[ "Filters" ], "summary":"Create Filter", "description":"Creates a filter in the specified application and database and returns the created filter.
Filters provide access restrictions on particular cells of the Essbase database (cube). System administrators can apply any filters to anyone and are unaffected by filters. Power users can define and apply filters for applications they created. Application and Database Managers can define and apply filters within their applications or cubes.
", "operationId":"Filters.createFilter", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Filter details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/FilterBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/FilterBean" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Filter was created successfully. Returns filter details and links to get, edit, or delete the filter, and to get the filter rows.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/FilterBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/FilterBean" } } } }, "400":{ "description":"Bad Request
Failed to create filter. The application name or database name may be incorrect, or the filter may already exist.
" }, "415":{ "description":"Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-filters-post", "x-filename-id":"applications-applicationname-databases-databasename-filters-post" } }, "/applications/{applicationName}/databases/{databaseName}/filters/{filterName}":{ "get":{ "tags":[ "Filters" ], "summary":"Get Filter", "description":"Returns the named filter from the specified application and database.
", "operationId":"Filters.getFilter", "parameters":[ { "name":"applicationName", "in":"path", "description":"
Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"filterName", "in":"path", "description":"Filter name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
The filter was retrieved successfully, with links to get, edit, or delete the filter, and to get the filter rows.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/FilterBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/FilterBean" } } } }, "400":{ "description":"Bad Request
Failed to get the filter. The application name, database name, or filter name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-filters-{filterName}-get", "x-filename-id":"applications-applicationname-databases-databasename-filters-filtername-get" }, "put":{ "tags":[ "Filters" ], "summary":"Update Filter", "description":"Updates the named filter in the specified application and database and returns the updated filter.
", "operationId":"Filters.editFilter", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"filterName", "in":"path", "description":"Filter name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Filter details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/FilterBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/FilterBean" } } }, "required":true }, "responses":{ "200":{ "description":"OK
The filter was updated successfully, with links to get, edit, or delete the filter, and to get the filter rows.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/FilterBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/FilterBean" } } } }, "400":{ "description":"Bad Request
Failed to update the filter. The application name, database name, or filter name may be incorrect, or the named filter may not exist.
" }, "415":{ "description":"Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-filters-{filterName}-put", "x-filename-id":"applications-applicationname-databases-databasename-filters-filtername-put" }, "delete":{ "tags":[ "Filters" ], "summary":"Delete Filter", "description":"Deletes the named filter in the specified application and database.
", "operationId":"Filters.deleteFilter", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"filterName", "in":"path", "description":"Filter name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"No Content
The filter was deleted successfully.
" }, "400":{ "description":"Bad Request
Failed to delete the filter. The application name, database name, or filter name may be incorrect, or the named filter may not exist.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-filters-{filterName}-delete", "x-filename-id":"applications-applicationname-databases-databasename-filters-filtername-delete" } }, "/applications/{applicationName}/databases/{databaseName}/filters/{filterName}/rows":{ "get":{ "tags":[ "Filters" ], "summary":"Get Filter Rows", "description":"Returns the access definition rows from the specified filter.
", "operationId":"Filters.getFilterRows", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"filterName", "in":"path", "description":"Filter name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Filter rows were retrieved successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/FilterRowList" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/FilterRowList" } } } }, "400":{ "description":"Bad Request
Failed to get filter rows. The application name, database name, or filter name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-filters-{filterName}-rows-get", "x-filename-id":"applications-applicationname-databases-databasename-filters-filtername-rows-get" } }, "/applications/{applicationName}/databases/{databaseName}/filters/{filterName}/permissions/{userGroupId}":{ "delete":{ "tags":[ "Filters" ], "summary":"Delete Permission from Filter", "description":"Removes permissions from a filter for the specified user or group.
", "operationId":"Filters.removeFilterPermission", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"filterName", "in":"path", "description":"Filter name.
", "required":true, "schema":{ "type":"string" } }, { "name":"userGroupId", "in":"path", "description":"User or group ID.
", "required":true, "schema":{ "type":"string" } }, { "name":"group", "in":"query", "description":"True if the userGroupId refers to a group; false if it refers to a user.
", "required":true, "schema":{ "type":"boolean", "default":false } } ], "responses":{ "204":{ "description":"No Content
The permission was removed successfully.
" }, "400":{ "description":"Bad Request
Failed to remove permission from the filter. An input parameter may have been specified incorrectly.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-filters-{filterName}-permissions-{userGroupId}-delete", "x-filename-id":"applications-applicationname-databases-databasename-filters-filtername-permissions-usergroupid-delete" } }, "/applications/{applicationName}/databases/{databaseName}/filters/filterops/rename":{ "post":{ "tags":[ "Filters" ], "summary":"Rename Filter", "description":"Renames the filter in the specified application and database and returns the created filter", "operationId":"Filters.renameFilter", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Filter rename details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/FilterCopy" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/FilterCopy" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Filter was renamed successfully. Returns filter details and links to get, edit, or delete the filter, and to get the filter rows.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/FilterBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/FilterBean" } } } }, "400":{ "description":"Bad Request
Failed to rename filter. The application name or database name may be incorrect, or a filter with that name may already exist.
" }, "415":{ "description":"Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-filters-filterops-rename-post", "x-filename-id":"applications-applicationname-databases-databasename-filters-filterops-rename-post" } }, "/applications/{applicationName}/databases/{databaseName}/filters/filterops/validate":{ "post":{ "tags":[ "Filters" ], "summary":"Validate Filter", "description":"Validates the filter in the specified application and database.
", "operationId":"Filters.validateFilter", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Filter details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/FilterBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/FilterBean" } } }, "required":true }, "responses":{ "200":{ "description":"OK
The filter was validated successfully.
" }, "400":{ "description":"Bad Request
Failed to validate the filter. The application name or database name may be incorrect, or the filter rows may be incomplete." }, "415":{ "description":"
Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-filters-filterops-validate-post", "x-filename-id":"applications-applicationname-databases-databasename-filters-filterops-validate-post" } }, "/groups":{ "get":{ "tags":[ "Groups" ], "summary":"Search or Export Groups", "description":"Gets a list of groups based on search results, or exports groups as CSV file.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
", "operationId":"Groups.search", "parameters":[ { "name":"filter", "in":"query", "description":"Group ID wildcard pattern. Filter by name of groups if header Accept='application/json' or Accept='application/xml'.
Maximum number of groups to return, if header Accept='application/json' or Accept='application/xml'.
Value can be all or none. Default value is all, meaning service role and parent groups are returned for each group. If none is specified, service role and parent groups are not returned.
OK
List of groups matching search criteria. Response type can be either JSON, XML, or CSV stream, depending on the Accept header. If Accept='application/json' or Accept='application/xml', the search result is returned in the response. If Accept='application/octet-stream', search result is returned as stream (not shown due to a Swagger limitation).
Bad Request
Logged in user may not have appropriate permissions.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"groups-get", "x-filename-id":"groups-get" }, "post":{ "tags":[ "Groups" ], "summary":"Add or Import Groups", "description":"Adds or imports one or more groups.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
", "operationId":"Groups.add", "requestBody":{ "description":"Group details to add group if header Content-Type='application/json' or 'application/xml'; otherwise, if header Content-Type='application/octet-stream', CSV file to import group(s).
OK
Group added successfully. For Content-Type='application/json' or 'application/xml', added group is returned; otherwise, for Content-Type='application/octet-stream', the group was imported successfully.
Bad Request
Logged in user may not have appropriate permissions.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"groups-post", "x-filename-id":"groups-post" } }, "/groups/{id}/members/groups":{ "get":{ "tags":[ "Groups" ], "summary":"Get Groups in Group", "description":"Gets group members of a group.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
", "operationId":"Groups.getGroupMembersOfGroup", "parameters":[ { "name":"id", "in":"path", "description":"ID of group.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Returns list of group members of a group.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Groups" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Groups" } } } }, "400":{ "description":"Bad Request
Logged in user may not have appropriate permissions.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"groups-{id}-members-groups-get", "x-filename-id":"groups-id-members-groups-get" }, "post":{ "tags":[ "Groups" ], "summary":"Add Groups to Group", "description":"Adds multiple group members to a group.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
", "operationId":"Groups.addGroupMembersToGroup", "parameters":[ { "name":"id", "in":"path", "description":"ID of group.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Array of group IDs.
", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "type":"string" } } }, "application/xml":{ "schema":{ "type":"array", "items":{ "type":"string" } } } }, "required":true }, "responses":{ "200":{ "description":"OK
Group updated successfully. Returns link to get group members of a group.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UserBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/UserBean" } } } }, "400":{ "description":"Bad Request
Logged in user may not have appropriate permissions.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"groups-{id}-members-groups-post", "x-filename-id":"groups-id-members-groups-post" }, "delete":{ "tags":[ "Groups" ], "summary":"Remove Groups from Group", "description":"Removes multiple group members from a group.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
", "operationId":"Groups.removeGroupMembersFromGroup", "parameters":[ { "name":"id", "in":"path", "description":"ID of group.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Array of group IDs.
", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "type":"string" } } }, "application/xml":{ "schema":{ "type":"array", "items":{ "type":"string" } } } }, "required":true }, "responses":{ "200":{ "description":"OK
Group updated successfully. Returns link to get group members of a group.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UserBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/UserBean" } } } }, "400":{ "description":"Bad Request
Logged in user may not have appropriate permissions.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"groups-{id}-members-groups-delete", "x-filename-id":"groups-id-members-groups-delete" } }, "/groups/{id}/members/users":{ "get":{ "tags":[ "Groups" ], "summary":"Get Group Users", "description":"Gets user members of a group.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
", "operationId":"Groups.getUserMembersOfGroup", "parameters":[ { "name":"id", "in":"path", "description":"ID of group.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Group member list returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Users" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Users" } } } }, "400":{ "description":"Bad Request
Logged in user may not have appropriate permissions.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"groups-{id}-members-users-get", "x-filename-id":"groups-id-members-users-get" }, "post":{ "tags":[ "Groups" ], "summary":"Add Group Users", "description":"Adds multiple user members to a group.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
", "operationId":"Groups.addUserMembersToGroup", "parameters":[ { "name":"id", "in":"path", "description":"ID of group.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Array of user IDs.
", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "type":"string" } } }, "application/xml":{ "schema":{ "type":"array", "items":{ "type":"string" } } } }, "required":true }, "responses":{ "200":{ "description":"OK
Group updated successfully. Returns link to get user members of a group.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UserBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/UserBean" } } } }, "400":{ "description":"Bad Request
Logged in user may not have appropriate permissions.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"groups-{id}-members-users-post", "x-filename-id":"groups-id-members-users-post" }, "delete":{ "tags":[ "Groups" ], "summary":"Remove Group Users", "description":"Removes multiple user members from a group.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
", "operationId":"Groups.removeUserMembersFromGroup", "parameters":[ { "name":"id", "in":"path", "description":"ID of group.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Array of user IDs.
", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "type":"string" } } }, "application/xml":{ "schema":{ "type":"array", "items":{ "type":"string" } } } }, "required":true }, "responses":{ "200":{ "description":"OK
Group updated successfully. Returns link to get user members of a group.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UserBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/UserBean" } } } }, "400":{ "description":"Bad Request
Logged in user may not have appropriate permissions.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"groups-{id}-members-users-delete", "x-filename-id":"groups-id-members-users-delete" } }, "/groups/{id}":{ "get":{ "tags":[ "Groups" ], "summary":"Get Group", "description":"Gets group details.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
", "operationId":"Groups.get", "parameters":[ { "name":"id", "in":"path", "description":"Group ID.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Group details
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GroupBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/GroupBean" } } } }, "404":{ "description":"Not Found
The group with that ID does not exist.
" }, "400":{ "description":"Bad Request
Logged in user may not have appropriate permissions.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"groups-{id}-get", "x-filename-id":"groups-id-get" }, "put":{ "tags":[ "Groups" ], "summary":"Update Group", "description":"Updates a group.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
", "operationId":"Groups.edit", "parameters":[ { "name":"id", "in":"path", "description":"ID of group.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Group details to update.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GroupBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/GroupBean" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Group updated successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GroupBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/GroupBean" } } } }, "400":{ "description":"Bad Request
Logged in user may not have appropriate permissions.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"groups-{id}-put", "x-filename-id":"groups-id-put" }, "delete":{ "tags":[ "Groups" ], "summary":"Delete Group", "description":"Deletes a group.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
", "operationId":"Groups.delete", "parameters":[ { "name":"id", "in":"path", "description":"ID of group.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"No Content
Group deleted successfully.
" }, "400":{ "description":"Bad Request
Logged in user may not have appropriate permissions.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"groups-{id}-delete", "x-filename-id":"groups-id-delete" } }, "/groups/actions/delete":{ "post":{ "tags":[ "Groups" ], "summary":"Delete Groups in File", "description":"Deletes the groups specified in the text file.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
", "operationId":"Users.deleteGroups", "responses":{ "200":{ "description":"OK", "content":{ "application/octet-stream":{ "schema":{ "type":"object" } } } }, "400":{ "description":"Bad Request
Logged in user may not have appropriate permissions.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"groups-actions-delete-post", "x-filename-id":"groups-actions-delete-post" } }, "/groups/{id}/members":{ "get":{ "tags":[ "Groups" ], "summary":"Get Group Members", "description":"Returns links to get user and group members of a group.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
", "operationId":"Groups.getMembers", "parameters":[ { "name":"id", "in":"path", "description":"ID of group.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
User and group members of a group returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UserBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/UserBean" } } } } }, "x-internal-id":"groups-{id}-members-get", "x-filename-id":"groups-id-members-get" } }, "/jobs/{id}":{ "get":{ "tags":[ "Jobs" ], "summary":"Get Job", "description":"Returns job information for given job ID, including job status, type, and input and output information.
", "operationId":"Jobs.getJobInfo", "parameters":[ { "name":"id", "in":"path", "description":"Job ID", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Job information returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JobRecordBean" } } } }, "500":{ "description":"Internal Server Error.
" }, "503":{ "description":"Service Unavailable
Naming exception or server exception.
" } }, "x-internal-id":"jobs-{id}-get", "x-filename-id":"jobs-id-get" }, "post":{ "tags":[ "Jobs" ], "summary":"Rerun Job", "description":"Reruns the job, returning job information and new job ID.
", "operationId":"Jobs.executeByJobId", "parameters":[ { "name":"id", "in":"path", "description":"Job ID.
", "required":true, "schema":{ "type":"integer", "format":"int64" } } ], "responses":{ "200":{ "description":"OK
Job information returned successfully for newly created job ID.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JobRecordBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/JobRecordBean" } } } }, "500":{ "description":"Internal Server Error.
" }, "503":{ "description":"Service Unavailable
Naming exception or server exception. Job ID is incorrect or invalid.
" } }, "x-internal-id":"jobs-{id}-post", "x-filename-id":"jobs-id-post" } }, "/jobs":{ "get":{ "tags":[ "Jobs" ], "summary":"Get Job List", "description":"Returns job list for the given query parameters, including job status, type, and input and output information. If no query parameter is specified, returns a list of all the jobs.
", "operationId":"Jobs.getAllJobRecords", "parameters":[ { "name":"keyword", "in":"query", "description":"Filter the job records using a keyword that may be part of the job ID, application name, database name, job file name (script), or username. If this parameter and fullAppName are both specified, fullAppName takes precedence.
", "schema":{ "type":"string", "default":"" } }, { "name":"fullAppName", "in":"query", "description":"Application name for which to retrieve job records.
", "schema":{ "type":"string", "default":"" } }, { "name":"fullDatabaseName", "in":"query", "description":"Database name for which to retrieve job records.
", "schema":{ "type":"string", "default":"" } }, { "name":"orderBy", "in":"query", "description":"Order By specification. By default, jobs records are returned by job IDs in descending order.
", "schema":{ "type":"string", "default":"job_ID:desc" } }, { "name":"offset", "in":"query", "description":"Number of jobs to omit from the start of the result set.
", "schema":{ "type":"integer", "format":"int64", "default":0 } }, { "name":"limit", "in":"query", "description":"Maximum number of jobs to fetch.
", "schema":{ "type":"integer", "format":"int64", "default":50 } }, { "name":"systemjobs", "in":"query", "description":"Include backup jobs in jobs records.
", "schema":{ "type":"boolean", "default":false } }, { "name":"caseSensitive", "in":"query", "description":"Flag to determine if filters should be case-sensitive. Default: false. Set to true for case-sensitive matching, false for case-insensitive matching.
Defines the specific field to apply the search on. Supported fields: job_ID (Job ID), appName (Application Name), dbName (Database Name), jobtype (Job Type), script (Script Name), userName (User Name). Default: ALL. Default behavior: If field is not provided, the search is applied across all supported fields.
Job type for which to retrieve job records. Default: ALL.
Filters job records starting from this date and time (inclusive). Default: Empty.
Filters job records up to this date and time (inclusive). Default: Empty.
OK
Job records returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JobRecordPaginatedResultWrapper" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/JobRecordPaginatedResultWrapper" } } } }, "500":{ "description":"Internal Server Error.
" }, "503":{ "description":"Service Unavailable
Naming exception or server exception.
" } }, "x-internal-id":"jobs-get", "x-filename-id":"jobs-get" }, "post":{ "tags":[ "Jobs" ], "summary":"Execute Job", "description":"Executes the job and returns the record containing job information, such as job ID, status, inputs, and output information for the current job.
", "operationId":"Jobs.executeJob", "requestBody":{ "description":"Parameter provided as json string in the request body.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JobsInputBean" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Job started successfully. Job information returned in response.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JobRecordBean" } } } }, "400":{ "description":"Bad Request
Application may not exist, or application parameter may be incorrect. Or, database may not exist, or database parameter may be incorrect. Or a null argument may have been passed.
" }, "500":{ "description":"Internal Server Error.
" }, "503":{ "description":"Service Unavailable
Naming exception or server exception.
" } }, "x-internal-id":"jobs-post", "x-filename-id":"jobs-post" } }, "/jobs/statistics/{userId}":{ "get":{ "tags":[ "Jobs" ], "summary":"Get Job Statistics", "description":"Returns the job statistics for the currently logged in user, including number of jobs that are successful, number of jobs containing errors, number of jobs containing warnings, and the number of jobs running.
", "operationId":"Jobs.getJobStatistics", "parameters":[ { "name":"userId", "in":"path", "description":"User ID of the logged in user", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Job statistics returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JobStatisticsBean" } } } }, "500":{ "description":"Internal Server Error.
" }, "503":{ "description":"Naming Exception or Server Exception.
" } }, "x-internal-id":"jobs-statistics-{userId}-get", "x-filename-id":"jobs-statistics-userid-get" } }, "/jobs/purge":{ "delete":{ "tags":[ "Jobs" ], "summary":"Delete Jobs", "description":"Deletes jobs data based on query parameters.
", "operationId":"Jobs.purge", "parameters":[ { "name":"olderthan", "in":"query", "description":"Time in milliseconds, if you want to remove jobs data older than the specified time.
", "schema":{ "type":"integer", "format":"int64" } }, { "name":"rangeStartTime", "in":"query", "description":"Start Time range in milliseconds.
", "schema":{ "type":"integer", "format":"int64" } }, { "name":"rangeEndTime", "in":"query", "description":"End Time range in milliseconds.
", "schema":{ "type":"integer", "format":"int64" } }, { "name":"application", "in":"query", "description":"Application name.
", "schema":{ "type":"string" } }, { "name":"database", "in":"query", "description":"Database name.
", "schema":{ "type":"string" } }, { "name":"jobtype", "in":"query", "description":"The type of job. Examples: dataload, dimbuild, calc, clear, importExcel, exportExcel, lcmExport, lcmImport, clearAggregation, buildAggregation, asoBufferDataLoad, asoBufferCommit, exportData, mdxScript.
Job Status code.
| Status code | Meaning |
|---|---|
| 100 | In progress |
| 200 | Completed |
| 300 | Completed with warnings |
| 400 | Failed |
OK
Purge request executed successfully.
" }, "400":{ "description":"Invalid Inputs.
" }, "500":{ "description":"Internal Server Error.
" }, "503":{ "description":"Service Unavailable
Naming exception or server exception.
" } }, "x-internal-id":"jobs-purge-delete", "x-filename-id":"jobs-purge-delete" } }, "/applications/{applicationName}/databases/{databaseName}/locationaliases":{ "get":{ "tags":[ "Location Aliases" ], "summary":"Get Location Aliases", "description":"Gets details about location aliases defined on the database.
", "operationId":"LocationAliases.getLocationAliases", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"offset", "in":"query", "description":"Number of items to omit from the start of the result set.
", "schema":{ "type":"integer", "format":"int32" } }, { "name":"limit", "in":"query", "description":"Maximum number of location aliases to return.
", "schema":{ "type":"integer", "format":"int32" } }, { "name":"serverName", "in":"query", "description":"Location alias target server name.
", "schema":{ "type":"string" } }, { "name":"applicationName", "in":"query", "description":"Location alias target application name.
", "schema":{ "type":"string" } }, { "name":"databaseName", "in":"query", "description":"Location alias target database name.
", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Location aliases returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/LocationAliasList" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/LocationAliasList" } } } }, "400":{ "description":"Bad Request
Failed to get location alias details.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-locationaliases-get", "x-filename-id":"applications-applicationname-databases-databasename-locationaliases-get" }, "post":{ "tags":[ "Location Aliases" ], "summary":"Create Location Alias", "description":"Create a new location alias in the given application and database (cube).
A location alias is a named pointer to the location of another cube. You can define the alias using a saved connection or embed the details of the secondary cube within the definition. You should create location alias on the cube from which the calculation scripts are run.
", "operationId":"LocationAliases.create", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name for the database/cube to which the location alias refers.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Name of the database to which the location alias refers.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Location alias definition details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/LocationAliasBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/LocationAliasBean" } } }, "required":true }, "responses":{ "204":{ "description":"OK
Location alias created successfully.
" }, "400":{ "description":"Bad Request
Failed to create location alias.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-locationaliases-post", "x-filename-id":"applications-applicationname-databases-databasename-locationaliases-post" } }, "/applications/{applicationName}/databases/{databaseName}/locationaliases/{aliasName}":{ "get":{ "tags":[ "Location Aliases" ], "summary":"Get Location Alias", "description":"Gets details of the specified location alias.
", "operationId":"LocationAliases.getLocationAlias", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"aliasName", "in":"path", "description":"Location alias name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Location alias returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/LocationAliasBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/LocationAliasBean" } } } }, "400":{ "description":"Bad Request
Failed to get location alias details.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-locationaliases-{aliasName}-get", "x-filename-id":"applications-applicationname-databases-databasename-locationaliases-aliasname-get" }, "delete":{ "tags":[ "Location Aliases" ], "summary":"Delete Location Alias", "description":"Deletes the specified location alias from the application and database.
", "operationId":"LocationAliases.delete", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"aliasName", "in":"path", "description":"Location alias name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"OK
Location alias deleted successfully.
" }, "400":{ "description":"Bad Request
Failed to delete location alias.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-locationaliases-{aliasName}-delete", "x-filename-id":"applications-applicationname-databases-databasename-locationaliases-aliasname-delete" }, "patch":{ "tags":[ "Location Aliases" ], "summary":"Update Location Alias", "description":"Updates location alias with new application and database. Not supported when location alias is defined across Essbase instances.
", "operationId":"LocationAliases.update", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name for the database/cube to which the location alias refers.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Name of the database to which the location alias refers.
", "required":true, "schema":{ "type":"string" } }, { "name":"aliasName", "in":"path", "description":"Location alias name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Location alias details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/LocationAliasBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/LocationAliasBean" } } }, "required":true }, "responses":{ "204":{ "description":"OK
Location alias updated successfully.
" }, "400":{ "description":"Bad Request
Failed to update location alias.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-locationaliases-{aliasName}-patch", "x-filename-id":"applications-applicationname-databases-databasename-locationaliases-aliasname-patch" } }, "/applications/{applicationName}/databases/{databaseName}/locks/blocks":{ "get":{ "tags":[ "Locks" ], "summary":"List Locked Blocks", "description":"Gets all the locked blocks from the specified application and database.
", "operationId":"Locks.getLockedBlocks", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"offset", "in":"query", "description":"Number of items to omit from the start of the result set.
", "schema":{ "type":"integer", "format":"int32", "default":0 } }, { "name":"limit", "in":"query", "description":"Maximum number of blocks to return. Default is 50.", "schema":{ "type":"integer", "format":"int32", "default":50 } } ], "responses":{ "200":{ "description":"OK
Locked blocks returned successfully, including details of locked blocks and links to unlock the objects.
", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/LockBlockList" } } }, "application/xml":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/LockBlockList" } } } } }, "400":{ "description":"Bad Request
Failed to get the locked blocks. The application or database name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-locks-blocks-get", "x-filename-id":"applications-applicationname-databases-databasename-locks-blocks-get" } }, "/applications/{applicationName}/databases/{databaseName}/locks/objects":{ "get":{ "tags":[ "Locks" ], "summary":"List Locked Objects", "description":"Gets all the locked objects from the specified application and database.
", "operationId":"Locks.getLockedObjects", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"offset", "in":"query", "description":"Number of items to omit from the start of the result set. Default value is 0.
", "schema":{ "type":"integer", "format":"int32", "default":0 } }, { "name":"limit", "in":"query", "description":"Maximum number of objects to return. Default is 50.
", "schema":{ "type":"integer", "format":"int32", "default":50 } } ], "responses":{ "200":{ "description":"OK
Locked objects retrieved successfully. Gives the details of locked objects along with the links to lock/unlock the object.
", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/LockObjectList" } } }, "application/xml":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/LockObjectList" } } } } }, "400":{ "description":"Bad Request
Failed to get the locked objects. The application or database name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-locks-objects-get", "x-filename-id":"applications-applicationname-databases-databasename-locks-objects-get" } }, "/applications/{applicationName}/databases/{databaseName}/locks":{ "get":{ "tags":[ "Locks" ], "summary":"List Locks", "description":"Gets links for locked objects and locked blocks from the specified application and database.
", "operationId":"Locks.getLocks", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Locks listed successfully, including links to unlock.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/LockObject" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/LockObject" } } } }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-locks-get", "x-filename-id":"applications-applicationname-databases-databasename-locks-get" } }, "/applications/{applicationName}/databases/{databaseName}/locks/objects/lock":{ "post":{ "tags":[ "Locks" ], "summary":"Lock Object", "description":"Locks the object in the specified application and database and returns the details of the locked object.
", "operationId":"Locks.lockObject", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Details of object to be locked.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/LockObject" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Object locked successfully. Gives the details of locked object along with the links to lock/unlock the object.
", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/LockObject" } } } }, "400":{ "description":"Bad Request
Failed to lock the object. The application, database, or object name may be incorrect, or the object type may be incorrect.
" }, "415":{ "description":"Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-locks-objects-lock-post", "x-filename-id":"applications-applicationname-databases-databasename-locks-objects-lock-post" } }, "/applications/{applicationName}/databases/{databaseName}/locks/blocks/unlock":{ "post":{ "tags":[ "Locks" ], "summary":"Unlock Block", "description":"Unlocks the locked block in the specified application and database.
", "operationId":"Locks.unLockBlock", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Block details to be unlocked.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/LockBlock" } } }, "required":true }, "responses":{ "204":{ "description":"OK
Block unlocked successfully.
" }, "400":{ "description":"Bad Request
Failed to get the settings. The application or database name may be incorrect, or the JSON for the username in the block details may be incorrect.
" }, "415":{ "description":"Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-locks-blocks-unlock-post", "x-filename-id":"applications-applicationname-databases-databasename-locks-blocks-unlock-post" } }, "/applications/{applicationName}/databases/{databaseName}/locks/objects/unlock":{ "post":{ "tags":[ "Locks" ], "summary":"Unlock Object", "description":"Unlocks the object in the specified application and database.
", "operationId":"Locks.unLockObject", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Details about object to be unlocked.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/LockObject" } } }, "required":true }, "responses":{ "204":{ "description":"OK
Object unlocked successfully.
" }, "400":{ "description":"Bad Request
Failed to unlock the object. The application, database, or object name may be incorrect, or the object type may be incorrect.
" }, "415":{ "description":"Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-locks-objects-unlock-post", "x-filename-id":"applications-applicationname-databases-databasename-locks-objects-unlock-post" } }, "/applications/{applicationName}/logs/all":{ "get":{ "tags":[ "Application Logs" ], "summary":"Download All Application Logs", "description":"Downloads a zip file which contains all log files for the specific application.
", "operationId":"ApplicationLogs.downloadAllLogFiles", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Logs returned successfully.
" }, "400":{ "description":"Bad Request
Failed to return logs.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-logs-all-get", "x-filename-id":"applications-applicationname-logs-all-get" } }, "/applications/{applicationName}/logs":{ "get":{ "tags":[ "Application Logs" ], "summary":"Download Application Logs", "description":"Gets links to download all log files as a zip file, and to download the latest log file.
", "operationId":"ApplicationLogs.downloadAppLogFiles", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
List of URI links returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Link" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Link" } } } }, "400":{ "description":"Bad Request
Failed to return downloadable log files.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-logs-get", "x-filename-id":"applications-applicationname-logs-get" } }, "/applications/{applicationName}/logs/latest":{ "get":{ "tags":[ "Application Logs" ], "summary":"Download Latest Application Log", "description":"Downloads the latest application log file as a text file.
", "operationId":"ApplicationLogs.downloadLatestLogFile", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Log file returned successfully.
" }, "400":{ "description":"Bad Request
Failed to return log file.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-logs-latest-get", "x-filename-id":"applications-applicationname-logs-latest-get" } }, "/logs/{serverType}/all":{ "get":{ "tags":[ "Server logs" ], "summary":"Download All Logs", "description":"Returns stream or downloadable zip file containing all log files for the specified server type.
", "operationId":"ServerLogs.downloadAllLogFiles", "parameters":[ { "name":"serverType", "in":"path", "description":"Server type", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Logs returned successfully.
" }, "400":{ "description":"Bad Request
Failed to return logs.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"logs-{serverType}-all-get", "x-filename-id":"logs-servertype-all-get" } }, "/logs/{serverType}/latest":{ "get":{ "tags":[ "Server logs" ], "summary":"Download Latest Log", "description":"Download the latest generated application log file as text file.
", "operationId":"ServerLogs.downloadLatestLogFile", "parameters":[ { "name":"serverType", "in":"path", "description":"Server type", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Log returned successfully.
" }, "400":{ "description":"Bad Request
Failed to return log.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"logs-{serverType}-latest-get", "x-filename-id":"logs-servertype-latest-get" } }, "/logs/{serverType}":{ "get":{ "tags":[ "Server logs" ], "summary":"Download Logs for Server Type", "description":"Returns links to download all log files as zip file, and to download the latest log file for specific server type.
", "operationId":"ServerLogs.downloadServerLogFiles", "parameters":[ { "name":"serverType", "in":"path", "description":"Server type.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Return list of URI links.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Link" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Link" } } } }, "400":{ "description":"Bad Request
Platform security exception.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"logs-{serverType}-get", "x-filename-id":"logs-servertype-get" } }, "/logs":{ "get":{ "tags":[ "Server logs" ], "summary":"Get All Server Types", "description":"Returns links listing all server types.
", "operationId":"ServerLogs.getServerLogLinks", "responses":{ "200":{ "description":"OK
Successfully returned URI links listing all server types.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Link" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Link" } } } }, "400":{ "description":"Bad Request
Failed to return server types.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"logs-get", "x-filename-id":"logs-get" } }, "/logs/stream":{ "get":{ "tags":[ "Server logs" ], "summary":"Return Filtered Logs", "description":"Returns the logs based on specified filters. Filters can be applied for user, message text, time, and other criteria.
", "operationId":"ServerLogs.stream", "parameters":[ { "name":"msgtype", "in":"query", "description":"One or more Log message types e.g. ERROR", "schema":{ "type":"array", "items":{ "type":"string" } } }, { "name":"user", "in":"query", "description":"User ID.
", "schema":{ "type":"string" } }, { "name":"after", "in":"query", "description":"After time (in milliseconds).
", "schema":{ "type":"integer", "format":"int64" } }, { "name":"before", "in":"query", "description":"Before time (in milliseconds).
", "schema":{ "type":"integer", "format":"int64" } }, { "name":"tail", "in":"query", "description":"Last n records - maximum of 1000.
", "schema":{ "type":"integer", "format":"int32" } }, { "name":"filetype", "in":"query", "description":"One or more file types.
", "schema":{ "type":"array", "items":{ "type":"string", "enum":[ "PLATFORM", "AGENT", "APP_SERVER", "APS", "APP_SERVER_CONSOLE", "APPLICATION" ] } } }, { "name":"application", "in":"query", "description":"Application name.
", "schema":{ "type":"array", "items":{ "type":"string" } } }, { "name":"contains", "in":"query", "description":"Check if message contains this value.
", "schema":{ "type":"string" } }, { "name":"details", "in":"query", "description":"Include supporting details in the response.
", "schema":{ "type":"boolean" } } ], "responses":{ "200":{ "description":"OK
Logs returned successfully.
" }, "400":{ "description":"Bad Request
Failed to return logs.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"logs-stream-get", "x-filename-id":"logs-stream-get" } }, "/about":{ "get":{ "tags":[ "About Essbase" ], "summary":"About Essbase", "description":"Returns description, build, and version of Essbase.
", "operationId":"About.getAbout", "responses":{ "200":{ "description":"OK
Successful operation.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/About" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/About" } } } } }, "x-internal-id":"about-get", "x-filename-id":"get" } }, "/about/instance":{ "get":{ "tags":[ "About Essbase" ], "summary":"About Essbase Instance", "description":"Returns instance details for Essbase.
", "operationId":"About.getInstanceDetails", "responses":{ "200":{ "description":"OK
Successful operation.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/About" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/About" } } } }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"about-instance-get", "x-filename-id":"instance-get" } }, "/applications/{applicationName}/encrypt":{ "post":{ "tags":[ "Applications" ], "summary":"Encrypt Application", "description":"To prevent unauthorized access to the Essbase application, encrypt it. Only logged in Essbase users can access encrypted applications.
OCID encryption type is available for Essbase stack deployments on Oracle Cloud Infrastructure via Marketplace. This encryption type uses Oracle OCI Vault, a service that securely stores and manages master encryption keys and secrets.
For type, enter OCID. For vaultId, enter the OCID of the Vault. For masterKeyId, enter the OCID of the Master Encryption Key.
See Also
", "operationId":"Application.encrypt", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Encryption Key.
", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/AppEncryption" } } }, "required":true }, "responses":{ "200":{ "description":"SUCCESS
Encryption applied on the application.
" }, "400":{ "description":"FAILURE
Failed to apply encryption on the application.
" }, "415":{ "description":"FAILURE
Failed to apply encryption on the application.
" }, "500":{ "description":"FAILURE
Failed to apply encryption on the application.
" } }, "x-internal-id":"applications-{applicationName}-encrypt-post", "x-filename-id":"applications-applicationname-encrypt-post" } }, "/applications/{applicationName}/decrypt":{ "post":{ "tags":[ "Applications" ], "summary":"Decrypt Application", "description":"Disable encryption on the application. Applicable only when Essbase is deployed as a stack on OCI, using Oracle Cloud Marketplace listing.
See Also
", "operationId":"Application.decrypt", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"SUCCESS
Encryption removed on the application.
" }, "400":{ "description":"FAILURE
Failed to remove encryption on the application.
" }, "415":{ "description":"FAILURE
Failed to remove encryption on the application.
" }, "500":{ "description":"FAILURE
Failed to remove encryption on the application.
" } }, "x-internal-id":"applications-{applicationName}-decrypt-post", "x-filename-id":"applications-applicationname-decrypt-post" } }, "/applications/{applicationName}/encryptionconfig":{ "get":{ "tags":[ "Applications" ], "summary":"Get Encryption Info", "description":"List the types of encryption supported by Essbase and available for the application.
EncryptionMode
The encryption modes supported in Oracle Essbase.
0 - No encryption.
1 - N/A. Use Oracle OCI Vault instead.
2 - Oracle OCI Vault encryption. OCI Vault is a service that securely stores and manages master encryption keys and secrets.
AvailableTypes
The types of encryptions available for this application. Valid values: OCID, or none. OCID/Vault encryption type is available only for Essbase stack deployments on Oracle Cloud Infrastructure via Marketplace. OCID type refers to the OCID of the OCI Vault.
See Also
", "operationId":"Application.appSupportedEncryptionMethods", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Returned supported encryption types successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EncryptionConfig" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/EncryptionConfig" } } } } }, "x-internal-id":"applications-{applicationName}-encryptionconfig-get", "x-filename-id":"applications-applicationname-encryptionconfig-get" } }, "/applications/actions/copy":{ "post":{ "tags":[ "Applications" ], "summary":"Copy Application", "description":"Copies an application. You must provide the source and destination application names.
", "operationId":"Applications.copyApplication", "requestBody":{ "description":"Source and destination application information.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CopyRenameBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/CopyRenameBean" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Application copied successfully.
" }, "400":{ "description":"Bad Request
Failed to copy application.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-actions-copy-post", "x-filename-id":"applications-actions-copy-post" } }, "/applications/{applicationName}/databases/actions/copy":{ "post":{ "tags":[ "Applications" ], "summary":"Copy Database", "description":"Copies an Essbase database (cube). You must provide the source and destination application and cube names. This operation is supported only for block storage cubes.
", "operationId":"Applications.copyDatabase", "parameters":[ { "name":"applicationName", "in":"path", "description":"Source application name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Source and destination database information.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CubeCopy" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/CubeCopy" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Database copied successfully.
" }, "400":{ "description":"Bad Request
Failed to copy database.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-actions-copy-post", "x-filename-id":"applications-applicationname-databases-actions-copy-post" } }, "/applications":{ "get":{ "tags":[ "Applications" ], "summary":"List Applications", "description":"Returns the list of Essbase applications. Connection name and application name for connection are optional parameters.
If you provide only a connection name with no application name, this API fetches all applications using that named connection.
If you provide a connection name and application name, this API fetches the specified applications using the specified connection.
Use the fields parameter to return only required fields.
Limitation: If the application status is required in response, the limit must be less than or equal to 100.
", "operationId":"Applications.getApplications", "parameters":[ { "name":"filter", "in":"query", "schema":{ "type":"string", "default":"*" } }, { "name":"offset", "in":"query", "description":"Number of applications to omit from the start of the result set. Default value is 0.
", "schema":{ "type":"integer", "format":"int32", "default":0 } }, { "name":"limit", "in":"query", "description":"Maximum number of applications to return. Default is 50.
", "schema":{ "type":"integer", "format":"int32", "default":50 } }, { "name":"connectionName", "in":"query", "description":"Connection name.
", "schema":{ "type":"string" } }, { "name":"applicationNameForConnection", "in":"query", "description":"Application name for connection.
", "schema":{ "type":"string" } }, { "name":"fields", "in":"query", "description":"Comma-separated list of fields to be returned in response fields. If omitted, all fields are returned.
", "schema":{ "type":"string" } }, { "name":"orderBy", "in":"query", "description":"Order By specification in format:column:direction. For example, name:asc. ",
"schema":{
"type":"string",
"default":""
}
}
],
"responses":{
"200":{
"description":"OK
Application list returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApplicationList" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApplicationList" } } } }, "400":{ "description":"Bad Request
Failed to get applications.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-get", "x-filename-id":"applications-get" }, "post":{ "tags":[ "Applications" ], "summary":"Create Application and Database", "description":"Creates an application and database (cube) with the specified details.
", "operationId":"Applications.createApplications", "requestBody":{ "description":"Application details.
", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/CreateApplication" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Application created successfully.
" }, "400":{ "description":"Bad Request
Failed to create application.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-post", "x-filename-id":"applications-post" } }, "/applications/actions/shadowCopy":{ "post":{ "tags":[ "Applications" ], "summary":"Create Shadow Application", "description":"Puts the specified primary application in read-only mode and creates a shadow application (a complete copy) out of the primary application.
A shadow application enables you to perform cube modifications and outline restructure on the shadow application, while the primary application serves read-only operations such as queries.
Permission required: power user.
Shadow applications are useful because an outline restructure can take a very long time, depending on the size of the application.
Instead of reporting users being blocked by the downtime due to restructure, a shadow solution helps them continue their read-only queries against the primary application, while the restructure is occurring on the shadow application.
Note that a shadow application can be made as hidden copy of the primary application.
This means if you invoke List Applications, you will not see the shadow application in that list.
The parameter waitForOngoingUpdatesInSecs allows you to control how long the copying process can wait, if there are any ongoing write-operations on the cubes(s) of this application at the time you are attempting to make a shadow copy.
For example, if there is a data load in progress, the cloning process fails.
If you specified waitForOngoingUpdatesInSecs as 60, Essbase waits up to one minute for the data load to complete before initiating a cloning process.
If the data load doesn't complete within this specified wait-interval, Essbase does not create the copy, the cloning process fails with an error, and the data load continues.
See Also
", "operationId":"Applications.createShadowApplication", "requestBody":{ "description":"primaryAppName: Source application name which you intend to clone.
shadowAppName : Unique Destination or secondary application name which will be a copy of the source.
hideShadow: Specify true to hide the application; otherwise, specify false.
waitForOngoingUpdatesInSecs: Waiting period (in seconds) for any active write-operations to complete.
runInBackground: Specify true to schedule 'Shadow Copy' as a Job; otherwise, specify false.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ShadowCopyBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ShadowCopyBean" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Shadow application created successfully.
" }, "400":{ "description":"Bad Request
Failed to create shadow application.
" }, "500":{ "description":"Internal Server Error.
" }, "503":{ "description":"Service Unavailable
Naming exception or server exception.
" } }, "x-internal-id":"applications-actions-shadowCopy-post", "x-filename-id":"applications-actions-shadowcopy-post" } }, "/applications/{applicationName}":{ "get":{ "tags":[ "Applications" ], "summary":"Get Application", "description":"Returns details of application with specified name.
", "operationId":"Applications.getApplication", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"role", "in":"query", "description":"Role.
", "schema":{ "type":"boolean", "default":false } } ], "responses":{ "200":{ "description":"OK
Application details returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Application" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Application" } } } }, "400":{ "description":"Bad Request
Failed to get application.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-get", "x-filename-id":"applications-applicationname-get" }, "put":{ "tags":[ "Applications" ], "summary":"Start or Stop Application", "description":"Performs specified action on the application. Valid actions are Start, Stop, and Stop_no_force.
", "operationId":"Applications.performOperation", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"action", "in":"query", "description":"Action to perform on the application: Start, Stop, or Stop_no_force
.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Action performed successfully.
." }, "400":{ "description":"Bad Request
Failed to perform action.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-put", "x-filename-id":"applications-applicationname-put" }, "delete":{ "tags":[ "Applications" ], "summary":"Delete Application", "description":"Deletes specified application.
", "operationId":"Applications.deleteApplication", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"OK
Application deleted successfully.
" }, "400":{ "description":"Bad Request
Failed to delete application.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-delete", "x-filename-id":"applications-applicationname-delete" } }, "/applications/{applicationName}/databases/{databaseName}":{ "get":{ "tags":[ "Applications" ], "summary":"Get Database", "description":"Returns details of database with specified database name and application name.
", "operationId":"Applications.getCube", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Database details returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Cube" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Cube" } } } }, "400":{ "description":"Bad Request
Failed to get database.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-get", "x-filename-id":"applications-applicationname-databases-databasename-get" }, "put":{ "tags":[ "Applications" ], "summary":"Start or Stop Database", "description":"Performs specified action on the application and database. Valid actions are Start and Stop.", "operationId":"Applications.performDbOperation", "parameters":[ { "name":"applicationName", "in":"path", "description":"
Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"action", "in":"query", "description":"Action - start or stop.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Action performed successfully.
" }, "400":{ "description":"Bad Request
Failed to perform action.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-put", "x-filename-id":"applications-applicationname-databases-databasename-put" }, "delete":{ "tags":[ "Applications" ], "summary":"Delete Database", "description":"Deletes specified database.
", "operationId":"Applications.deleteDatabase", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"OK
Database deleted successfully.
" }, "400":{ "description":"Bad Request
Failed to delete database.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-delete", "x-filename-id":"applications-applicationname-databases-databasename-delete" } }, "/applications/actions/shadowDelete/{shadowAppName}":{ "delete":{ "tags":[ "Applications" ], "summary":"Delete Shadow Application", "description":"Forcefully deletes the specified shadow application.
Although shadow applications can also be deleted using the regular Delete Application, if the shadow application is corrupted or has any locks, then it the regular delete application fails.
Therefore, this API guarantees a forceful deletion of the shadow application.
This API is similar to the MaxL statement drop application APP-NAME cascade force
", "operationId":"Applications.dropShadowApplication", "parameters":[ { "name":"shadowAppName", "in":"path", "description":"shadowAppName: Name of the shadow application to remove.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"OK
Shadow application deleted successfully.
" }, "400":{ "description":"Bad Request
Failed to delete shadow application.
" }, "500":{ "description":"Internal Server Error.
" }, "503":{ "description":"Service Unavailable
Naming exception or server exception.
" } }, "x-internal-id":"applications-actions-shadowDelete-{shadowAppName}-delete", "x-filename-id":"applications-actions-shadowdelete-shadowappname-delete" } }, "/applications/{applicationName}/databases/{databaseName}/executeReport":{ "get":{ "tags":[ "Applications" ], "summary":"Execute Report Script", "description":"Returns output generated by executing a report script specification file.
", "operationId":"Applications.executeReportScript", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"filename", "in":"query", "description":"Report script file name.
", "required":true, "schema":{ "type":"string" } }, { "name":"lockForUpdate", "in":"query", "description":"All blocks which are accessed by the report specification are locked.
", "schema":{ "type":"string", "default":"false" } } ], "responses":{ "200":{ "description":"OK
Report generated successfully.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-executeReport-get", "x-filename-id":"applications-applicationname-databases-databasename-executereport-get" } }, "/applications/{applicationName}/databases/{databaseName}/aliases/getActiveAlias":{ "get":{ "tags":[ "Applications" ], "summary":"List Active Aliases", "description":"Returns the currently active alias table associated with the specified application and database.
", "operationId":"Applications.getActiveAlias", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Alias tables returned successfully.
", "content":{ "application/json":{ "schema":{ "type":"string" } }, "application/xml":{ "schema":{ "type":"string" } } } }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-aliases-getActiveAlias-get", "x-filename-id":"applications-applicationname-databases-databasename-aliases-getactivealias-get" } }, "/applications/{applicationName}/databases/{databaseName}/aliases":{ "get":{ "tags":[ "Applications" ], "summary":"List Aliases", "description":"Returns alias tables associated with the specified application and database.
", "operationId":"Applications.getAliases", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Alias tables returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/StringCollectionResponse" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/StringCollectionResponse" } } } }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-aliases-get", "x-filename-id":"applications-applicationname-databases-databasename-aliases-get" } }, "/applications/{applicationName}/provisionReport":{ "get":{ "tags":[ "Applications" ], "summary":"Get Application Provisioning Report", "description":"Gets provisioning report of specified application for all the users and groups having at least one application role (directly or inherited through groups). To invoke this API, logged in user should have at least Database Manager role for the specified application. Application roles are included only when logged in user has Application Manager role for the specified application.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
", "operationId":"Applications.getApplicationProvisionReport", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Provisioning report returned successfully, as Excel stream.
" }, "400":{ "description":"Bad Request
Logged in user may not have appropriate application role.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-provisionReport-get", "x-filename-id":"applications-applicationname-provisionreport-get" } }, "/applications/actions/name/{appVisiblity}":{ "get":{ "tags":[ "Applications" ], "summary":"List Application Names", "description":"Returns the list of application names, based on the type of visibility requested. For example, you can fetch the list of hidden (shadow) applications only, or you can fetch the visible applications list only, or both sets of applications.
", "operationId":"Applications.getApplicationNames", "parameters":[ { "name":"appVisiblity", "in":"path", "description":"appVisiblity : Visibility level of application names. Valid options: ALL, HIDDEN, REGULAR
", "required":true, "schema":{ "type":"string", "enum":[ "ALL", "HIDDEN", "REGULAR" ] } } ], "responses":{ "200":{ "description":"OK
Application names returned successfully.
", "content":{ "application/json":{ "schema":{ "type":"object" } }, "application/xml":{ "schema":{ "type":"object" } } } }, "400":{ "description":"Bad Request
Failed to get application names.
" }, "500":{ "description":"Internal Server Error.
" }, "503":{ "description":"Service Unavailable
Naming exception or server exception.
" } }, "x-internal-id":"applications-actions-name-{appVisiblity}-get", "x-filename-id":"applications-actions-name-appvisiblity-get" } }, "/applications/actions/tree":{ "get":{ "tags":[ "Applications" ], "summary":"Get Application Tree View", "description":"Gets the list of applications and databases as a tree view.
", "operationId":"Applications.getApplicationsTree", "responses":{ "200":{ "description":"OK
Tree view listing of applications and databases returned successfully.
", "content":{ "application/json":{ "schema":{ "type":"string" } }, "application/xml":{ "schema":{ "type":"string" } } } }, "500":{ "description":"Internal Server Error" } }, "x-internal-id":"applications-actions-tree-get", "x-filename-id":"applications-actions-tree-get" } }, "/applications/{applicationName}/databases/{databaseName}/calculationFunctions":{ "get":{ "tags":[ "Applications" ], "summary":"Get Calculation Functions", "description":"Returns list of common and database-specific calculation functions.
", "operationId":"Databases.getCalculationFunctions", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
XML or JSON string containing list of calculation functions returned successfully.
", "content":{ "application/json":{ "schema":{ "type":"string" } }, "application/xml":{ "schema":{ "type":"string" } } } }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-calculationFunctions-get", "x-filename-id":"applications-applicationname-databases-databasename-calculationfunctions-get" } }, "/applications/{applicationName}/databases":{ "get":{ "tags":[ "Applications" ], "summary":"List Databases", "description":"Returns list of databases. Providing the connection name for which to list databases is optional. If a connection name is provided, connections created at the specified application is used to fetch the database list.
", "operationId":"Applications.getCubes", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"connectionName", "in":"query", "description":"Connection name.
", "schema":{ "type":"string" } }, { "name":"orderBy", "in":"query", "description":"Order By specification in format:column:direction. For example, name:asc.",
"schema":{
"type":"string",
"default":""
}
},
{
"name":"applicationNameForConnection",
"in":"query",
"description":"Application name from which to list databases.
", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Database list returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CubeList" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/CubeList" } } } }, "400":{ "description":"Bad Request
Failed to get databases.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-get", "x-filename-id":"applications-applicationname-databases-get" } }, "/applications/{applicationName}/databases/{databaseName}/currencySettings":{ "get":{ "tags":[ "Applications" ], "summary":"Get Currency Settings", "description":"Returns the currency settings for the database.
", "operationId":"Databases.getCurrencySettings", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Currency settings returned successfully.
", "content":{ "application/json":{ "schema":{ "type":"string" } }, "application/xml":{ "schema":{ "type":"string" } } } }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-currencySettings-get", "x-filename-id":"applications-applicationname-databases-databasename-currencysettings-get" }, "post":{ "tags":[ "Applications" ], "summary":"Set Currency Settings", "description":"Updates the currency settings for the database.
", "operationId":"Databases.setCurrencySettings", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Currency settings.
", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/CurrencySettings" } } }, "required":true }, "responses":{ "204":{ "description":"OK
Currency settings updated successfully.
", "content":{ "application/json":{ "schema":{ "type":"string" } }, "application/xml":{ "schema":{ "type":"string" } } } }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-currencySettings-post", "x-filename-id":"applications-applicationname-databases-databasename-currencysettings-post" } }, "/applications/{applicationName}/databases/{databaseName}/formulaFunctions":{ "get":{ "tags":[ "Applications" ], "summary":"Get Formula Functions", "description":"Returns a list of functions for defining formulas. For an aggregate storage cube, the list contains MDX functions. For a block storage cube, the list contains Essbase calculation functions.
", "operationId":"Databases.formulaFunctions", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
List of functions, as XML or JSON string, returned successfully.
", "content":{ "application/json":{ "schema":{ "type":"string" } }, "application/xml":{ "schema":{ "type":"string" } } } }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-formulaFunctions-get", "x-filename-id":"applications-applicationname-databases-databasename-formulafunctions-get" } }, "/applications/{applicationName}/databases/{databaseName}/mdxFunctions":{ "get":{ "tags":[ "Applications" ], "summary":"Get MDX Functions", "description":"Returns list of MDX functions", "operationId":"Databases.getMdxFunctions", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
XML or JSON string containing list of MDX functions returned successfully.
", "content":{ "application/json":{ "schema":{ "type":"string" } }, "application/xml":{ "schema":{ "type":"string" } } } }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-mdxFunctions-get", "x-filename-id":"applications-applicationname-databases-databasename-mdxfunctions-get" } }, "/applications/partitions/supportedfederatedtypes":{ "get":{ "tags":[ "Applications" ], "summary":"Get Supported Partition Types", "description":"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.
OK
Returned supported partition types successfully.
" }, "400":{ "description":"Bad Request
Failed to get supported types.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-partitions-supportedfederatedtypes-get", "x-filename-id":"applications-partitions-supportedfederatedtypes-get" } }, "/applications/actions/shadowPromote":{ "post":{ "tags":[ "Applications" ], "summary":"Promote Shadow Application", "description":"Promotes the shadow application as the base application. Conceptually, the promote operation is equivalent to moving the Essbase application directory from a source to destination location, at the file system level.
Essbase must stop (unload) both applications, if they are running, before promoting. At the time of unloading, if the destination application is serving any ongoing operations, such as queries, Essbase terminates those operations and attempts to unload the application.
If a graceful unload process fails or takes longer than permitted by the input argument timeoutToForceUnloadApp (unit=seconds), Essbase forcefully terminates the application.
Example: if you specify 60 seconds for the timeout, but the termination of ongoing requests and graceful unloading of the application does not complete within one minute, Essbase triggers a forceful termination. After termination, Essbase promotes the shadow application.
The promote operation is supported on all applications, including aggregate storage, block storage, and Hybrid mode.
Note: when moving an existing application, only the application and cube artifacts (such as metadata and data) are replaced from the source to destination.
During a promotion, all security layer associations on the destination application, such as users, groups, and security filters, are retained, while that of shadow/source are lost. The same rule applies for partition definitions.
Example: If users X and Y had read-access to App1, and an admin promotes a shadow App2 to replace App1, both X and Y will be able to access App1.
If user Z had access to App2, then after promotion, Z is not able to access App1.
Promotion from shadowed application to base is honoured only if there are no changes to the number of cubes and cube names. In other words, if a cube gets renamed or if there is any addition or deletion of an application after it was shadowed, then promotion of such an application fails with an error, leaving both applications as they were.
Example: ASOAppNew.cubeNew cannot be replaced as ASO.cube. ASOAppNew.cube can be replaced as ASO.cube.
Tips: You need not unload or stop the application prior to calling this promotion API. Essbase loads the application to gather information and unloads it prior to moving the applications.
", "operationId":"Applications.promoteShadowApplication", "requestBody":{ "description":"shadowAppName: Name of the hidden shadow application that needs to be promoted to base.
primaryAppName: Name of the primary application.
timeoutToForceUnloadApp: Time interval (in seconds) to force unload in the event of applications performing an ongoing requests even after time interval.
runInBackground: Specify true to schedule 'Shadow Promote' as a Job; otherwise, specify false.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ShadowPromoteBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ShadowPromoteBean" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Promote shadow application completed successfully.
" }, "400":{ "description":"Bad Request
Failed to promote shadow application.
" }, "500":{ "description":"Internal Server Error.
" }, "503":{ "description":"Service Unavailable
Naming exception or server exception.
" } }, "x-internal-id":"applications-actions-shadowPromote-post", "x-filename-id":"applications-actions-shadowpromote-post" } }, "/applications/actions/rename":{ "post":{ "tags":[ "Applications" ], "summary":"Rename Application", "description":"Renames an application. You must provide the source and destination application names.
", "operationId":"Applications.renameApplication", "requestBody":{ "description":"Source and destination application information.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CopyRenameBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/CopyRenameBean" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Application renamed successfully.
" }, "400":{ "description":"Bad Request
Failed to rename application.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-actions-rename-post", "x-filename-id":"applications-actions-rename-post" } }, "/applications/{applicationName}/databases/actions/rename":{ "post":{ "tags":[ "Applications" ], "summary":"Rename Database", "description":"Renames a database. You must provide the source application name, and the source and destination database names. Destination application name is not required.
", "operationId":"Applications.renameDatabase", "parameters":[ { "name":"applicationName", "in":"path", "description":"Source application name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Source and destination database information.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CopyRenameBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/CopyRenameBean" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Database renamed successfully.
" }, "400":{ "description":"Bad Request
Failed to rename database.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-actions-rename-post", "x-filename-id":"applications-applicationname-databases-actions-rename-post" } }, "/applications/{applicationName}/databases/{databaseName}/aliases/setActiveAlias":{ "put":{ "tags":[ "Applications" ], "summary":"List Aliases", "description":"Returns alias tables associated with the specified application and database.
", "operationId":"Applications.getAliases_1", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"aliasTableName", "in":"query", "description":"Alias table name.
", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Alias tables returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/StringCollectionResponse" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/StringCollectionResponse" } } } }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-aliases-setActiveAlias-put", "x-filename-id":"applications-applicationname-databases-databasename-aliases-setactivealias-put" } }, "/applications/{application}/databases/{database}/audittrail/data":{ "get":{ "tags":[ "Audit Trail" ], "summary":"Get Audit Data", "description":"Returns audit trail data in CSV string format if Accept='text/csv' or Accept='text/plain'. If Accept='application/octet-stream', returns audit data as a CSV stream to download. If Accept='application/json', returns the audit data list in JSON format.
The audit trail records are stored in the ESSBASE_DATA_AUDIT_TRAIL table in the Essbase repository database schema.
", "operationId":"AuditTrail.getDataAudit", "parameters":[ { "name":"application", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"database", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"fetchCount", "in":"query", "description":"Number of records to be fetched.
", "schema":{ "type":"integer", "format":"int64" } } ], "responses":{ "200":{ "description":"OK
Audit trail data returned successfully.
", "content":{ "text/plain":{ "schema":{ "type":"string" } }, "text/csv":{ "schema":{ "type":"string" } } } }, "400":{ "description":"Bad Request
Failed to return audit data.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{application}-databases-{database}-audittrail-data-get", "x-filename-id":"applications-application-databases-database-audittrail-data-get" }, "delete":{ "tags":[ "Audit Trail" ], "summary":"Delete Audit Data", "description":"Deletes audit trail data older than the specified time.
", "operationId":"AuditTrail.purge", "parameters":[ { "name":"application", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"database", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"olderthan", "in":"query", "description":"Time in milliseconds.
", "schema":{ "type":"integer", "format":"int64" } } ], "responses":{ "204":{ "description":"OK
Audit data deleted successfully.
" }, "400":{ "description":"Bad Request
Failed to delete audit data.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{application}-databases-{database}-audittrail-data-delete", "x-filename-id":"applications-application-databases-database-audittrail-data-delete" } }, "/applications/{application}/databases/{database}/boe":{ "post":{ "tags":[ "Batch Outline Editing" ], "summary":"Run Batch Outline Edit", "description":"Executes batch outline editing process. Based on the XML or JSON body, adds or removes members from the outline in the active cube.
", "operationId":"BatchOutlineEditing.execute", "parameters":[ { "name":"application", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"database", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Batch outline JSON/XML.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/OtlEditMain" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/OtlEditMain" } } }, "required":true }, "responses":{ "200":{ "description":"OK
The batch outline edit completed successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BOEOutput" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/BOEOutput" } } } }, "400":{ "description":"Bad Request
Failed to complete batch outline editing. The output may be invalid, the sequence of metadata operations may be incorrect, or saving the outline may have failed.
" } }, "x-internal-id":"applications-{application}-databases-{database}-boe-post", "x-filename-id":"applications-application-databases-database-boe-post" } }, "/cloudstorage/config":{ "get":{ "tags":[ "Object Storage Configuration" ], "summary":"Get Object Storage Configuration", "description":"Get object storage configuration. This is applicable only in ADBS deployment", "operationId":"CloudStorage.getConfig", "responses":{ "200":{ "description":"
OK
Object storage configuration retrieved successfully.
" }, "400":{ "description":"Bad Request
Failed to retrieve object storage configuration.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"cloudstorage-config-get", "x-filename-id":"cloudstorage-config-get" }, "put":{ "tags":[ "Object Storage Configuration" ], "summary":"Create or Update Object Storage Configuration", "description":"Create or update object storage configuration. This is applicable only in ADBS deployment", "operationId":"CloudStorage.createOrUpdateConfig", "requestBody":{ "description":"
Object storage configuration.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CloudStorageDetails" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/CloudStorageDetails" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Object storage configuration saved successfully.
" }, "400":{ "description":"Bad Request
Failed to save object storage configuration.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"cloudstorage-config-put", "x-filename-id":"cloudstorage-config-put" } }, "/cloudstorage/config/test":{ "post":{ "tags":[ "Object Storage Configuration" ], "summary":"Verify Object Storage Configuration", "description":"Verify provided object storage configuration details. This is applicable only in ADBS deployment", "operationId":"CloudStorage.testConfig", "requestBody":{ "description":"
Object storage configuration.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CloudStorageDetails" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/CloudStorageDetails" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Verified object storage configuration details successfully.
" }, "400":{ "description":"Bad Request
Failed to verify object storage configuration details.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"cloudstorage-config-test-post", "x-filename-id":"cloudstorage-config-test-post" } }, "/databasesizestatistics":{ "get":{ "tags":[ "Database Size Statistics" ], "summary":"Get Database Size Statistics", "description":"Returns a list of block storage databases and their page and index sizes.
", "operationId":"DatabaseSizeStatistics.getDBSizes", "responses":{ "200":{ "description":"OK
Database size statistics returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DBSizeList" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/DBSizeList" } } } }, "400":{ "description":"Bad Request
Failed to get database size statistics.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"databasesizestatistics-get", "x-filename-id":"databasesizestatistics-get" } }, "/applications/{applicationName}/databases/{databaseName}/dimensions/{dimensionName}/generations/{generationNumber}":{ "get":{ "tags":[ "Dimensions" ], "summary":"Get Generation", "description":"Returns generation details of a dimension, based on the specified generation number, application, and database.
", "operationId":"Dimensions.getDimGenerations", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"dimensionName", "in":"path", "description":"Dimension name.
", "required":true, "schema":{ "type":"string" } }, { "name":"generationNumber", "in":"path", "description":"Generation number.
", "required":true, "schema":{ "type":"integer", "format":"int32" } } ], "responses":{ "200":{ "description":"OK
Generation details returned successfully, including links to get or edit the generation.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GenerationLevel" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenerationLevel" } } } }, "400":{ "description":"Bad Request
Failed to get generation. The application name, database name, dimension name, or generation number may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-dimensions-{dimensionName}-generations-{generationNumber}-get", "x-filename-id":"applications-applicationname-databases-databasename-dimensions-dimensionname-generations-generationnumber-get" }, "put":{ "tags":[ "Dimensions" ], "summary":"Update Generation", "description":"Updates and returns generation details of a dimension, based on the specified generation number, application, and database.
", "operationId":"Dimensions.editDimGenerations", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"dimensionName", "in":"path", "description":"Dimension name.
", "required":true, "schema":{ "type":"string" } }, { "name":"generationNumber", "in":"path", "description":"Generation number.
", "required":true, "schema":{ "type":"integer", "format":"int32" } } ], "requestBody":{ "description":"Generation details.
", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/GenerationLevel" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Generation details updated successfully, including links to get or edit the generation.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GenerationLevel" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenerationLevel" } } } }, "400":{ "description":"Bad Request
Failed to update the generation. The application name, database name, dimension name, or generation number may be incorrect.
" }, "415":{ "description":"Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-dimensions-{dimensionName}-generations-{generationNumber}-put", "x-filename-id":"applications-applicationname-databases-databasename-dimensions-dimensionname-generations-generationnumber-put" } }, "/applications/{applicationName}/databases/{databaseName}/dimensions/{dimensionName}/levels/{levelNumber}":{ "get":{ "tags":[ "Dimensions" ], "summary":"Get Level", "description":"Returns level details of a dimension, based on the specified level number, application, and database.
", "operationId":"Dimensions.getDimLevels", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"dimensionName", "in":"path", "description":"Dimension name.
", "required":true, "schema":{ "type":"string" } }, { "name":"levelNumber", "in":"path", "description":"Level number.
", "required":true, "schema":{ "type":"integer", "format":"int32" } } ], "responses":{ "200":{ "description":"OK
Level details returned successfully, including links to get or edit the level.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GenerationLevel" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenerationLevel" } } } }, "400":{ "description":"Bad Request
Failed to get level. The application name, database name, dimension name, or level number may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-dimensions-{dimensionName}-levels-{levelNumber}-get", "x-filename-id":"applications-applicationname-databases-databasename-dimensions-dimensionname-levels-levelnumber-get" }, "put":{ "tags":[ "Dimensions" ], "summary":"Update Level", "description":"Updates and returns level details of a dimension, based on the specified level number, application, and database.
", "operationId":"Dimensions.editDimLevels", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"dimensionName", "in":"path", "description":"Dimension name.
", "required":true, "schema":{ "type":"string" } }, { "name":"levelNumber", "in":"path", "description":"Level number.
", "required":true, "schema":{ "type":"integer", "format":"int32" } } ], "requestBody":{ "description":"Level details.
", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/GenerationLevel" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Level details updated successfully, including links to get or edit the level.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GenerationLevel" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/GenerationLevel" } } } }, "400":{ "description":"Bad Request
Failed to update the level. The application name, database name, dimension name, or level number may be incorrect.
" }, "415":{ "description":"Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-dimensions-{dimensionName}-levels-{levelNumber}-put", "x-filename-id":"applications-applicationname-databases-databasename-dimensions-dimensionname-levels-levelnumber-put" } }, "/applications/{applicationName}/databases/{databaseName}/dimensions/{dimensionName}/generations":{ "get":{ "tags":[ "Dimensions" ], "summary":"List Generations", "description":"Returns all the generations of a dimension from the specified application and database.
", "operationId":"Dimensions.listDimGenerations", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"dimensionName", "in":"path", "description":"Dimension name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Generations retrieved successfully, including links to get or edit each generation.
", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/GenerationLevelList" } } }, "application/xml":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/GenerationLevelList" } } } } }, "400":{ "description":"Bad Request
Failed to get the generations. The application, database, or dimension name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-dimensions-{dimensionName}-generations-get", "x-filename-id":"applications-applicationname-databases-databasename-dimensions-dimensionname-generations-get" } }, "/applications/{applicationName}/databases/{databaseName}/dimensions/{dimensionName}/levels":{ "get":{ "tags":[ "Dimensions" ], "summary":"List Levels", "description":"Returns all the levels of a dimension from the specified application and database.
", "operationId":"Dimensions.listDimLevels", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"dimensionName", "in":"path", "description":"Dimension name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Levels retrieved successfully, including links to get or edit each level.
", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/GenerationLevelList" } } }, "application/xml":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/GenerationLevelList" } } } } }, "400":{ "description":"Bad Request
Failed to get the levels. The application, database, or dimension name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-dimensions-{dimensionName}-levels-get", "x-filename-id":"applications-applicationname-databases-databasename-dimensions-dimensionname-levels-get" } }, "/applications/{applicationName}/databases/{databaseName}/dimensions":{ "get":{ "tags":[ "Dimensions" ], "summary":"List Dimensions", "description":"Returns all the dimensions from the specified application and database.
", "operationId":"Dimensions.listDimensions", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Dimensions retrieved successfully, including details about the dimensions, and links to get the generations and levels of each dimension.
", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/DimensionList" } } }, "application/xml":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/DimensionList" } } } } }, "400":{ "description":"Bad Request
Failed to get the dimensions. The application or database name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-dimensions-get", "x-filename-id":"applications-applicationname-databases-databasename-dimensions-get" } }, "/urls":{ "get":{ "tags":[ "URLs" ], "summary":"Get Essbase URLs", "description":"Returns the list of available Essbase URLs. Essbase components, such as the web interface, Smart View client, and REST API, have their own URL endings. The main URL includes the host name or IP address, the port number, and the path /essbase/.
The default secured port is 9001, unless it was changed during deployment.
", "operationId":"URLs.get", "responses":{ "200":{ "description":"OK
The operation completed successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Preference" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Preference" } } } } }, "x-internal-id":"urls-get", "x-filename-id":"urls-get" } }, "/cfg":{ "get":{ "tags":[ "Essbase Configuration" ], "summary":"Get Essbase Configuration", "description":"Gets the Essbase server configuration details.
", "operationId":"EssbaseConfiguration.get", "responses":{ "200":{ "description":"OK
The operation completed successfully.
", "content":{ "text/plain":{ "schema":{ "type":"string" } } } }, "400":{ "description":"Bad Request
Failed to get the Essbase configuration settings.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"cfg-get", "x-filename-id":"cfg-get" } }, "/filescanner":{ "get":{ "tags":[ "File Scanner" ], "summary":"Get Antivirus", "description":"Returns the current antivirus details. Virus scanning is available to ensure that files loaded into Essbase are virus-free. Antivirus software should have ICAP support.
", "operationId":"FileScanner.get", "responses":{ "200":{ "description":"OK
The operation completed successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AVClientInfo" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/AVClientInfo" } } } }, "400":{ "description":"Bad Request
Failed to get the antivirus details.
" } }, "x-internal-id":"filescanner-get", "x-filename-id":"filescanner-get" }, "put":{ "tags":[ "File Scanner" ], "summary":"Set Antivirus", "description":"Sets the antivirus details for scanning files. Virus scanning is available to ensure that files loaded into Essbase are virus-free. Antivirus software should have ICAP support.
", "operationId":"FileScanner.set", "requestBody":{ "description":"Antivirus details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AVClientInfo" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/AVClientInfo" } } }, "required":true }, "responses":{ "200":{ "description":"OK
The operation completed successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AVClientInfo" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/AVClientInfo" } } } }, "400":{ "description":"Bad Request
Failed to set the antivirus details.
" } }, "x-internal-id":"filescanner-put", "x-filename-id":"filescanner-put" }, "delete":{ "tags":[ "File Scanner" ], "summary":"Delete Antivirus", "description":"Removes the antivirus details for scanning files.
", "operationId":"FileScanner.delete", "responses":{ "200":{ "description":"OK
The operation completed successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AVClientInfo" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/AVClientInfo" } } } }, "400":{ "description":"Bad Request
Failed to delete the antivirus details.
" } }, "x-internal-id":"filescanner-delete", "x-filename-id":"filescanner-delete" } }, "/filescanner/actions/validate":{ "post":{ "tags":[ "File Scanner" ], "summary":"Validate Antivirus", "description":"Validates the antivirus details. Virus scanning is available to ensure that files loaded into Essbase are virus-free. Antivirus software should have ICAP support.
", "operationId":"FileScanner.validate", "requestBody":{ "description":"Antivirus details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AVClientInfo" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/AVClientInfo" } } }, "required":true }, "responses":{ "200":{ "description":"OK
The operation completed successfully.
" }, "400":{ "description":"Bad Request
Failed to validate the antivirus details.
" } }, "x-internal-id":"filescanner-actions-validate-post", "x-filename-id":"filescanner-actions-validate-post" } }, "/session":{ "get":{ "tags":[ "User Session" ], "summary":"Get Session", "description":"Returns logged in user information.
", "operationId":"UserSession.getSession", "parameters":[ { "name":"token", "in":"query", "schema":{ "type":"boolean" } }, { "name":"includeGroups", "in":"query", "description":"Specify whether to include groups in response. Default is true.
", "schema":{ "type":"boolean", "default":true } } ], "responses":{ "200":{ "description":"OK
The logged in user information was returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UserBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/UserBean" } } } }, "400":{ "description":"Bad Request
Failed to get user information.
" } }, "x-internal-id":"session-get", "x-filename-id":"session-get" }, "delete":{ "tags":[ "User Session" ], "summary":"Logout Session", "description":"Deactivates the current session.
", "operationId":"UserSession.signoff", "responses":{ "200":{ "description":"OK
Session deactivated successfully.
" }, "400":{ "description":"Bad Request
Failed to deactivate session.
" } }, "x-internal-id":"session-delete", "x-filename-id":"session-delete" } }, "/session/password":{ "put":{ "tags":[ "User Session" ], "summary":"Reset Password", "description":"Reset the password.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
", "operationId":"UserSession.resetPassword", "requestBody":{ "description":"Password reset details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResetPasswordBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ResetPasswordBean" } } }, "required":true }, "responses":{ "200":{ "description":"OK
The password was reset successfully.
" }, "400":{ "description":"Bad Request
Failed to reset the password.
" } }, "x-internal-id":"session-password-put", "x-filename-id":"session-password-put" } }, "/utilities/{id}":{ "get":{ "tags":[ "Templates and Utilities" ], "summary":"Download Utility", "description":"Returns utility with specified ID as stream.
", "operationId":"Resources.downloadUtility", "parameters":[ { "name":"id", "in":"path", "description":"ID of the utility.
exportutility: Command-line cube export utility.smartview: Smart View for Essbaselcm: Life Cycle Management (LCM) utility for backup/restore/migration. cli: Essbase Command-Line InterfacemigrationTool: Command-line migration utility EssbaseMaxlClient: MaxL Client for WindowsEssbaseLinuxMaxlClient: MaxL Client for LinuxEssbaseClientLinux: Essbase client libraries for C developers on LinuxEssbaseClientWindows: Essbase client libraries for C developers on WindowsEssbaseClientMacosx: Essbase client libraries for C developers on Mac OSjapi: Essbase tools and libraries for Java APIesscdext: Cube Designer extension and add-in to Smart ViewOK
Utility with specified ID found.
" }, "400":{ "description":"Bad Request
Failed to download utility with specified ID.
" } }, "x-internal-id":"utilities-{id}-get", "x-filename-id":"utilities-id-get" } }, "/utilities":{ "get":{ "tags":[ "Templates and Utilities" ], "summary":"List Utilities", "description":"Returns available utilities. For example: Export Utility, Smart View for Essbase.
", "operationId":"Resources.getUtilities", "responses":{ "200":{ "description":"OK
Utilities returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceList" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ResourceList" } } } }, "400":{ "description":"Bad Request
Failed to get utilities.
" } }, "x-internal-id":"utilities-get", "x-filename-id":"utilities-get" } }, "/applications/{applicationName}/databases/{databaseName}/asodataload/buffers":{ "get":{ "tags":[ "Aggregate Storage Load Buffers" ], "summary":"List Buffers", "description":"Lists existing aggregate storage data load buffers. An error is returned if called on a block storage database.
", "operationId":"ASOLoadBuffers.listBuffers", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Load buffers list returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/LoadBuffersList" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/LoadBuffersList" } } } }, "400":{ "description":"Bad Request
Failed to get load buffers.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-asodataload-buffers-get", "x-filename-id":"applications-applicationname-databases-databasename-asodataload-buffers-get" }, "post":{ "tags":[ "Aggregate Storage Load Buffers" ], "summary":"Create Buffer", "description":"Creates an aggregate storage data load buffer with the specified options.
In REST API, the jobType to load data without use of buffers is dataload. The jobTypes you need to load data incrementally to aggregate storage cubes (using buffers) are asoBufferDataLoad and asoBufferCommit.
The workflow in REST API to load data to aggregate storage cubes using buffers is:
Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DataLoadBuffer" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/DataLoadBuffer" } } } }, "responses":{ "200":{ "description":"OK
Load buffer created successfully.
" }, "400":{ "description":"Bad Request
Failed to create load buffer.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-asodataload-buffers-post", "x-filename-id":"applications-applicationname-databases-databasename-asodataload-buffers-post" }, "delete":{ "tags":[ "Aggregate Storage Load Buffers" ], "summary":"Destroy Dataload Buffer", "description":"Destroys data load buffer with the specified ids.
", "operationId":"ASOLoadBuffers.destroyBuffers", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Buffer Ids", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DestroyBuffer" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/DestroyBuffer" } } } }, "responses":{ "200":{ "description":"OK
Load buffers destroyed successfully.
" }, "400":{ "description":"Bad Request
Failed to destroy load buffers.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-asodataload-buffers-delete", "x-filename-id":"applications-applicationname-databases-databasename-asodataload-buffers-delete" } }, "/applications/{applicationName}/databases/{databaseName}/asodataload/actions/merge":{ "post":{ "tags":[ "Aggregate Storage Load Buffers" ], "summary":"Merge Data", "description":"Merges aggregate storage incremental data slices.
", "operationId":"ASOLoadBuffers.merge", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MergeSilceOption" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/MergeSilceOption" } } } }, "responses":{ "200":{ "description":"OK
Data merged successfully.
" }, "400":{ "description":"Bad Request
Failed to merge data.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-asodataload-actions-merge-post", "x-filename-id":"applications-applicationname-databases-databasename-asodataload-actions-merge-post" } }, "/preferences/grid":{ "get":{ "tags":[ "Grid Preferences" ], "summary":"Get Grid Preferences", "description":"Returns the grid preferences from the session.
", "operationId":"GridPreferences.get", "responses":{ "200":{ "description":"OK
Grid preferences retrieved successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Preferences" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Preferences" } } } }, "400":{ "description":"Bad Request
Failed to get grid preferences. The session may be invalid.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"preferences-grid-get", "x-filename-id":"preferences-grid-get" }, "put":{ "tags":[ "Grid Preferences" ], "summary":"Set Grid Preferences", "description":"Sets the grid preferences for the current session.
", "operationId":"GridPreferences.set", "requestBody":{ "description":"Grid preferences to be stored in the session.
", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Preferences" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Grid preferences set successfully.
" }, "400":{ "description":"Bad Request
Failed to set grid preferences. The session may be invalid.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"preferences-grid-put", "x-filename-id":"preferences-grid-put" } }, "/applications/{applicationName}/databases/{databaseName}/grid":{ "get":{ "tags":[ "Grid" ], "summary":"Get Default Grid", "description":"Returns the default grid for the specified cube. The default grid is the first grid you would see in an ad hoc analysis of the database, before performing any grid operations.
", "operationId":"Grid.getDefault", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name for default grid.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database/Cube name for default grid.
", "required":true, "schema":{ "type":"string" } }, { "name":"reset", "in":"query", "description":"Reset flag to avoid saved grid layout.
", "schema":{ "type":"boolean", "default":false } } ], "responses":{ "200":{ "description":"OK
Grid returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Grid" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Grid" } } } }, "400":{ "description":"Bad Request
Validation failed. The application or database name may be missing or incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-grid-get", "x-filename-id":"applications-applicationname-databases-databasename-grid-get" }, "post":{ "tags":[ "Grid" ], "summary":"Execute Grid Operation", "description":"Returns the grid for specified operation. Supported grid operations are Zoom In (zoomin), Zoom Out (zoomout), Refresh (refresh), Keep Only (keeponly), Remove Only (removeonly), Submit (submit), Pivot (pivot), and Pivot To POV (pivotToPOV).
", "operationId":"Grid.execute", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name for grid operation.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database/Cube name for grid operation.
", "required":true, "schema":{ "type":"string" } }, { "name":"svParity", "in":"query", "description":"Default is true. When repeatMemberLabels is set to false in the Essbase session's grid preferences, repeated headings for column/page orientation on the grid are not preserved after a retrieval in the REST API, whereas they are preserved in the similar Java API operation. If you require preservation of repeated column headings (Java API like behavior), set svParity to false.
Grid Operation to be performed.
", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/GridOperation" } } } }, "responses":{ "200":{ "description":"OK
Grid operation completed successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Grid" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Grid" } } } }, "400":{ "description":"Bad Request
Failed to execute grid operation. The application name or database name may be incorrect or missing.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-grid-post", "x-filename-id":"applications-applicationname-databases-databasename-grid-post" } }, "/applications/{applicationName}/databases/{databaseName}/grid/layout/{layout}":{ "get":{ "tags":[ "Grid" ], "summary":"Execute Grid Layout", "description":"Renders the grid for the specified layout.
", "operationId":"Grid.executeLayout", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name for grid layout.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database/Cube name for grid layout.
", "required":true, "schema":{ "type":"string" } }, { "name":"layout", "in":"path", "description":"Layout name to be executed.
", "required":true, "schema":{ "type":"string" } }, { "name":"user", "in":"query", "description":"Owner of the layout.
", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Grid layout rendered successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Grid" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Grid" } } } }, "400":{ "description":"Bad Request
Validation failed. The application, database, or layout name may be missing or incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-grid-layout-{layout}-get", "x-filename-id":"applications-applicationname-databases-databasename-grid-layout-layout-get" } }, "/applications/{applicationName}/databases/{databaseName}/grid/mdx":{ "post":{ "tags":[ "Grid" ], "summary":"Execute MDX Report", "description":"Returns an output grid from the specified MDX report.
", "operationId":"Grid.executeMDX", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name for grid.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database/Cube name for grid.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"MDX report for grid.
", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/MDXOperation" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Grid returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Grid" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Grid" } } } }, "400":{ "description":"Bad Request
Validation failed. The application, database, or MDX report name may be missing or incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-grid-mdx-post", "x-filename-id":"applications-applicationname-databases-databasename-grid-mdx-post" } }, "/applications/{applicationName}/databases/{databaseName}/grid/layout":{ "post":{ "tags":[ "Grid" ], "summary":"Get Layout Grid", "description":"Returns the layout grid for the current grid to be saved as layout for the specified cube.
", "operationId":"Grid.getLayoutGrid", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name for default grid.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database/Cube name for default grid.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"The current grid displayed.
", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Grid" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Layout grid returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Grid" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Grid" } } } }, "400":{ "description":"Bad Request
Validation failed. The application or database name may be missing or incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-grid-layout-post", "x-filename-id":"applications-applicationname-databases-databasename-grid-layout-post" } }, "/performance/files":{ "get":{ "tags":[ "Performance Analyzer" ], "summary":"Get Performance Analyzer Files", "description":"Gets compressed Performance Analyzer activity data files. Performance Analyzer helps you monitor usage and performance statistics of your Essbase service. Requires Service Administrator role.
", "operationId":"Performance.getFiles", "responses":{ "200":{ "description":"OK
Files returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PerformanceFiles" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/PerformanceFiles" } } } }, "400":{ "description":"Bad Request
Failed to get Performance Analyzer files.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"performance-files-get", "x-filename-id":"performance-files-get" }, "delete":{ "tags":[ "Performance Analyzer" ], "summary":"Delete Performance Analyzer Files", "description":"Deletes all of the Performance Analyzer activity data files. Requires Service Administrator role.
", "operationId":"Performance.deleteall", "responses":{ "200":{ "description":"OK
Files deleted successfully.
", "content":{ "application/json":{ "schema":{ "type":"object" } }, "application/xml":{ "schema":{ "type":"object" } } } }, "400":{ "description":"Bad Request
Failed to delete Performance Analyzer files.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"performance-files-delete", "x-filename-id":"performance-files-delete" } }, "/performance/files/{file}":{ "get":{ "tags":[ "Performance Analyzer" ], "summary":"Get Performance Analyzer File", "description":"Gets the specified Performance Analyzer activity data file. Requires Service Administrator role.
", "operationId":"Performance.download", "parameters":[ { "name":"file", "in":"path", "description":"File", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
File downloaded successfully.
" }, "400":{ "description":"Bad Request
Failed to get Performance Analyzer file.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"performance-files-{file}-get", "x-filename-id":"performance-files-file-get" } }, "/performance/files/actions/download":{ "get":{ "tags":[ "Performance Analyzer" ], "summary":"Get Performance Analyzer File", "description":"Get all the performance analyzer files as a compressed file.
", "operationId":"Performance.downloadall", "responses":{ "200":{ "description":"OK
File downloaded successfully.
" }, "400":{ "description":"Bad Request
Failed to get Performance Analyzer file.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"performance-files-actions-download-get", "x-filename-id":"performance-files-actions-download-get" } }, "/performance/settings":{ "get":{ "tags":[ "Performance Analyzer" ], "summary":"Get Performance Analyzer Settings", "description":"Gets the Performance Analyzer settings. You can see whether Performance Analyzer is enabled and view the time interval setting for creation of new data files. Requires Service Administrator role.
", "operationId":"Performance.getConfig", "responses":{ "200":{ "description":"OK
Performance Analyzer settings returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/HPA" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/HPA" } } } }, "400":{ "description":"Bad Request
Failed to get Performance Analyzer settings.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"performance-settings-get", "x-filename-id":"performance-settings-get" }, "put":{ "tags":[ "Performance Analyzer" ], "summary":"Set Performance Analyzer Settings", "description":"Changes the Performance Analyzer settings: you can enable or disable it or change the time interval for creation of new data files. Requires Service Administrator role.
", "operationId":"Performance.setConfig", "requestBody":{ "description":"Performance Analyzer configuration input.
", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/HPA" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Performance Analyzer settings configured successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/HPA" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/HPA" } } } }, "400":{ "description":"Bad Request
Failed to store Performance Analyzer settings.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"performance-settings-put", "x-filename-id":"performance-settings-put" } }, "/applications/{application}/databases/{database}/layouts":{ "get":{ "tags":[ "Layouts" ], "summary":"List Grid Layouts", "description":"Lists the available saved grid layouts. If you are a service administrator, all saved layouts are listed, including those created by other users.
A layout is a saved grid shape associated with a cube. If you create a grid that you would like to use again in the future, you can save it as a Layout. Layouts and reports are included when the cube is copied or moved using migration, export, and Lifecycle Management (LCM) tools.
", "operationId":"Layouts.getLayouts", "parameters":[ { "name":"application", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"database", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
List of layouts returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Layouts" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Layouts" } } } }, "400":{ "description":"Bad Request
Failed to get layouts.
" } }, "x-internal-id":"applications-{application}-databases-{database}-layouts-get", "x-filename-id":"applications-application-databases-database-layouts-get" }, "post":{ "tags":[ "Layouts" ], "summary":"Save Grid Layout", "description":"Saves a grid layout for the specified cube. A layout is a saved grid shape associated with a cube. If you create a grid that you would like to use again in the future, you can save it as a Layout. Layouts and reports are included when the cube is copied or moved using migration, export, and Lifecycle Management (LCM) tools.
", "operationId":"Layouts.saveLayout", "parameters":[ { "name":"application", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"database", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Grid to be saved as a layout.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Layout" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Layout" } } } }, "responses":{ "200":{ "description":"OK
Layout saved successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Layout" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Layout" } } } }, "400":{ "description":"Bad Request
Failed to save layout.
" } }, "x-internal-id":"applications-{application}-databases-{database}-layouts-post", "x-filename-id":"applications-application-databases-database-layouts-post" } }, "/applications/{application}/databases/{database}/layouts/{layout}":{ "get":{ "tags":[ "Layouts" ], "summary":"Get Grid Layout Details", "description":"Gets the details for the specified layout.
A layout is a saved grid shape associated with a cube. If you create a grid that you would like to use again in the future, you can save it as a Layout. Layouts and reports are included when the cube is copied or moved using migration, export, and Lifecycle Management (LCM) tools.
", "operationId":"Layouts.getLayoutDetails", "parameters":[ { "name":"application", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"database", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"layout", "in":"path", "description":"Layout name.
", "required":true, "schema":{ "type":"string" } }, { "name":"user", "in":"query", "description":"Username.
", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Layout details returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Layout" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Layout" } } } }, "400":{ "description":"Bad Request
Failed to get layout details.
" } }, "x-internal-id":"applications-{application}-databases-{database}-layouts-{layout}-get", "x-filename-id":"applications-application-databases-database-layouts-layout-get" }, "put":{ "tags":[ "Layouts" ], "summary":"Update Grid Layout", "description":"Updates the layout with the provided details in the specified cube.
", "operationId":"Layouts.editLayout", "parameters":[ { "name":"application", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"database", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"layout", "in":"path", "description":"Layout name.
", "required":true, "schema":{ "type":"string" } }, { "name":"user", "in":"query", "description":"Username.
", "schema":{ "type":"string" } } ], "requestBody":{ "description":"Layout details to be updated.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Layout" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Layout" } } } }, "responses":{ "200":{ "description":"OK
Layout updated successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Layout" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Layout" } } } }, "400":{ "description":"Bad Request
Failed to update layout.
" } }, "x-internal-id":"applications-{application}-databases-{database}-layouts-{layout}-put", "x-filename-id":"applications-application-databases-database-layouts-layout-put" }, "delete":{ "tags":[ "Layouts" ], "summary":"Delete Grid Layout", "description":"Deletes the layout in the specified cube.
", "operationId":"Layouts.deleteLayout", "parameters":[ { "name":"application", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"database", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"layout", "in":"path", "description":"Layout name.
", "required":true, "schema":{ "type":"string" } }, { "name":"user", "in":"query", "description":"Username.
", "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"OK
Layout deleted successfully.
" }, "400":{ "description":"Bad Request
Failed to delete layout.
" } }, "x-internal-id":"applications-{application}-databases-{database}-layouts-{layout}-delete", "x-filename-id":"applications-application-databases-database-layouts-layout-delete" } }, "/applications/{application}/databases/{database}/layouts/{layout}/actions/markDefault":{ "post":{ "tags":[ "Layouts" ], "summary":"Mark Grid Layout as Default", "description":"Marks a saved grid layout as the default grid view for this user or this cube. Requires Database Access permission to set the user default layout, and Database Manager permission to set the cube default layout.
", "operationId":"Layouts.markDefaultLayout", "parameters":[ { "name":"application", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"database", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"layout", "in":"path", "description":"Saved grid layout name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"User default or database default details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DefaultLayoutBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/DefaultLayoutBean" } } } }, "responses":{ "200":{ "description":"OK
Layout successfully marked as default.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Layout" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Layout" } } } }, "400":{ "description":"Bad Request
Failed to mark layout as user default or database default.
" } }, "x-internal-id":"applications-{application}-databases-{database}-layouts-{layout}-actions-markDefault-post", "x-filename-id":"applications-application-databases-database-layouts-layout-actions-markdefault-post" } }, "/applications/{application}/databases/{database}/mdx":{ "post":{ "tags":[ "Execute MDX" ], "summary":"Run MDX Query", "description":"Runs an MDX query, returning the results in the selected format (JSON, HTML, Excel, or CSV).
Results are an MDX output set in the requested format (the default is JSON). The output set contains metadata (including page, column, and row tuples) followed by data (a tuple for each row).
", "operationId":"MDX.executeMDX", "parameters":[ { "name":"application", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"database", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"format", "in":"query", "description":"Result format.
", "schema":{ "type":"string", "enum":[ "XLSX", "CSV", "HTML", "JSON" ], "default":"JSON" } } ], "requestBody":{ "description":"MDX query and preferences. Use this to execute an MDX query directly as a string, rather than running a saved MDX report (a named query saved in the cube context).
", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/MDXInput" } } } }, "responses":{ "200":{ "description":"Mostly OK
As this is a streaming API, it can fail even with status 200. Check for an errorMessage tag in the response to identify any errors.
Bad Request
Failed to get the data in the required format.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{application}-databases-{database}-mdx-post", "x-filename-id":"applications-application-databases-database-mdx-post" } }, "/applications/{application}/databases/{database}/mdx/{name}":{ "get":{ "tags":[ "Execute MDX" ], "summary":"Run MDX Report", "description":"Runs an MDX report, returning the results in the selected format (JSON, HTML, Excel, or CSV). An MDX report is saved in the cube context.
See also:
", "operationId":"MDX.executenq", "parameters":[ { "name":"application", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"database", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"name", "in":"path", "description":"MDX report name.
", "required":true, "schema":{ "type":"string" } }, { "name":"format", "in":"query", "description":"Result format.
", "schema":{ "type":"string", "enum":[ "XLSX", "CSV", "HTML", "JSON" ], "default":"JSON" } }, { "name":"aliasTable", "in":"query", "description":"Alias table name.
", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Mostly OK
As this is a streaming API, it can fail even with status 200. Check for an errorMessage tag in the response to identify any errors.
Bad Request
Failed to get the data in the required format.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{application}-databases-{database}-mdx-{name}-get", "x-filename-id":"applications-application-databases-database-mdx-name-get" } }, "/applications/{application}/databases/{database}/queries":{ "get":{ "tags":[ "MDX Reports" ], "summary":"List MDX Reports", "description":"List all the saved MDX reports for the specified cube.
An MDX report is saved in the cube context.
See also:
", "operationId":"namedqueries.getNamedQueries", "parameters":[ { "name":"application", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"database", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
List of MDX reports returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Queries" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Queries" } } } }, "400":{ "description":"Bad Request
Failed to get MDX reports.
" } }, "x-internal-id":"applications-{application}-databases-{database}-queries-get", "x-filename-id":"applications-application-databases-database-queries-get" }, "post":{ "tags":[ "MDX Reports" ], "summary":"Save MDX Report", "description":"Saves an MDX report for the specified cube.
See also:
", "operationId":"namedqueries.saveNamedQuery", "parameters":[ { "name":"application", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"database", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Details of query to be saved.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/NamedQuery" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/NamedQuery" } } } }, "responses":{ "200":{ "description":"OK
MDX report saved successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/NamedQuery" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/NamedQuery" } } } }, "400":{ "description":"Bad Request
Failed to save MDX report.
" } }, "x-internal-id":"applications-{application}-databases-{database}-queries-post", "x-filename-id":"applications-application-databases-database-queries-post" } }, "/applications/{application}/databases/{database}/queries/{query}":{ "get":{ "tags":[ "MDX Reports" ], "summary":"Get MDX Report Details", "description":"Get the details for the specified MDX report.
An MDX report is saved in the cube context.
See also:
", "operationId":"namedqueries.getNamedQueryDetails", "parameters":[ { "name":"application", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"database", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"query", "in":"path", "description":"MDX report name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
MDX report details returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/NamedQuery" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/NamedQuery" } } } }, "400":{ "description":"Bad Request
Failed to get MDX report details.
" } }, "x-internal-id":"applications-{application}-databases-{database}-queries-{query}-get", "x-filename-id":"applications-application-databases-database-queries-query-get" }, "put":{ "tags":[ "MDX Reports" ], "summary":"Update MDX Report", "description":"Update the MDX report for the specified cube.
", "operationId":"namedqueries.editNamedQuery", "parameters":[ { "name":"application", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"database", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"query", "in":"path", "description":"MDX report name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Details of MDX report to be updated.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Query" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Query" } } } }, "responses":{ "200":{ "description":"OK
MDX report updated successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/NamedQuery" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/NamedQuery" } } } }, "400":{ "description":"Bad Request
Failed to update MDX report.
" } }, "x-internal-id":"applications-{application}-databases-{database}-queries-{query}-put", "x-filename-id":"applications-application-databases-database-queries-query-put" }, "delete":{ "tags":[ "MDX Reports" ], "summary":"Delete MDX Report", "description":"Delete the MDX report for specified cube.
See also:
", "operationId":"namedqueries.deleteNamedQuery", "parameters":[ { "name":"application", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"database", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"query", "in":"path", "description":"MDX report name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"OK
MDX report deleted successfully.
" }, "400":{ "description":"Bad Request
Failed to delete MDX report.
" } }, "x-internal-id":"applications-{application}-databases-{database}-queries-{query}-delete", "x-filename-id":"applications-application-databases-database-queries-query-delete" } }, "/applications/{application}/databases/{database}/queries/rename":{ "put":{ "tags":[ "MDX Reports" ], "summary":"Rename MDX Report", "description":"Rename named query for specified cube and application.
", "operationId":"rename", "parameters":[ { "name":"application", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"database", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"source", "in":"query", "description":"Existing name of MDX report
", "required":true, "schema":{ "type":"string" } }, { "name":"dest", "in":"query", "description":"New name of MDX report
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
MDX report renamed successfully.
" }, "400":{ "description":"Bad Request
Failed to rename MDX query.
" } }, "x-internal-id":"applications-{application}-databases-{database}-queries-rename-put", "x-filename-id":"applications-application-databases-database-queries-rename-put" } }, "/applications/{applicationName}/databases/{databaseName}/settings/querytracking/export":{ "post":{ "tags":[ "Database Settings and Statistics" ], "summary":"Export Query Tracking", "description":"Export query data from an aggregate storage (ASO) database to a text file. Essbase tracks query data to optimize aggregate views based on usage.
When an ASO cube is refreshed or restarted, query data does not persist. As an optimization technique, before refreshing or restarting, you can export query tracking data to a text file. To rebuild aggregate views after a refresh or restart, import the query tracking data from the text file. Essbase uses the query data to select the most appropriate set of aggregate views to materialize.
To perform this operation, query tracking must be enabled for the current ASO cube. Query tracking is enabled by default. To ensure that query tracking is enabled, use Get General Settings and ensure that queryTracking is true.
Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"File name.
", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/QueryTrackingInputs" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Query data exported successfully.
" }, "400":{ "description":"Bad Request
Failed to export query data.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-settings-querytracking-export-post", "x-filename-id":"applications-applicationname-databases-databasename-settings-querytracking-export-post" } }, "/applications/{applicationName}/databases/{databaseName}/settings/compressioninfo":{ "get":{ "tags":[ "Database Settings and Statistics" ], "summary":"Get ASO Compression Info", "description":"Returns estimated compression information for the ASO cube when different dimensions are hypothetically used as the compression dimension. These estimates can help you choose the best dimension to use as the compression dimension.
If you include query parameter fetch=true, this API initiates an internal system job which evaluates the whole cube in terms of ASO compression. To monitor the job progress, you can use Get Job List. The job type is listed as ASO Compression information, and the job stores the compression information. This job is not available to rerun. When any user calls this API without the fetch=true parameter, the result is retrieved from the stored system job. To re-evaluate the cube for ASO compression information, call the API again with fetch=true.
| Column Name | Description |
|---|---|
| dimensionName | Each dimension name in the cube, hypothetically considered to be the compression dimension. |
| isCompression | Indicates whether the dimension is the ASO compression dimension. There can be only one compression dimension in an ASO cube. |
| storedLevel0Members | The number of leaf-level members in the dimension. A large number of stored level-0 members in a dimension indicates that it may not perform well as a compression dimension. |
| averageBundleFill | Estimated average number of values per compression dimension bundle. Choosing a compression dimension that has a higher average bundle fill means that the cube compresses better. |
| averageValueLength | Estimated average number of bytes required to store a value. Dimensions with a smaller average value length compress the cube better. |
| level0MB | Estimated size of the compressed cube, in megabytes. A smaller expected level-0 size indicates that choosing this dimension enables better compression. Except for the scenario in which there is no compression dimension (No Compression Dimension), all estimates assume that all pages are compressed. As compressed pages require additional overhead that uncompressed pages do not, the estimated level-0 cube size for some dimensions may be larger than the value for No Compression Dimension. |
Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database (cube) name.
", "required":true, "schema":{ "type":"string" } }, { "name":"fetch", "in":"query", "description":"Set fetch parameter to true if you need to re-evaluate compression info. The default value is false.
", "schema":{ "type":"boolean", "default":false } } ], "responses":{ "200":{ "description":"OK
Compression info retrieved successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CompressionInfoOutput" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/CompressionInfoOutput" } } } }, "400":{ "description":"Bad Request
Failed to get compression info. The application or database name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-settings-compressioninfo-get", "x-filename-id":"applications-applicationname-databases-databasename-settings-compressioninfo-get" } }, "/applications/{applicationName}/databases/{databaseName}/settings/buffers":{ "get":{ "tags":[ "Database Settings and Statistics" ], "summary":"Get Buffer Settings", "description":"Returns buffer settings of the specified database.
", "operationId":"DatabaseSettingsStatistics.getBuffersSettings", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Buffer settings retrieved successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BufferSettings" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/BufferSettings" } } } }, "400":{ "description":"Bad Request
Failed to get the buffer settings. The application or database name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-settings-buffers-get", "x-filename-id":"applications-applicationname-databases-databasename-settings-buffers-get" } }, "/applications/{applicationName}/databases/{databaseName}/settings/caches":{ "get":{ "tags":[ "Database Settings and Statistics" ], "summary":"Get Cache Settings", "description":"Returns cache settings of the specified database.
", "operationId":"DatabaseSettingsStatistics.getCachesSettings", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Cache settings returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CacheSettings" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/CacheSettings" } } } }, "400":{ "description":"Bad Request
Failed to get the cache settings. The application or database name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-settings-caches-get", "x-filename-id":"applications-applicationname-databases-databasename-settings-caches-get" } }, "/applications/{applicationName}/databases/{databaseName}/settings/calculation":{ "get":{ "tags":[ "Database Settings and Statistics" ], "summary":"Get Calculation Settings", "description":"Returns calculation settings of the specified database.
", "operationId":"DatabaseSettingsStatistics.getCalculationSettings", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Calculation settings retrieved successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CalculationSettings" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/CalculationSettings" } } } }, "400":{ "description":"Bad Request
Failed to get the calculation settings. The application or database name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-settings-calculation-get", "x-filename-id":"applications-applicationname-databases-databasename-settings-calculation-get" } }, "/applications/{applicationName}/databases/{databaseName}/settings/compression":{ "get":{ "tags":[ "Database Settings and Statistics" ], "summary":"Get Compression Settings", "description":"Returns compression settings of the specified database.
", "operationId":"DatabaseSettingsStatistics.getCompressSettings_1", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Compression settings retrieved successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CompressionSettings" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/CompressionSettings" } } } }, "400":{ "description":"Bad Request
Failed to get the compression settings. The application or database name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-settings-compression-get", "x-filename-id":"applications-applicationname-databases-databasename-settings-compression-get" } }, "/applications/{applicationName}/databases/{databaseName}/settings/outline/attributes":{ "get":{ "tags":[ "Database Settings and Statistics" ], "summary":"Get Attribute Settings", "description":"Returns attribute settings of the outline from the specified database.
", "operationId":"DatabaseSettingsStatistics.getOutlineAttributesSettings", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"connectionName", "in":"query", "description":"Essbase connection name.
", "schema":{ "type":"string" } }, { "name":"applicationNameForConnection", "in":"query", "description":"Application name for connection.
", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Attribute settings returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AttributeOutlineSettings" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/AttributeOutlineSettings" } } } }, "400":{ "description":"Bad Request
Failed to get the attribute settings. The application or database name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-settings-outline-attributes-get", "x-filename-id":"applications-applicationname-databases-databasename-settings-outline-attributes-get" } }, "/applications/{applicationName}/databases/{databaseName}/settings/outline":{ "get":{ "tags":[ "Database Settings and Statistics" ], "summary":"Get Outline Settings", "description":"Returns outline settings of the specified database. Additional settings can be retrieved using the expand parameter.
Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"connectionName", "in":"query", "description":"Essbase connection name.
", "schema":{ "type":"string" } }, { "name":"applicationNameForConnection", "in":"query", "description":"Application name for connection.
", "schema":{ "type":"string" } }, { "name":"expand", "in":"query", "description":"Use none to show only general outline settings (this is the default). Other options available are attribute and all.",
"schema":{
"type":"string",
"enum":[
"none",
"attributes",
"all"
],
"default":"none"
}
}
],
"responses":{
"200":{
"description":"
OK
Database outline settings returned successfully, with links to get expanded settings.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/OutlineSettingsList" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/OutlineSettingsList" } } } }, "400":{ "description":"Bad Request
Failed to get the settings. The application or database name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-settings-outline-get", "x-filename-id":"applications-applicationname-databases-databasename-settings-outline-get" }, "patch":{ "tags":[ "Database Settings and Statistics" ], "summary":"Update Outline Settings", "description":"Updates the outline settings of the specified database. This operation has limited capacity. For more outline update options, refer to the otlUpdate action in Run Batch Outline Edit API.
", "operationId":"DatabaseSettingsStatistics.updateOutlineSettings", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Outline settings patch list.
", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/PatchElement" } } }, "application/xml":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/PatchElement" } } } }, "required":true }, "responses":{ "204":{ "description":"OK
Outline settings updated successfully.
" }, "400":{ "description":"Bad Request
Failed to update the settings. The application or database name may be incorrect, or the JSON for the settings may be incorrect.
" }, "415":{ "description":"Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-settings-outline-patch", "x-filename-id":"applications-applicationname-databases-databasename-settings-outline-patch" } }, "/applications/{applicationName}/databases/{databaseName}/settings/outline/dateformats":{ "get":{ "tags":[ "Database Settings and Statistics" ], "summary":"Get Date Formats", "description":"Returns date formats of the outline from the specified database.
", "operationId":"DatabaseSettingsStatistics.getOutlineSettingsDateFormats", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Date formats retrieved successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/OutlineDateFormat" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/OutlineDateFormat" } } } }, "400":{ "description":"Bad Request
Failed to get the date formats. The application or database name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-settings-outline-dateformats-get", "x-filename-id":"applications-applicationname-databases-databasename-settings-outline-dateformats-get" } }, "/applications/{applicationName}/databases/{databaseName}/statistics/runtime":{ "get":{ "tags":[ "Database Settings and Statistics" ], "summary":"Get Runtime Statistics", "description":"Returns runtime statistics of the specified database.
", "operationId":"DatabaseSettingsStatistics.getRuntimeStats", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Database runtime statistics returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RuntimeStatistics" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/RuntimeStatistics" } } } }, "400":{ "description":"Bad Request
Failed to get database runtime statistics. The application or database name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-statistics-runtime-get", "x-filename-id":"applications-applicationname-databases-databasename-statistics-runtime-get" } }, "/applications/{applicationName}/databases/{databaseName}/settings":{ "get":{ "tags":[ "Database Settings and Statistics" ], "summary":"Get General Settings", "description":"Returns general settings of the specified database. Additional groups of settings can be expanded using the expand parameter. If expand is none, links are returned for the additional groups of settings.
Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"expand", "in":"query", "description":"Use none to show only general settings, with links for other grouped settings. Other expansion options available:
startup (block storage cubes only)calculation (block storage only)bufferscaches (block storage only)transactions (block storage only)compression (aggregate storage only)allOK
General database settings returned successfully, with links to get expanded settings.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SettingsList" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/SettingsList" } } } }, "400":{ "description":"Bad Request
Failed to get database settings. The application or database name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-settings-get", "x-filename-id":"applications-applicationname-databases-databasename-settings-get" }, "patch":{ "tags":[ "Database Settings and Statistics" ], "summary":"Update Settings", "description":"Updates the settings of the specified database.
", "operationId":"DatabaseSettingsStatistics.updateSettings", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Database settings patch list.
", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/PatchElement" } } }, "application/xml":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/PatchElement" } } } }, "required":true }, "responses":{ "204":{ "description":"OK
Settings updated successfully.
" }, "400":{ "description":"Bad Request
Failed to update the settings. The application or database name may be incorrect, or the JSON for the settings may be incorrect.
" }, "415":{ "description":"Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-settings-patch", "x-filename-id":"applications-applicationname-databases-databasename-settings-patch" } }, "/applications/{applicationName}/databases/{databaseName}/settings/startup":{ "get":{ "tags":[ "Database Settings and Statistics" ], "summary":"Get Startup Settings", "description":"Returns startup settings of the specified database.
", "operationId":"DatabaseSettingsStatistics.getStartupSettings", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Startup settings returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/StartupSettings" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/StartupSettings" } } } }, "400":{ "description":"Bad Request
Failed to return the startup settings. The application or database name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-settings-startup-get", "x-filename-id":"applications-applicationname-databases-databasename-settings-startup-get" } }, "/applications/{applicationName}/databases/{databaseName}/statistics":{ "get":{ "tags":[ "Database Settings and Statistics" ], "summary":"Get General Statistics", "description":"Returns general statistics of the specified database. Additional statistics can be retrieved using the expand parameter.
Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"expand", "in":"query", "description":"Use none to show only general statistics (this is the default). Other options available: storage, runtime, and all.
OK
General database statistics returned successfully, with links to get expanded statistics.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/StatisticsList" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/StatisticsList" } } } }, "400":{ "description":"Bad Request
Failed to get the statistics. The application or database name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-statistics-get", "x-filename-id":"applications-applicationname-databases-databasename-statistics-get" } }, "/applications/{applicationName}/databases/{databaseName}/statistics/storage":{ "get":{ "tags":[ "Database Settings and Statistics" ], "summary":"Get Storage Statistics", "description":"Returns storage statistics of the specified database.
", "operationId":"DatabaseSettingsStatistics.getStorageStats", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Database storage statistics returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/StorageStatistics" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/StorageStatistics" } } } }, "400":{ "description":"Bad Request
Failed to get storage statistics. The application or database name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-statistics-storage-get", "x-filename-id":"applications-applicationname-databases-databasename-statistics-storage-get" } }, "/applications/{applicationName}/databases/{databaseName}/settings/transactions":{ "get":{ "tags":[ "Database Settings and Statistics" ], "summary":"Get Transaction Settings", "description":"Returns transaction settings of the specified database.
", "operationId":"DatabaseSettingsStatistics.getTransSettings", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Transaction settings returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TransactionSettings" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/TransactionSettings" } } } }, "400":{ "description":"Bad Request
Failed to get the transaction settings. The application or database name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-settings-transactions-get", "x-filename-id":"applications-applicationname-databases-databasename-settings-transactions-get" } }, "/applications/{applicationName}/databases/{databaseName}/settings/querytracking/import":{ "post":{ "tags":[ "Database Settings and Statistics" ], "summary":"Import Query Tracking", "description":"Import query tracking data from a text file to an Essbase aggregate storage (ASO) database. Essbase tracks query data to optimize aggregate views based on usage.
When an ASO cube is refreshed or restarted, query data does not persist. As an optimization technique, before refreshing or restarting, you can export query tracking data to a text file. To rebuild aggregate views after a refresh or restart, import the query tracking data from the text file. Essbase uses the query data to select the most appropriate set of aggregate views to materialize.
To perform this operation, query tracking must be enabled for the current ASO cube. Query tracking is enabled by default. To ensure that query tracking is enabled, use Get General Settings and ensure that queryTracking is true.
Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"File name.
", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/QueryTrackingInputs" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Query data imported successfully.
" }, "400":{ "description":"Bad Request
Failed to import query data.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-settings-querytracking-import-post", "x-filename-id":"applications-applicationname-databases-databasename-settings-querytracking-import-post" } }, "/applications/{applicationName}/settings/security":{ "get":{ "tags":[ "Application Settings and Statistics" ], "summary":"Get Application Security Settings", "description":"Returns the security settings of the specified application.
", "operationId":"ApplicationSettingsStatistics.getSecuritySettings", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Security settings returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AppSecuritySettings" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/AppSecuritySettings" } } } }, "400":{ "description":"Bad Request
Failed to get the security settings. The application name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-settings-security-get", "x-filename-id":"applications-applicationname-settings-security-get" } }, "/applications/{applicationName}/settings":{ "get":{ "tags":[ "Application Settings and Statistics" ], "summary":"Get Application General Settings", "description":"Returns general settings of the specified application. Additional settings can be retrieved using the expand parameter.
Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"expand", "in":"query", "description":"Use none to show only general settings (this is the default). Other options available: startup, security, and all.
OK
General application settings returned successfully, with links to get expanded settings and to edit settings.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AppSettingsList" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/AppSettingsList" } } } }, "400":{ "description":"Failed to get the settings. The application name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-settings-get", "x-filename-id":"applications-applicationname-settings-get" }, "patch":{ "tags":[ "Application Settings and Statistics" ], "summary":"Update Application Settings", "description":"Updates the settings of the specified application.
", "operationId":"ApplicationSettingsStatistics.updateSettings", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Application settings patch list.
", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/PatchElement" } } }, "application/xml":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/PatchElement" } } } }, "required":true }, "responses":{ "204":{ "description":"OK
Settings updated successfully.
" }, "400":{ "description":"Bad Request
Failed to update the settings. The application name may be incorrect, or the JSON for the settings may be incorrect.
" }, "415":{ "description":"Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-settings-patch", "x-filename-id":"applications-applicationname-settings-patch" } }, "/applications/{applicationName}/settings/startup":{ "get":{ "tags":[ "Application Settings and Statistics" ], "summary":"Get Application Startup Settings", "description":"Returns the startup settings of the specified application.
", "operationId":"ApplicationSettingsStatistics.getStartupSettings", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Startup settings retrieved successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AppStartupSettings" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/AppStartupSettings" } } } }, "400":{ "description":"Bad Request
Failed to get the startup settings. The application name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-settings-startup-get", "x-filename-id":"applications-applicationname-settings-startup-get" } }, "/applications/{applicationName}/statistics":{ "get":{ "tags":[ "Application Settings and Statistics" ], "summary":"Get Application Statistics", "description":"Returns the statistics of the specified application.
", "operationId":"ApplicationSettingsStatistics.getStatistics", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Statistics retrieved successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApplicationStatistics" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApplicationStatistics" } } } }, "400":{ "description":"Bad Request
Failed to get the statistics. The application name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-statistics-get", "x-filename-id":"applications-applicationname-statistics-get" } }, "/outline/{app}/{cube}/settings/smartlist":{ "get":{ "tags":[ "Outline Viewer" ], "summary":"Get Text Lists", "description":"Returns all text lists associated with the database outline.
", "operationId":"Outline.getAllSmartList", "parameters":[ { "name":"app", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"cube", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"connection", "in":"query", "description":"Essbase connection name.
", "required":true, "schema":{ "type":"string" } }, { "name":"applicationNameForConnection", "in":"query", "description":"Application name for connection.
", "required":true, "schema":{ "type":"string" } }, { "name":"accept", "in":"header", "schema":{ "type":"string", "default":"application/json" } } ], "responses":{ "200":{ "description":"OK
Text lists returned.
" } }, "x-internal-id":"outline-{app}-{cube}-settings-smartlist-get", "x-filename-id":"outline-app-cube-settings-smartlist-get" } }, "/outline/{app}/{cube}/ancestors/{memberUniqueName}":{ "get":{ "tags":[ "Outline Viewer" ], "summary":"Get Member Ancestors", "description":"Returns all ancestors of the requested member.
", "operationId":"Outline.getAncestorsMemberInfo", "parameters":[ { "name":"app", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"cube", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"memberUniqueName", "in":"path", "description":"Unique member name (fully qualified name).
", "required":true, "schema":{ "type":"string" } }, { "name":"connection", "in":"query", "description":"Essbase connection name.
", "schema":{ "type":"string" } }, { "name":"applicationNameForConnection", "in":"query", "description":"Application name for connection.
", "schema":{ "type":"string" } }, { "name":"fields", "in":"query", "description":"Comma-separated list of member properties to fetch.
", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
List of ancestors returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MemberBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/MemberBean" } } } }, "400":{ "description":"Bad Request
Failed to get ancestors.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"outline-{app}-{cube}-ancestors-{memberUniqueName}-get", "x-filename-id":"outline-app-cube-ancestors-memberuniquename-get" } }, "/outline/{app}/{cube}/descendantsCount/{memberUniqueName}":{ "get":{ "tags":[ "Outline Viewer" ], "summary":"Get Descendant Count", "description":"Retrieve descendant count for the requested member.
", "operationId":"Outline.getDescendantsCount", "parameters":[ { "name":"app", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"cube", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"memberUniqueName", "in":"path", "description":"Unique member name (fully qualified name).
", "required":true, "schema":{ "type":"string" } }, { "name":"connection", "in":"query", "description":"Essbase connection name.
", "schema":{ "type":"string" } }, { "name":"applicationNameForConnection", "in":"query", "description":"Application name for connection.
", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Descendants count returned successfully.
", "content":{ "text/plain":{ "schema":{ "type":"integer", "format":"int32" } } } }, "400":{ "description":"Bad Request
Failed to get descendants count.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"outline-{app}-{cube}-descendantsCount-{memberUniqueName}-get", "x-filename-id":"outline-app-cube-descendantscount-memberuniquename-get" } }, "/outline/{app}/{cube}/{memberUniqueName}":{ "get":{ "tags":[ "Outline Viewer" ], "summary":"Get Member Info", "description":"Returns either all member properties or requested member properties.
", "operationId":"Outline.getMemberInfo", "parameters":[ { "name":"app", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"cube", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"memberUniqueName", "in":"path", "description":"Unique member name (fully qualified name). Can be a member name, a member ID, or an alias. If the member name is non-unique (in a duplicate member enabled outline), use a fully qualified member name or use the member ID.
", "required":true, "schema":{ "type":"string" } }, { "name":"connection", "in":"query", "description":"Essbase connection name.
", "schema":{ "type":"string" } }, { "name":"applicationNameForConnection", "in":"query", "description":"Application name for connection.
", "schema":{ "type":"string" } }, { "name":"fields", "in":"query", "description":"Comma-separated list of member properties to fetch.
", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Member information retrieved successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MemberBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/MemberBean" } } } }, "400":{ "description":"Bad Request
Failed to get member information.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"outline-{app}-{cube}-{memberUniqueName}-get", "x-filename-id":"outline-app-cube-memberuniquename-get" } }, "/outline/{app}/{cube}":{ "get":{ "tags":[ "Outline Viewer" ], "summary":"Get Dimensions Children or Search", "description":"Returns a list of dimensions when no parameters are provided. Returns a list of child members when parent or parentUniqueName parameters are provided. Returns search results when a search keyword parameter is used.
", "operationId":"Outline.getMembers", "parameters":[ { "name":"app", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"cube", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"connection", "in":"query", "description":"Essbase connection name.
", "schema":{ "type":"string" } }, { "name":"applicationNameForConnection", "in":"query", "description":"Application name for connection.
", "schema":{ "type":"string" } }, { "name":"keyword", "in":"query", "description":"Keyword to search for member.
", "schema":{ "type":"string" } }, { "name":"matchWholeWord", "in":"query", "description":"Match member name with keyword.
", "schema":{ "type":"boolean", "default":false } }, { "name":"parent", "in":"query", "description":"Parent name.
", "schema":{ "type":"string" } }, { "name":"parentUniqueName", "in":"query", "description":"Parent unique name (fully qualified).
", "schema":{ "type":"string" } }, { "name":"isMbrId", "in":"query", "description":"Parent ID.
", "schema":{ "type":"string" } }, { "name":"fields", "in":"query", "description":"Comma-separated list of member properties to fetch.
", "schema":{ "type":"string" } }, { "name":"offset", "in":"query", "description":"Number of members to omit from the start of the result set.
", "schema":{ "type":"integer", "format":"int32", "default":0 } }, { "name":"limit", "in":"query", "description":"Maximum number of members to return.
", "schema":{ "type":"integer", "format":"int32", "default":50 } } ], "responses":{ "200":{ "description":"OK
Dimensions, children, or search results returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestCollectionResponse" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/RestCollectionResponse" } } } }, "400":{ "description":"Bad Request
Failed to get members or search results.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"outline-{app}-{cube}-get", "x-filename-id":"outline-app-cube-get" } }, "/outline/{app}/{cube}/xml":{ "post":{ "tags":[ "Outline Viewer" ], "summary":"Export Outline To XML", "description":"Exports the outline to XML. If tree is true, then aliasTable will be ignored. Tree mode exports only member names. If aliasTable is provided, then only alias values of the members for the specified alias table will be exported.
", "operationId":"Outline.getOutlineXML", "parameters":[ { "name":"app", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"cube", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"Connection name.
", "in":"query", "schema":{ "type":"string" } }, { "name":"Application name for connection.
", "in":"query", "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/ExportOptions" } } } }, "responses":{ "default":{ "description":"default response", "content":{ "application/octet-stream":{ } } } }, "x-internal-id":"outline-{app}-{cube}-xml-post", "x-filename-id":"outline-app-cube-xml-post" } }, "/outline/{app}/{cube}/pivotDimension":{ "get":{ "tags":[ "Outline Viewer" ], "summary":"Get Pivot Dimension", "description":"Get Pivot dimension details
", "operationId":"Outline.getPivotDimension", "parameters":[ { "name":"app", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"cube", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"connection", "in":"query", "description":"Essbase connection name.
", "schema":{ "type":"string" } }, { "name":"applicationNameForConnection", "in":"query", "description":"Application name for connection.
", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Pivot dimension retrieved successfully.
", "content":{ "application/json":{ "schema":{ "type":"string" } }, "application/xml":{ "schema":{ "type":"string" } } } }, "400":{ "description":"Bad Request
Failed to get pivot dimension.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"outline-{app}-{cube}-pivotDimension-get", "x-filename-id":"outline-app-cube-pivotdimension-get" } }, "/applications/{applicationName}/databases/{databaseName}/partitions":{ "get":{ "tags":[ "Partitions" ], "summary":"Get Partitions", "description":"Returns a list of partitions defined on the database, or a specific partition.
Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"type", "in":"query", "description":"Partition type. Multiple types can be added with a comma separator.
", "allowEmptyValue":true, "schema":{ "type":"string", "enum":[ "TRANSPARENT", "REPLICATED", "FEDERATED" ] } }, { "name":"offset", "in":"query", "description":"Number of partitions to omit from the start of the result set.
", "schema":{ "type":"integer", "format":"int32" } }, { "name":"limit", "in":"query", "description":"Maximum number of partitions to return.
", "schema":{ "type":"integer", "format":"int32" } }, { "name":"serverName", "in":"query", "description":"Partition source server URL, ending in /essbase/agent.
Partition source application name.
", "schema":{ "type":"string" } }, { "name":"databaseName", "in":"query", "description":"Partition source database name.
", "schema":{ "type":"string" } }, { "name":"datasourceName", "in":"query", "description":"Datasource name.
", "schema":{ "type":"string" } }, { "name":"measuresDimensionName", "in":"query", "description":"Pivot dimension name. Can be Measures dimension but does not have to be.
", "schema":{ "type":"string" } }, { "name":"applicationLevelDatasource", "in":"query", "description":"Specify whether the Datasource is defined at application level.
", "schema":{ "type":"boolean" } } ], "responses":{ "200":{ "description":"OK
Partition list or partition details returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PartitionList" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/PartitionList" } } } }, "400":{ "description":"Bad Request
Failed to get partition results.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-partitions-get", "x-filename-id":"applications-applicationname-databases-databasename-partitions-get" }, "post":{ "tags":[ "Partitions" ], "summary":"Create Partition", "description":"Creates a new partition. For partitions across instances, connectionName must be provided.
If the connection is defined at the application level, the property applicationLevelConnection must be specified as true.
If the Datasource is defined at the application level, the property applicationLevelDatasource must be specified as true.
Examples (with minimum required properties)
TRANSPARENT/REPLICATED (change type appropriately)
{'type':'TRANSPARENT','isNew':true,'sourceInfo':{'applicationName':'Sample_2','databaseName':'Basic','userName':'username','password':'password'},'targetInfo':{'userName':'username','password':'password'},'areas':[{'sourceArea':'Jan','targetArea':'Jan','slices':[]}],'mappings':[]}
FEDERATED
{'type':'FEDERATED','isNew':true,'sourceInfo':{'datasourceName':'federatedDatasourceExcel1','measuresDimensionName':'Measures','essbaseToColumnMap':{'arr':[{'essbaseName':'Caffeinated','columnName':''},{'essbaseName':'Ounces','columnName':''},{'essbaseName':'Pkg Type','columnName':''},{'essbaseName':'Population','columnName':''},{'essbaseName':'Intro Date','columnName':''}]}},'areas':[{'sourceArea':'Jan','targetArea':'Jan','slices':[]}]}
Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"executeInBackground", "in":"query", "description":"Create the partition in the background (applicable for federated partitions).
", "schema":{ "type":"boolean", "default":false } } ], "requestBody":{ "description":"Partition information.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PartitionBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/PartitionBean" } } }, "required":true }, "responses":{ "204":{ "description":"OK
Partition created successfully.
" }, "400":{ "description":"Bad Request
Failed to create partition.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-partitions-post", "x-filename-id":"applications-applicationname-databases-databasename-partitions-post" }, "delete":{ "tags":[ "Partitions" ], "summary":"Delete Partition", "description":"Deletes a partition based on the query parameters.
Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"type", "in":"query", "description":"Partition type.
", "required":true, "schema":{ "type":"string", "enum":[ "TRANSPARENT", "REPLICATED", "FEDERATED" ] } }, { "name":"serverName", "in":"query", "description":"Partition source server name.
", "schema":{ "type":"string" } }, { "name":"applicationName", "in":"query", "description":"Partition source application name.
", "schema":{ "type":"string" } }, { "name":"databaseName", "in":"query", "description":"Partition source database name.
", "schema":{ "type":"string" } }, { "name":"datasourceName", "in":"query", "description":"Datasource name.
", "schema":{ "type":"string" } }, { "name":"measuresDimensionName", "in":"query", "description":"Pivot dimension name. Can be Measures dimension but does not have to be.
", "schema":{ "type":"string" } }, { "name":"applicationLevelDatasource", "in":"query", "description":"Specify whether the Datasource is defined at the application level.
", "schema":{ "type":"boolean" } } ], "responses":{ "204":{ "description":"OK
Partition deleted successfully.
" }, "400":{ "description":"Bad Request
Failed to delete partition.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-partitions-delete", "x-filename-id":"applications-applicationname-databases-databasename-partitions-delete" }, "patch":{ "tags":[ "Partitions" ], "summary":"Update Partition", "description":"Updates an existing partition.
User authentication for both source and target cubes are required to create or update a transparent or replicated partition.
", "operationId":"Partition.updatePartition", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"executeInBackground", "in":"query", "description":"Update the partition in the background (applicable for federated partitions).
", "schema":{ "type":"boolean", "default":false } } ], "requestBody":{ "description":"Partition information.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PartitionBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/PartitionBean" } } }, "required":true }, "responses":{ "204":{ "description":"OK
Partition updated successfully.
" }, "400":{ "description":"Bad Request
Failed to update partition.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-partitions-patch", "x-filename-id":"applications-applicationname-databases-databasename-partitions-patch" } }, "/applications/{applicationName}/databases/{databaseName}/partitions/cellcount":{ "post":{ "tags":[ "Partitions" ], "summary":"Get Partition Cell Count", "description":"Gets source and target cell counts for the partition area definitions. A partition area must have the same number of cells in the source and target.
", "operationId":"Partition.getPartitionCellCount", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Partition information.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PartitionBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/PartitionBean" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Partition area cell count returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PartitionBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/PartitionBean" } } } }, "400":{ "description":"Bad Request
Failed to get partition area cell count.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-partitions-cellcount-post", "x-filename-id":"applications-applicationname-databases-databasename-partitions-cellcount-post" } }, "/applications/{applicationName}/databases/{databaseName}/partitions/supportedfederatedtypes":{ "get":{ "tags":[ "Partitions" ], "summary":"Get Supported Partition Types", "description":"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.
Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Returned supported partition types successfully.
" }, "400":{ "description":"Bad Request
Failed to get supported types.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-partitions-supportedfederatedtypes-get", "x-filename-id":"applications-applicationname-databases-databasename-partitions-supportedfederatedtypes-get" } }, "/applications/{applicationName}/databases/{databaseName}/partitions/lock":{ "post":{ "tags":[ "Partitions" ], "summary":"Lock Partition", "description":"Locks partition object. For non-federated partitions, both the source and target partition objects are locked.
For federated partitions, the partition type, Datasource name, measures dimension name, and optional application level Datasource are required.
For transparent or replicated partitions, the source server, source application, and source database are required.
", "operationId":"Partition.lockPartition", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"type", "in":"query", "description":"Partition type.
", "required":true, "schema":{ "type":"string", "enum":[ "TRANSPARENT", "REPLICATED", "FEDERATED" ] } }, { "name":"serverName", "in":"query", "description":"Partition source server name.
", "schema":{ "type":"string" } }, { "name":"applicationName", "in":"query", "description":"Partition source application name.
", "schema":{ "type":"string" } }, { "name":"databaseName", "in":"query", "description":"Partition source database name.
", "schema":{ "type":"string" } }, { "name":"datasourceName", "in":"query", "description":"Datasource name.
", "schema":{ "type":"string" } }, { "name":"measuresDimensionName", "in":"query", "description":"Pivot dimension name. Can be Measures dimension but does not have to be.
", "schema":{ "type":"string" } }, { "name":"applicationLevelDatasource", "in":"query", "description":"Specify whether the Datasource is defined at the application level.
", "schema":{ "type":"boolean" } } ], "responses":{ "204":{ "description":"OK
Partition locked successfully.
" }, "400":{ "description":"Bad Request
Failed to lock partition.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-partitions-lock-post", "x-filename-id":"applications-applicationname-databases-databasename-partitions-lock-post" } }, "/applications/{applicationName}/databases/{databaseName}/partitions/replicatedata":{ "post":{ "tags":[ "Partitions" ], "summary":"Replicate Data", "description":"Replicates data from source to target for a replicated partition.
", "operationId":"Partition.replicateDataFromSource", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"serverName", "in":"query", "description":"Partition source server name.
", "schema":{ "type":"string" } }, { "name":"applicationName", "in":"query", "description":"Partition source application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"query", "description":"Partition source database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"replicateOption", "in":"query", "description":"Replicate data options.
", "allowEmptyValue":true, "schema":{ "type":"string", "enum":[ "UPDATED_CELLS", "ALL_CELLS" ], "default":"UPDATED_CELLS" } } ], "responses":{ "204":{ "description":"OK
Partition data replicated successfully.
" }, "400":{ "description":"Bad Request
Failed to replicate partition data from the source. The partition type may be incorrect (must be a replicated partition).
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-partitions-replicatedata-post", "x-filename-id":"applications-applicationname-databases-databasename-partitions-replicatedata-post" } }, "/applications/{applicationName}/databases/{databaseName}/partitions/unlock":{ "post":{ "tags":[ "Partitions" ], "summary":"Unlock Partition", "description":"Unlocks the partition object. For non-federated partitions, both the source and target partition objects are unlocked.
For federated partitions, the Datasource name, measures dimension name, and optional application level Datasource are required.
For transparent and replicated partitions, the source server, source application, and source database are required.
", "operationId":"Partition.unlockPartition", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"type", "in":"query", "description":"Partition type.
", "required":true, "schema":{ "type":"string", "enum":[ "TRANSPARENT", "REPLICATED", "FEDERATED" ] } }, { "name":"serverName", "in":"query", "description":"Partition source server name.
", "schema":{ "type":"string" } }, { "name":"applicationName", "in":"query", "description":"Partition source application name.
", "schema":{ "type":"string" } }, { "name":"databaseName", "in":"query", "description":"Partition source database name.
", "schema":{ "type":"string" } }, { "name":"datasourceName", "in":"query", "description":"Datasource name.
", "schema":{ "type":"string" } }, { "name":"measuresDimensionName", "in":"query", "description":"Pivot dimension name. Can be Measures dimension but does not have to be.
", "schema":{ "type":"string" } }, { "name":"applicationLevelDatasource", "in":"query", "description":"Specify whether the Datasource is defined at the application level.
", "schema":{ "type":"boolean" } } ], "responses":{ "204":{ "description":"OK
Partition unlocked successfully.
" }, "400":{ "description":"Bad Request
Failed to unlock partition.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-partitions-unlock-post", "x-filename-id":"applications-applicationname-databases-databasename-partitions-unlock-post" } }, "/applications/{applicationName}/databases/{databaseName}/partitions/validate":{ "post":{ "tags":[ "Partitions" ], "summary":"Validate Partition", "description":"Validates a new or existing partition.
", "operationId":"Partition.validatePartition", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Partition information.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PartitionBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/PartitionBean" } } }, "required":true }, "responses":{ "204":{ "description":"OK
Partition validated successfully.
" }, "400":{ "description":"Bad Request
Failed to validate partition.
" }, "422":{ "description":"Unprocessable Entity
Partition validated with warnings.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-partitions-validate-post", "x-filename-id":"applications-applicationname-databases-databasename-partitions-validate-post" } }, "/preferences":{ "get":{ "tags":[ "Preferences" ], "summary":"Get User Preferences", "description":"Gets user preferences. This operation returns links to various preferences available in this release.
", "operationId":"Preferences.get", "responses":{ "default":{ "description":"default response", "content":{ "application/json":{ }, "application/xml":{ } } } }, "x-internal-id":"preferences-get", "x-filename-id":"preferences-get" } }, "/properties":{ "get":{ "tags":[ "Properties" ], "summary":"Get Server Properties", "description":"Returns the Provider Services configuration properties available at the Essbase Server level to help you manage network timeout parameters.
", "operationId":"Properties.getProperties", "responses":{ "200":{ "description":"OK
Properties returned successfully, with links to get or edit the properties.
", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/PropertyList" } } }, "application/xml":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/PropertyList" } } } } }, "400":{ "description":"Bad Request
Failed to get properties.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"properties-get", "x-filename-id":"properties-get" }, "put":{ "tags":[ "Properties" ], "summary":"Update Property Values", "description":"Updates Provider Services configuration property values in the Essbase Server and returns the list of updated properties.
", "operationId":"Properties.setProperties", "requestBody":{ "description":"List of property entries.
", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/PropertyEntry" } } }, "application/xml":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/PropertyEntry" } } } }, "required":true }, "responses":{ "200":{ "description":"OK
Properties updated successfully, returning details and links to get or edit the properties.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PropertyEntry" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/PropertyEntry" } } } }, "400":{ "description":"Bad Request
Failed to update properties. The property JSON may be incorrect, or the given property names may already be added to the server.
" }, "415":{ "description":"Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"properties-put", "x-filename-id":"properties-put" }, "post":{ "tags":[ "Properties" ], "summary":"Create Server Property", "description":"Adds a Provider Services configuration property at the Essbase Server level. These properties help you manage network timeout parameters.
", "operationId":"Properties.addProperty", "requestBody":{ "description":"Property entry.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PropertyEntry" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/PropertyEntry" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Property added successfully, with links to get or edit the property.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PropertyEntry" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/PropertyEntry" } } } }, "400":{ "description":"Bad Request
Failed to add property. The JSON may be incorrect, or the given property name may already be added to the server.
" }, "415":{ "description":"Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"properties-post", "x-filename-id":"properties-post" } }, "/properties/{propertyName}":{ "get":{ "tags":[ "Properties" ], "summary":"Get Server Property", "description":"Returns the named property from the server.
", "operationId":"Properties.getProperty", "parameters":[ { "name":"propertyName", "in":"path", "description":"Property name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Property name and value returned successfully, with links to get or edit the property.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PropertyEntry" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/PropertyEntry" } } } }, "400":{ "description":"Bad Request
Failed to get the property.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"properties-{propertyName}-get", "x-filename-id":"properties-propertyname-get" }, "put":{ "tags":[ "Properties" ], "summary":"Update Server Property", "description":"Updates a Provider Services property in the Essbase Server and returns the updated property.
", "operationId":"Properties.setProperty", "parameters":[ { "name":"propertyName", "in":"path", "description":"Property name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Property entry.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PropertyEntry" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/PropertyEntry" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Property updated successfully, with links to get or edit the property.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PropertyEntry" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/PropertyEntry" } } } }, "400":{ "description":"Bad Request
Failed to update the property. The JSON for the property may be incorrect, or the specified property name may not have been added to the server.
" }, "415":{ "description":"Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"properties-{propertyName}-put", "x-filename-id":"properties-propertyname-put" }, "delete":{ "tags":[ "Properties" ], "summary":"Delete Server Property", "description":"Deletes a Provider Services configuration property from the Essbase Server.
", "operationId":"Properties.deleteProperty", "parameters":[ { "name":"propertyName", "in":"path", "description":"Property name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OKSuccessful operation.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PropertyEntry" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/PropertyEntry" } } } }, "204":{ "description":"OKProperty is deleted successfully. Returns the property details and the links to get/edit the property.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PropertyEntry" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/PropertyEntry" } } } }, "400":{ "description":"Bad Request
Failed to delete the property. The JSON for the property may be incorrect, or the specified property may have already been deleted.
" }, "415":{ "description":"Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"properties-{propertyName}-delete", "x-filename-id":"properties-propertyname-delete" } }, "/groups/{groupId}/provisionReport/applications/{application}/filters":{ "get":{ "tags":[ "Group Provisioning Report" ], "summary":"Get Filters Provisioning Report", "description":"Gets a provisioning report about filters for the specified application. The logged in user must have at least Database Manager role for the application.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
", "operationId":"GroupProvisioningReport.getFilters", "parameters":[ { "name":"application", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"groupId", "in":"path", "description":"Group ID.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Provisioning report returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabaseProvisionReportItemList" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/DatabaseProvisionReportItemList" } } } }, "400":{ "description":"Bad Request
Failed to get provisioning report. The logged in user may not have the appropriate application role.
" }, "404":{ "description":"Not Found
The group with that ID does not exist.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"groups-{groupId}-provisionReport-applications-{application}-filters-get", "x-filename-id":"groups-groupid-provisionreport-applications-application-filters-get" } }, "/groups/{groupId}/provisionReport":{ "get":{ "tags":[ "Group Provisioning Report" ], "summary":"Get Full Provisioning Report", "description":"Gets a full provisioning report for the service and all applications. Service roles are included in the response only if the logged in user has Service Administrator role. The logged in user must have at least Database Manager role for applications to get application provisioning reports. Application roles are included in the report only if the logged in user has at least Application Manager role for the application.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
", "operationId":"GroupProvisioningReport.getFullReport", "parameters":[ { "name":"groupId", "in":"path", "description":"Group ID.
", "required":true, "schema":{ "type":"string" } }, { "name":"expand", "in":"query", "description":"Use all to get provisioning information for all applications.
OK
Provisioning report returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MainProvisionReport" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/MainProvisionReport" } } } }, "404":{ "description":"Not Found
The group with that ID does not exist.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"groups-{groupId}-provisionReport-get", "x-filename-id":"groups-groupid-provisionreport-get" } }, "/groups/{groupId}/provisionReport/applications":{ "get":{ "tags":[ "Group Provisioning Report" ], "summary":"Get All Applications Provisioning Report", "description":"Gets a provisioning report for all applications. The logged in user must have at least Database Manager role for the application. Application roles are included in the report only if the logged in user has at least Application Manager role for the application.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
", "operationId":"GroupProvisioningReport.getReportForAllApplications", "parameters":[ { "name":"groupId", "in":"path", "description":"Group ID.
", "required":true, "schema":{ "type":"string" } }, { "name":"expand", "in":"query", "description":"Use all to get provisioning information for all applications.
OK
Provisioning report for applications returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApplicationProvisionReportItemList" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApplicationProvisionReportItemList" } } } }, "404":{ "description":"Not Found
The group with that ID does not exist.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"groups-{groupId}-provisionReport-applications-get", "x-filename-id":"groups-groupid-provisionreport-applications-get" } }, "/groups/{groupId}/provisionReport/applications/{application}":{ "get":{ "tags":[ "Group Provisioning Report" ], "summary":"Get Application Provisioning Report", "description":"Gets provisioning report for the specified application. The logged in user must have at least Database Manager role for the application. Application roles are included in the report only if the logged in user has at least Application Manager role for the application.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
", "operationId":"GroupProvisioningReport.getReportForApplication", "parameters":[ { "name":"application", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"groupId", "in":"path", "description":"Group ID.
", "required":true, "schema":{ "type":"string" } }, { "name":"expand", "in":"query", "description":"Value can be all or none. Default value is none. When value is none, only links to roles, filters and scripts will be returned. When value is all, provisioning information for roles, filters, and scripts are returned.
OK
Provisioning report returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApplicationProvisionReportItem" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApplicationProvisionReportItem" } } } }, "400":{ "description":"Bad Request
The logged in user may not have the appropriate application role.
" }, "404":{ "description":"Not Found
The group with that ID does not exist.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"groups-{groupId}-provisionReport-applications-{application}-get", "x-filename-id":"groups-groupid-provisionreport-applications-application-get" } }, "/groups/{groupId}/provisionReport/applications/{application}/roles":{ "get":{ "tags":[ "Group Provisioning Report" ], "summary":"Get Application Roles Provisioning Report", "description":"Gets a roles provisioning report for the specified application.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
", "operationId":"GroupProvisioningReport.getRoles", "parameters":[ { "name":"application", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"groupId", "in":"path", "description":"Group ID.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Provisioning report returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ProvisionReportItemList" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ProvisionReportItemList" } } } }, "400":{ "description":"Bad Request
Failed to get provisioning report. The logged in user may not have the appropriate application role.
" }, "404":{ "description":"Not Found
The group with that ID does not exist.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"groups-{groupId}-provisionReport-applications-{application}-roles-get", "x-filename-id":"groups-groupid-provisionreport-applications-application-roles-get" } }, "/groups/{groupId}/provisionReport/applications/{application}/scripts":{ "get":{ "tags":[ "Group Provisioning Report" ], "summary":"Get Scripts Provisioning Report", "description":"Gets a provisioning report about scripts for the specified application. The logged in user must have at least Database Manager role for the application.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
", "operationId":"GroupProvisioningReport.getScripts", "parameters":[ { "name":"application", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"groupId", "in":"path", "description":"Group ID.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Provisioning report returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabaseProvisionReportItemList" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/DatabaseProvisionReportItemList" } } } }, "400":{ "description":"Bad Request
Failed to get provisioning report. The logged in user may not have the appropriate application role.
" }, "404":{ "description":"Not Found
The group with that ID does not exist.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"groups-{groupId}-provisionReport-applications-{application}-scripts-get", "x-filename-id":"groups-groupid-provisionreport-applications-application-scripts-get" } }, "/applications/{app}/permissions/{id}":{ "get":{ "tags":[ "Application Role Provisioning" ], "summary":"Get Application Role Provisioning", "description":"Retrieve provisioning information for the specified application.
If you are using EPM Shared Services security mode, this operation is not available. Instead use Shared Services Console to manage users, groups, and permissions.
", "operationId":"ApplicationRoleProvisioning.getProvision", "parameters":[ { "name":"app", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"id", "in":"path", "description":"User or group ID.
", "required":true, "schema":{ "type":"string" } }, { "name":"group", "in":"query", "description":"If true, ID is for a group. If false, ID is for a user. Default is false (ID is for a user.)
", "schema":{ "type":"boolean", "default":false } }, { "name":"inherited", "in":"query", "description":"If true, consider roles derived through parent groups. Default is false.
", "schema":{ "type":"boolean", "default":false } } ], "responses":{ "200":{ "description":"OK
Provisioning information returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UserGroupProvisionInfo" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/UserGroupProvisionInfo" } } } }, "400":{ "description":"Bad Request
The logged in user may not have the appropriate application role.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{app}-permissions-{id}-get", "x-filename-id":"applications-app-permissions-id-get" }, "put":{ "tags":[ "Application Role Provisioning" ], "summary":"Provision Application Role to User or Group", "description":"Provisions a single user or group on the specified application.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
", "operationId":"ApplicationRoleProvisioning.provision", "parameters":[ { "name":"app", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"id", "in":"path", "description":"User or group ID.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"User or group provisioning information.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UserGroupProvisionInfo" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/UserGroupProvisionInfo" } } } }, "responses":{ "204":{ "description":"OK
Provisioned successfully.
" }, "400":{ "description":"Bad Request
The logged in user may not have the appropriate application role.
" }, "409":{ "description":"Conflict
The user/group being provisioned is stale and it has been removed from identity store
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{app}-permissions-{id}-put", "x-filename-id":"applications-app-permissions-id-put" }, "delete":{ "tags":[ "Application Role Provisioning" ], "summary":"Deprovision User or Group from Application", "description":"Deprovisions a single user or group on the specified application.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
", "operationId":"ApplicationRoleProvisioning.deprovision", "parameters":[ { "name":"app", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"id", "in":"path", "description":"User or group ID.
", "required":true, "schema":{ "type":"string" } }, { "name":"group", "in":"query", "description":"If true, ID is for a group. If false, ID is for a user. Default is false (ID is for a user.)
", "schema":{ "type":"boolean", "default":false } } ], "responses":{ "200":{ "description":"OK
Deprovisioned successfully.
" }, "400":{ "description":"Bad Request
The logged in user may not have the appropriate application role.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{app}-permissions-{id}-delete", "x-filename-id":"applications-app-permissions-id-delete" } }, "/applications/{app}/permissions":{ "get":{ "tags":[ "Application Role Provisioning" ], "summary":"Search Application Role Provisioning", "description":"Search for provisioning information on the specified application.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
", "operationId":"ApplicationRoleProvisioning.searchProvision", "parameters":[ { "name":"app", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"id", "in":"query", "description":"User or group ID wildcard pattern. if specified, returns users and groups matching the pattern. If not specified, returns all users and groups having some role. Users or groups having no role are not returned.
", "schema":{ "type":"string", "default":"*" } }, { "name":"role", "in":"query", "description":"Input may include all, none, or a comma-separated list of roles (for example, app_manager, db_manager, db_update,or db_access). Default value is all, so if this query parameter is not specified, all users and groups having some roles are returned. If none is specified, only users and groups having no role will be returned. If named roles are specified, then only users and groups having any of the named roles are returned.
Input may include all, group, or user. Default value is all, so if this query parameter is not specified, all users and groups are returned.
If true, consider roles derived through parent groups. Default is false.
", "schema":{ "type":"boolean", "default":false } } ], "responses":{ "200":{ "description":"OK
Successfully returned provisioning information for users or groups matching search criteria. Response type can be either JSON, XML, or CSV stream, depending on the Accept header. If Accept='application/json' or Accept='application/xml', the search result will be returned in the response body. If Accept='application/octet-stream', the search result will be returned as a stream.
Bad Request
The logged in user may not have the appropriate application role.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{app}-permissions-get", "x-filename-id":"applications-app-permissions-get" }, "post":{ "tags":[ "Application Role Provisioning" ], "summary":"Import Application Role Provisioning", "description":"Imports provisioning for multiple users or groups on the specified application.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
Takes as input a comma-separated (CSV) import file indicated in --data-binary option. Output can be written to a file specified by --output option, or to standard output if the output option is not provided. Requirements for the import file:
Sample import.csv file:
| User1,app_manager,false |
| User2,db_manager,false |
| Group1,db_access,true |
Application name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Provisioning imported successfully.
" }, "400":{ "description":"Bad Request
The logged in user may not have the appropriate application role.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{app}-permissions-post", "x-filename-id":"applications-app-permissions-post" } }, "/permissions/{id}":{ "get":{ "tags":[ "Service Role Provisioning" ], "summary":"Get Service Role Provisioning", "description":"Retrieve Essbase service role provisioning information. Service roles include Service Administrator, Power User, and User.
If you are using EPM Shared Services security mode, this operation is not available. Instead use Shared Services Console to manage users, groups, and permissions.
See Also: Get Application Role Provision.
", "operationId":"ServiceRoleProvisioning.getProvision", "parameters":[ { "name":"id", "in":"path", "description":"User or group ID.
", "required":true, "schema":{ "type":"string" } }, { "name":"group", "in":"query", "description":"If true, ID is for a group. If false, ID is for a user. Default is false (ID is for a user.)
", "schema":{ "type":"boolean", "default":false } } ], "responses":{ "200":{ "description":"OK
Provisioning information returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UserGroupProvisionInfo" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/UserGroupProvisionInfo" } } } }, "400":{ "description":"Bad Request
The logged in user may not have the required service administrator role.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"permissions-{id}-get", "x-filename-id":"permissions-id-get" }, "put":{ "tags":[ "Service Role Provisioning" ], "summary":"Provision Service Role", "description":"Provisions a single user or group for an Essbase service role. Service roles include Service Administrator, Power User, and User.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
", "operationId":"ServiceRoleProvisioning.provision", "parameters":[ { "name":"id", "in":"path", "description":"User or group ID.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"User or group provisioning information.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UserGroupProvisionInfo" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/UserGroupProvisionInfo" } } } }, "responses":{ "204":{ "description":"OK
User or group provisioned successfully.
" }, "400":{ "description":"Bad Request
The logged in user may not have the required service administrator role.
" }, "409":{ "description":"Conflict
The user/group being provisioned is stale and it has been removed from identity store
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"permissions-{id}-put", "x-filename-id":"permissions-id-put" }, "delete":{ "tags":[ "Service Role Provisioning" ], "summary":"Deprovision Service Role", "description":"Deprovisions a single user from an Essbase service role. Service roles include Service Administrator, Power User, and User.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
To deprovision a group, you can use Delete Group
See Also: Deprovision User or Group from Application.
", "operationId":"ServiceRoleProvisioning.deprovision", "parameters":[ { "name":"id", "in":"path", "description":"User ID.
", "required":true, "schema":{ "type":"string" } }, { "name":"group", "in":"query", "description":"If true, ID is for a group. If false, ID is for a user. Default is false (ID is for a user.)
", "schema":{ "type":"boolean", "default":false } } ], "responses":{ "200":{ "description":"OK
User or group deprovisioned successfully.
" }, "400":{ "description":"Bad Request
The logged in user may not have the required service administrator role.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"permissions-{id}-delete", "x-filename-id":"permissions-id-delete" } }, "/permissions":{ "get":{ "tags":[ "Service Role Provisioning" ], "summary":"Search Service Role Provisioning", "description":"Search for Essbase service role provisioning information. Service roles include Service Administrator, Power User, and User.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
See Also: Search Application Role Provisioning.
", "operationId":"ServiceRoleProvisioning.searchProvision", "parameters":[ { "name":"id", "in":"query", "description":"User or group ID wildcard pattern. if specified, returns users and groups matching the pattern, if not specified, returns all the users and groups having some role. Users or groups having no role are not returned.
", "schema":{ "type":"string", "default":"*" } }, { "name":"role", "in":"query", "description":"Input may include all, none, or a comma-separated list of roles (for example, service_administrator, power_user, or user). Default value is all, so if this query parameter is not specified, all users and groups having some roles are returned. If none is specified, only users and groups having no role will be returned. If named roles are specified, then only users and groups having any of the named roles are returned.
Search filter. Values available: all/group/user. Default value is all, so if this query parameter is not specified, then all users and groups having some role will be returned.
This is used to get the list of users/groups having no service roles in paginated manner. Page number starts with 0
", "schema":{ "type":"integer", "format":"int32", "default":-1 } } ], "responses":{ "200":{ "description":"OK
User and group provisioning results returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UserGroupProvisionInfoList" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/UserGroupProvisionInfoList" } } } }, "400":{ "description":"Bad Request
The logged in user may not have the required service administrator role.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"permissions-get", "x-filename-id":"permissions-get" } }, "/users/{userId}/provisionReport/applications/{application}/filters":{ "get":{ "tags":[ "User Provisioning Report" ], "summary":"Get User's Filters Provisioning Report", "description":"Get filters provisioning report for a specific user and application. The logged in user must have at least Database Manager role for the application.
If you are using EPM Shared Services security mode, this operation is not available. Instead use Shared Services Console to manage users, groups, and permissions.
", "operationId":"UserProvisioningReport.getFilters", "parameters":[ { "name":"application", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"userId", "in":"path", "description":"User ID.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Provisioning report returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabaseProvisionReportItemList" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/DatabaseProvisionReportItemList" } } } }, "400":{ "description":"Bad Request
The logged in user may not have the appropriate application role.
" }, "404":{ "description":"Not Found
User not found.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"users-{userId}-provisionReport-applications-{application}-filters-get", "x-filename-id":"users-userid-provisionreport-applications-application-filters-get" } }, "/users/{userId}/provisionReport":{ "get":{ "tags":[ "User Provisioning Report" ], "summary":"Get User's Full Provisioning Report", "description":"Get full provisioning report for a specific user. Service roles are included in the response only if the logged in user has Service Administrator role. The logged in user must have at least Database Manager role for an application to get its provisioning report. Application roles are included in the report only if the logged in user has at least Application Manager role for the application.
If you are using EPM Shared Services security mode, this operation is not available. Instead use Shared Services Console to manage users, groups, and permissions.
", "operationId":"UserProvisioningReport.getFullReport", "parameters":[ { "name":"userId", "in":"path", "description":"User ID.
", "required":true, "schema":{ "type":"string" } }, { "name":"expand", "in":"query", "description":"Value can be all or none. Default value is none, meaning only links to applications are returned. If all is specified, provisioning information for all applications is returned.
OK
Full provisioning report including service and all the applications.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MainProvisionReport" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/MainProvisionReport" } } } }, "404":{ "description":"Not Found
User not found.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"users-{userId}-provisionReport-get", "x-filename-id":"users-userid-provisionreport-get" } }, "/users/{userId}/provisionReport/applications":{ "get":{ "tags":[ "User Provisioning Report" ], "summary":"Get User's Applications Provisioning Report", "description":"Get provisioning report for a specific user across all applications. The logged in user must have at least Database Manager role for the application. Application roles are included in the report only if the logged in user has at least Application Manager role for the application.
If you are using EPM Shared Services security mode, this operation is not available. Instead use Shared Services Console to manage users, groups, and permissions.
", "operationId":"UserProvisioningReport.getReportForAllApplications", "parameters":[ { "name":"userId", "in":"path", "description":"User ID.
", "required":true, "schema":{ "type":"string" } }, { "name":"expand", "in":"query", "description":"Value can be all or none. Default value is none, meaning only links to applications are returned. If all is specified, provisioning information for all applications is returned.
OK
Provisioning report returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApplicationProvisionReportItemList" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApplicationProvisionReportItemList" } } } }, "404":{ "description":"Not Found
User not found.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"users-{userId}-provisionReport-applications-get", "x-filename-id":"users-userid-provisionreport-applications-get" } }, "/users/{userId}/provisionReport/applications/{application}":{ "get":{ "tags":[ "User Provisioning Report" ], "summary":"Get Users Application Provisioning Report", "description":"Gets a provisioning report for a specific user and application. The logged in user must have at least Database Manager role for the application. Application roles are included in the report only if the logged in user has at least Application Manager role for the application.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
", "operationId":"UserProvisioningReport.getReportForApplication", "parameters":[ { "name":"application", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"userId", "in":"path", "description":"User ID.
", "required":true, "schema":{ "type":"string" } }, { "name":"expand", "in":"query", "description":"Value can be all or none. Default value is none, meaning only links to roles, filters, and scripts are returned. If all is specified, provisioning information for all roles, filters, and scripts in the application is returned.
OK
Provisioning report returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApplicationProvisionReportItem" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApplicationProvisionReportItem" } } } }, "400":{ "description":"Bad Request
The logged in user may not have the appropriate application role.
" }, "404":{ "description":"Not Found
User not found.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"users-{userId}-provisionReport-applications-{application}-get", "x-filename-id":"users-userid-provisionreport-applications-application-get" } }, "/users/{userId}/provisionReport/applications/{application}/roles":{ "get":{ "tags":[ "User Provisioning Report" ], "summary":"Get Users Application Roles Provisioning Report", "description":"Gets a roles provisioning report for a specific user and application. The logged in user must have at least Application Manager role for the application.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
", "operationId":"UserProvisioningReport.getRoles", "parameters":[ { "name":"application", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"userId", "in":"path", "description":"User ID.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Provisioning report returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ProvisionReportItemList" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ProvisionReportItemList" } } } }, "400":{ "description":"Bad Request
The logged in user may not have the appropriate application role.
" }, "404":{ "description":"Not Found
User not found.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"users-{userId}-provisionReport-applications-{application}-roles-get", "x-filename-id":"users-userid-provisionreport-applications-application-roles-get" } }, "/users/{userId}/provisionReport/applications/{application}/scripts":{ "get":{ "tags":[ "User Provisioning Report" ], "summary":"Get User???s Scripts Provisioning Report", "description":"Gets scripts provisioning report for a specific user and application. The logged in user must have at least Database Manager role for the application to get a provisioning report.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
", "operationId":"UserProvisioningReport.getScripts", "parameters":[ { "name":"application", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"userId", "in":"path", "description":"User ID.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Provisioning report returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabaseProvisionReportItemList" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/DatabaseProvisionReportItemList" } } } }, "400":{ "description":"Bad Request
The logged in user may not have the application service role.
" }, "404":{ "description":"Not Found
User not found.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"users-{userId}-provisionReport-applications-{application}-scripts-get", "x-filename-id":"users-userid-provisionreport-applications-application-scripts-get" } }, "/rocluster":{ "get":{ "tags":[ "ROCluster" ], "summary":"Get Read-only Cluster List", "description":"Returns list of read-only cluster from Essbase domain db.", "operationId":"ROCluster.getClusterList", "responses":{ "200":{ "description":"OK
RO-Cluster list retrieved successfully.
", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/ROCluster" } } }, "application/xml":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/ROCluster" } } } } }, "400":{ "description":"Bad Request
Failed to retrieve the ReadOnly cluster list.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"rocluster-get", "x-filename-id":"rocluster-get" }, "put":{ "tags":[ "ROCluster" ], "summary":"Update ReadOnly Cluster", "description":"Removes the existing ReadOnly cluster and create new ReadOnly cluster with latest nodes details.", "operationId":"ROCluster.updateROCluster", "requestBody":{ "description":"ROCluster", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/ROCluster" } } }, "required":true }, "responses":{ "200":{ "description":"
OK
Successfully created the ReadOnly cluster.
" }, "400":{ "description":"Bad Request
Failed the delete/create ReadOnly cluster.JSON may be incorrect or name or node info is missing
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"rocluster-put", "x-filename-id":"rocluster-put" }, "post":{ "tags":[ "ROCluster" ], "summary":"Create ReadOnly Cluster", "description":"Adds new ReadOnly cluster with all selected nodes and description to the domain db of Essbase server.", "operationId":"ROCluster.createROCluster", "requestBody":{ "description":"RoCluster", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/ROCluster" } } }, "required":true }, "responses":{ "200":{ "description":"
OK
Successfully created the ReadOnly cluster.
" }, "400":{ "description":"Bad Request
Failed the create ReadOnly cluster.JSON may be incorrect or name or node info is missing
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"rocluster-post", "x-filename-id":"rocluster-post" }, "delete":{ "tags":[ "ROCluster" ], "summary":"Delete ReadOnly Cluster", "description":"Deletes the existing ReadOnly cluster and all nodes under it from the domain db of Essbase server. Provide the URL encoded String value as input(clusterName)", "operationId":"ROCluster.deleteROCluster", "parameters":[ { "name":"clusterName", "in":"query", "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"
OK
Successfully removed the ReadOnly cluster from the domain DB of the Essbase server.
" }, "400":{ "description":"Bad Request
Failed to delete the ReadOnly cluster.Name specified may be incorrect or not exist.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"rocluster-delete", "x-filename-id":"rocluster-delete" } }, "/rocluster/{svrName}/appcubelist":{ "get":{ "tags":[ "ROCluster" ], "summary":"Get App Cube List", "description":"Returns the list of applications and databases under it of selected Essbase Server", "operationId":"ROCluster.getAppAndCubeListByServerName", "parameters":[ { "name":"svrName", "in":"path", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Successfully retrieved the apps and cubes list.
", "content":{ "application/json":{ "schema":{ "type":"string" } }, "application/xml":{ "schema":{ "type":"string" } } } }, "400":{ "description":"Bad Request
Failed to retrieve the apps and cubes list. Incorrect server name.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"rocluster-{svrName}-appcubelist-get", "x-filename-id":"rocluster-svrname-appcubelist-get" } }, "/rocluster/findByName":{ "get":{ "tags":[ "ROCluster" ], "summary":"Find ReadOnly Cluster by Name", "description":"Returns the named ReadOnly cluster from Essbase domain db. Provide the URL encoded String value as input(clusterName)", "operationId":"ROCluster.getROCluster", "parameters":[ { "name":"clusterName", "in":"query", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"
OK
ReadOnly cluster retrieved successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ROCluster" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ROCluster" } } } }, "400":{ "description":"Bad Request
Failed to retrieve the ReadOnly cluster. Incorrect or missing cluster name.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"rocluster-findByName-get", "x-filename-id":"rocluster-findbyname-get" } }, "/rocluster/changestatus":{ "post":{ "tags":[ "ROCluster" ], "summary":"Change Read-only Cluster Status", "description":"Change Status allows to modify the state 1(enable)/2(disable) of read-only cluster nodes.
", "operationId":"ROCluster.enableCluster", "requestBody":{ "description":"RoCluster", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/ROCluster" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Successfully changed the states of ReadOnly cluster nodes. Returns updated ReadOnly cluster.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ROCluster" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ROCluster" } } } }, "400":{ "description":"Bad Request
Failed to Change the status of ReadOnly Cluster nodes. The JSON may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"rocluster-changestatus-post", "x-filename-id":"rocluster-changestatus-post" } }, "/utils/rules":{ "get":{ "tags":[ "Rules" ], "summary":"Get Rules", "description":"Gets rule file from file catalog path.
", "operationId":"Rules.get", "parameters":[ { "name":"path", "in":"query", "description":"Catalog path.
", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Successfully returned rule file. Response type can be either JSON, XML, or JSON stream, depending on the Accept header. If Accept='application/json' or Accept='application/xml', the rules are returned in the response body. If Accept='application/octet-stream', the rules are returned as a JSON stream.
Bad Request
Failed to import rule file. The catalog path information may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"utils-rules-get", "x-filename-id":"utils-rules-get" }, "post":{ "tags":[ "Rules" ], "summary":"Create Rules", "description":"Creates a rule file.
", "operationId":"Rules.save", "parameters":[ { "name":"path", "in":"query", "description":"Optional file catalog path.
", "schema":{ "type":"string" } }, { "name":"overwrite", "in":"query", "description":"Optional overwrite specification. Default value is false, meaning if the rules file already exists, an error is returned. When set to true, if the rule file already exists, it will be overwritten.
", "schema":{ "type":"boolean", "default":false } } ], "requestBody":{ "description":"Rule file details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Rules" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Rules" } } } }, "responses":{ "200":{ "description":"OK
Rules file created successfully.
" }, "400":{ "description":"Bad Request
Failed to create rules file. The catalog path information may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"utils-rules-post", "x-filename-id":"utils-rules-post" } }, "/utils/rules/preview":{ "post":{ "tags":[ "Rules" ], "summary":"Preview Rules Data", "description":"Applies a rule file to a two-dimensional array of data and returns a previewed data load as two-dimensional array.
", "operationId":"Rules.getPreviewData", "requestBody":{ "description":"Rule file details and input two-dimensional array.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RulePreviewInput" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/RulePreviewInput" } } } }, "responses":{ "200":{ "description":"OK
Data through rule file was previewed successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RulePreviewOutput" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/RulePreviewOutput" } } } }, "400":{ "description":"Bad Request
Failed to preview this data through this rule file.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"utils-rules-preview-post", "x-filename-id":"utils-rules-preview-post" } }, "/utils/rules/actions/import":{ "post":{ "tags":[ "Rules" ], "summary":"Import Rules", "description":"Imports a rules file.
", "operationId":"Rules.importRule", "parameters":[ { "name":"overwrite", "in":"query", "description":"Optional overwrite specification. Default value is false, meaning if the rules file already exists, an error is returned. When set to true, if the rule file already exists, it will be overwritten.
", "schema":{ "type":"boolean", "default":false } } ], "requestBody":{ "description":"File path information: source and destination catalog paths.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/FilePathDetail" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/FilePathDetail" } } } }, "responses":{ "200":{ "description":"OK
Rules file imported successfully.
" }, "400":{ "description":"Bad Request
Failed to import rules file. The file path information may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"utils-rules-actions-import-post", "x-filename-id":"utils-rules-actions-import-post" } }, "/utils/rules/verify":{ "post":{ "tags":[ "Rules" ], "summary":"Verify Rule Deprecated", "description":"Verifies a data load or dimension build rule file (index or regular). As this API endpoint is older and has limited functionality, it is recommended to use Verify Rule endpoint instead if possible.
", "operationId":"Rules.verify", "requestBody":{ "description":"Rule file details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Rules" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Rules" } } } }, "responses":{ "200":{ "description":"OK
Rule file verified successfully.
" }, "400":{ "description":"Bad Request
Rules verification failed. Response contains a list of verification errors.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/StringCollectionResponse" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/StringCollectionResponse" } } } }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"utils-rules-verify-post", "x-filename-id":"utils-rules-verify-post" } }, "/utils/rules/verifyRule":{ "post":{ "tags":[ "Rules" ], "summary":"Verify Rule", "description":"Verifies a rule file, either regular or index-based.
", "operationId":"Rules.verifyRule", "parameters":[ { "name":"application", "in":"query", "description":"Application name.
", "schema":{ "type":"string" } }, { "name":"database", "in":"query", "description":"Database name.
", "schema":{ "type":"string" } } ], "requestBody":{ "description":"Rule file details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Rules" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Rules" } } } }, "responses":{ "200":{ "description":"OK
Rule file verified successfully.
" }, "400":{ "description":"Bad Request
Rule verification failed. Response contains a list of verification errors.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RuleErrorList" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/RuleErrorList" } } } }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"utils-rules-verifyRule-post", "x-filename-id":"utils-rules-verifyrule-post" } }, "/applications/{applicationName}/databases/{databaseName}/sandbox/members":{ "post":{ "tags":[ "Sandbox Dimension" ], "summary":"Add Sandbox Members", "description":"Adds members to an existing sandbox dimension.
", "operationId":"SandboxDimension.addMembers", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Size of sandbox dimension members. Default is 100 if body is empty.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SandboxRequestPayload" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/SandboxRequestPayload" } } } }, "responses":{ "200":{ "description":"OK
Sandbox members added successfully; includes links to sandbox details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SandboxDetail" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/SandboxDetail" } } } }, "400":{ "description":"Bad Request
Failed to add sandbox members. The application or database name may be incorrect, or scenarios may not be enabled.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-sandbox-members-post", "x-filename-id":"applications-applicationname-databases-databasename-sandbox-members-post" } }, "/applications/{applicationName}/databases/{databaseName}/sandbox":{ "get":{ "tags":[ "Sandbox Dimension" ], "summary":"Get Sandbox Details", "description":"Returns details about sandbox members.
", "operationId":"SandboxDimension.get", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Sandbox details returned successfully; includes total sandbox members, available members, and assigned member.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SandboxDetail" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/SandboxDetail" } } } }, "400":{ "description":"Bad Request
Failed to get sandbox details. The application or database name may be incorrect, or the logged in user may not have the appropriate application role.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-sandbox-get", "x-filename-id":"applications-applicationname-databases-databasename-sandbox-get" }, "post":{ "tags":[ "Sandbox Dimension" ], "summary":"Create Sandbox", "description":"Creates Sandbox and CellProperties dimensions, while at the same time enabling scenario management for this cube.
", "operationId":"SandboxDimension.create", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Maximum count of sandbox dimension members. Default is 100 if body is empty.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SandboxRequestPayload" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/SandboxRequestPayload" } } } }, "responses":{ "200":{ "description":"OK
Sandbox created successfully; includes links to sandbox details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SandboxDetail" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/SandboxDetail" } } } }, "400":{ "description":"Bad Request
Failed create sandbox. The application or database name may be incorrect, or the logged in user may not have the appropriate application role.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-sandbox-post", "x-filename-id":"applications-applicationname-databases-databasename-sandbox-post" }, "delete":{ "tags":[ "Sandbox Dimension" ], "summary":"Delete Sandbox", "description":"Deletes Sandbox and CellProperties dimensions from this cube. This action disables scenario management for the cube.
", "operationId":"SandboxDimension.delete", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Sandbox deleted successfully.
" }, "400":{ "description":"Bad Request
Failed to delete sandbox. The application or database name may be incorrect, or the logged in user may not have the appropriate application role.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-sandbox-delete", "x-filename-id":"applications-applicationname-databases-databasename-sandbox-delete" } }, "/scenarios/{scenarioId}/approvers":{ "get":{ "tags":[ "Scenarios" ], "summary":"Get Approvers", "description":"Gets scenario approvers.
", "operationId":"Scenarios.getApprovers", "parameters":[ { "name":"scenarioId", "in":"path", "description":"Scenario ID.
", "required":true, "schema":{ "type":"integer", "format":"int64" } } ], "responses":{ "200":{ "description":"OK
List of scenario approvers returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApproverListResponse" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApproverListResponse" } } } }, "400":{ "description":"Bad Request
Failed to get scenario approvers. The scenario ID may be invalid.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"scenarios-{scenarioId}-approvers-get", "x-filename-id":"scenarios-scenarioid-approvers-get" }, "post":{ "tags":[ "Scenarios" ], "summary":"Add Approver", "description":"Adds a scenario approver. Approvers are optional and must have Database Access or higher role. They monitor and approve or reject scenarios. If a scenario has multiple approvers, each one must approve before it can be submitted.
", "operationId":"Scenarios.addApprover", "parameters":[ { "name":"scenarioId", "in":"path", "description":"Scenario ID.
", "required":true, "schema":{ "type":"integer", "format":"int64" } } ], "requestBody":{ "description":"Approver details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApproverBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApproverBean" } } } }, "responses":{ "200":{ "description":"OK
Scenario approver added successfully.
" }, "400":{ "description":"Bad Request
Failed to add approver. The scenario ID may be invalid, or the scenario may already have been submitted for approval.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"scenarios-{scenarioId}-approvers-post", "x-filename-id":"scenarios-scenarioid-approvers-post" } }, "/scenarios/{scenarioId}/comments":{ "get":{ "tags":[ "Scenarios" ], "summary":"Get Comments", "description":"Gets comments for the specified scenario ID.
", "operationId":"Scenarios.getComments", "parameters":[ { "name":"scenarioId", "in":"path", "description":"Scenario ID.
", "required":true, "schema":{ "type":"integer", "format":"int64" } } ], "responses":{ "200":{ "description":"OK
Scenario comments returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CommentListResponse" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/CommentListResponse" } } } }, "400":{ "description":"Bad Request
Failed to get scenario comments. The scenario ID may be invalid.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"scenarios-{scenarioId}-comments-get", "x-filename-id":"scenarios-scenarioid-comments-get" }, "post":{ "tags":[ "Scenarios" ], "summary":"Add Comment", "description":"Adds a comment to the specified scenario ID.
", "operationId":"Scenarios.addComment", "parameters":[ { "name":"scenarioId", "in":"path", "description":"Scenario ID.
", "required":true, "schema":{ "type":"integer", "format":"int64" } } ], "requestBody":{ "description":"Comment details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CommentBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/CommentBean" } } } }, "responses":{ "200":{ "description":"OK
Scenario comment added successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CommentBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/CommentBean" } } } }, "400":{ "description":"Bad Request
Failed to add a comment. The scenario ID may be invalid.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"scenarios-{scenarioId}-comments-post", "x-filename-id":"scenarios-scenarioid-comments-post" } }, "/scenarios/{scenarioId}/participants":{ "get":{ "tags":[ "Scenarios" ], "summary":"Get Participants", "description":"Gets scenario participants by scenario ID.
", "operationId":"Scenarios.getParticipants", "parameters":[ { "name":"scenarioId", "in":"path", "description":"Scenario ID.
", "required":true, "schema":{ "type":"integer", "format":"int64" } } ], "responses":{ "200":{ "description":"OK
Scenario participants returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ParticipantListResponse" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ParticipantListResponse" } } } }, "400":{ "description":"Bad Request
Failed to get scenario participants. The scenario ID may be invalid.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"scenarios-{scenarioId}-participants-get", "x-filename-id":"scenarios-scenarioid-participants-get" }, "post":{ "tags":[ "Scenarios" ], "summary":"Add Participant", "description":"Adds a scenario participant to the specified scenario ID.
", "operationId":"Scenarios.addParticipant", "parameters":[ { "name":"scenarioId", "in":"path", "description":"Scenario ID.
", "required":true, "schema":{ "type":"integer", "format":"int64" } } ], "requestBody":{ "description":"Participant details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ParticipantBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ParticipantBean" } } } }, "responses":{ "200":{ "description":"OK
Scenario participant added successfully.
" }, "400":{ "description":"Bad Request
Failed to add participant. The scenario ID may be invalid, or the scenario may already have been submitted for approval.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"scenarios-{scenarioId}-participants-post", "x-filename-id":"scenarios-scenarioid-participants-post" } }, "/scenarios":{ "get":{ "tags":[ "Scenarios" ], "summary":"Get Scenarios", "description":"Get scenarios matching search criteria. Response includes links to all basic scenario attributes, excluding approvers, participants, comments, and scripts.
", "operationId":"Scenarios.getScenarios", "parameters":[ { "name":"filter", "in":"query", "description":"Scenario name wildcard pattern.
", "schema":{ "type":"string" } }, { "name":"role", "in":"query", "description":"Optional user role by which to filter the scenario list. Value can be owner, participant, or approver. If role is specified as approver, this API returns all scenarios for which the logged in user is the approver. By default, all scenarios are returned for which the logged in user is either an owner, a participant, or an approver.
If true, returns all scenarios past the due date. Default is false, meaning all scenarios are returned.
", "schema":{ "type":"boolean" } }, { "name":"state", "in":"query", "description":"Scenario state.
", "schema":{ "type":"string" } }, { "name":"application", "in":"query", "description":"Application name.
", "schema":{ "type":"string" } }, { "name":"database", "in":"query", "description":"Database name.
", "schema":{ "type":"string" } }, { "name":"approvalPending", "in":"query", "description":"Scenario is in submitted state, and approval is pending from logged in user.
", "schema":{ "type":"boolean", "default":false } }, { "name":"offset", "in":"query", "description":"Number of scenarios to omit from the start of the result set. Default is 0.
", "schema":{ "type":"integer", "format":"int64", "default":0 } }, { "name":"limit", "in":"query", "description":"Maximum number of scenarios to return. Default is 50.
", "schema":{ "type":"integer", "format":"int64", "default":50 } }, { "name":"orderBy", "in":"query", "description":"Order-by field and order for the result set. The value of this parameter must follow the format of fieldName:asc|desc. For example, name:asc. Default value is createdTime:desc, meaning that scenarios are listed with the most recently created scenarios first.
If true, response contains only the count of scenarios, and not actual scenarios.
OK
Scenario list and details returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ScenarioCollectionResponse" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ScenarioCollectionResponse" } } } }, "400":{ "description":"Bad Request
Failed to get scenarios.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"scenarios-get", "x-filename-id":"scenarios-get" }, "post":{ "tags":[ "Scenarios" ], "summary":"Create Scenario", "description":"Creates a new scenario. A scenario is a private work area in which you can model different assumptions within the data without affecting the existing data.
", "operationId":"Scenarios.create", "requestBody":{ "description":"Scenario details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ScenarioBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ScenarioBean" } } } }, "responses":{ "200":{ "description":"OK
Scenario created successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ScenarioBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ScenarioBean" } } } }, "400":{ "description":"Bad Request
Failed to create the scenario. Required fields such as scenario name or due date may be empty.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"scenarios-post", "x-filename-id":"scenarios-post" } }, "/scenarios/{id}":{ "get":{ "tags":[ "Scenarios" ], "summary":"Get Scenario", "description":"Gets a scenario by ID.
", "operationId":"Scenarios.get", "parameters":[ { "name":"id", "in":"path", "description":"Scenario ID.
", "required":true, "schema":{ "type":"integer", "format":"int64" } }, { "name":"expand", "in":"query", "description":"Value can be all or none. Default value is none, meaning only links are returned. If all is specified, then approvers, participants and scripts are included in the response.
OK
Scenario details returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ScenarioBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ScenarioBean" } } } }, "400":{ "description":"Bad Request
Failed to get scenario details. The scenario ID may be invalid.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"scenarios-{id}-get", "x-filename-id":"scenarios-id-get" }, "put":{ "tags":[ "Scenarios" ], "summary":"Update Scenario Fully", "description":"Updates full details about a scenario.
", "operationId":"Scenarios.update", "parameters":[ { "name":"id", "in":"path", "description":"Scenario ID.
", "required":true, "schema":{ "type":"integer", "format":"int64" } } ], "requestBody":{ "description":"Scenario details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ScenarioBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ScenarioBean" } } } }, "responses":{ "200":{ "description":"OK
Scenario updated successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ScenarioBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ScenarioBean" } } } }, "400":{ "description":"Bad Request
Failed to update the scenario. Required fields such as scenario name or due date may be empty, or the scenario may already have been submitted for approval.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"scenarios-{id}-put", "x-filename-id":"scenarios-id-put" }, "post":{ "tags":[ "Scenarios" ], "summary":"Perform Scenario Action", "description":"Performs the specified scenario workflow action. Common actions are submit to submit a scenario for approval, approve to approve a scenario, reject to reject it, and apply to overwrite the base data with the scenario data. Additional actions include copy, refresh, and clear.
Scenario ID.
", "required":true, "schema":{ "type":"integer", "format":"int64" } }, { "name":"action", "in":"query", "description":"Valid values are submit, approve, reject, apply, copy, refresh, and clear.
Optional overwrite parameter, applicable only when action is refresh. If true, when the base and scenario data have different values, the base value overwrites the scenario changes. Default is false.
Action parameters. Copy options are applicable only in case of copy. Comment is applicable only for workflow actions.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ScenarioActionPayload" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ScenarioActionPayload" } } } }, "responses":{ "200":{ "description":"OK
Scenario action performed successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ScenarioBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ScenarioBean" } } } }, "400":{ "description":"Bad Request
Failed to perform scenario action. The scenario ID may be invalid.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"scenarios-{id}-post", "x-filename-id":"scenarios-id-post" }, "delete":{ "tags":[ "Scenarios" ], "summary":"Delete Scenario", "description":"Deletes a scenario by ID.
", "operationId":"Scenarios.delete", "parameters":[ { "name":"id", "in":"path", "description":"Scenario ID.
", "required":true, "schema":{ "type":"integer", "format":"int64" } } ], "responses":{ "204":{ "description":"No Content
Scenario deleted successfully.
" }, "400":{ "description":"Bad Request
Failed to delete scenario. The scenario ID may be invalid.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"scenarios-{id}-delete", "x-filename-id":"scenarios-id-delete" }, "patch":{ "tags":[ "Scenarios" ], "summary":"Update Scenario Partially", "description":"Updates basic information about a scenario, including description, due date, priority, and owner.
", "operationId":"Scenarios.patch", "parameters":[ { "name":"id", "in":"path", "description":"Scenario ID.
", "required":true, "schema":{ "type":"integer", "format":"int64" } } ], "requestBody":{ "description":"Scenario details. Set only those fields which need to be updated.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ScenarioEditBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ScenarioEditBean" } } } }, "responses":{ "200":{ "description":"OK
Scenario updated successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ScenarioBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ScenarioBean" } } } }, "400":{ "description":"Bad Request
Failed to update the scenario. Required fields such as scenario name or due date may be empty.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"scenarios-{id}-patch", "x-filename-id":"scenarios-id-patch" } }, "/scenarios/{scenarioId}/approvers/{userId}":{ "delete":{ "tags":[ "Scenarios" ], "summary":"Delete Approver", "description":"Deletes a scenario approver.
", "operationId":"Scenarios.deleteApprover", "parameters":[ { "name":"scenarioId", "in":"path", "description":"Scenario ID.
", "required":true, "schema":{ "type":"integer", "format":"int64" } }, { "name":"userId", "in":"path", "description":"Approver ID.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"No Content
Scenario approver deleted successfully.
" }, "400":{ "description":"Bad Request
Failed to delete scenario approver. The scenario ID may be invalid, or the scenario may already have been submitted for approval.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"scenarios-{scenarioId}-approvers-{userId}-delete", "x-filename-id":"scenarios-scenarioid-approvers-userid-delete" } }, "/scenarios/{scenarioId}/comments/{commentId}":{ "get":{ "tags":[ "Scenarios" ], "summary":"Get Comment", "description":"Gets a scenario comment by ID.
", "operationId":"Scenarios.getComment", "parameters":[ { "name":"scenarioId", "in":"path", "description":"Scenario ID.
", "required":true, "schema":{ "type":"integer", "format":"int64" } }, { "name":"commentId", "in":"path", "description":"Comment ID.
", "required":true, "schema":{ "type":"integer", "format":"int64" } } ], "responses":{ "200":{ "description":"OK
Scenario comment returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CommentBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/CommentBean" } } } }, "400":{ "description":"Bad Request
Failed to get scenario comment. The scenario ID or comment ID may be invalid.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"scenarios-{scenarioId}-comments-{commentId}-get", "x-filename-id":"scenarios-scenarioid-comments-commentid-get" }, "put":{ "tags":[ "Scenarios" ], "summary":"Update Comment", "description":"Updates a scenario comment by ID.
", "operationId":"Scenarios.updateComment", "parameters":[ { "name":"scenarioId", "in":"path", "description":"Scenario ID.
", "required":true, "schema":{ "type":"integer", "format":"int64" } }, { "name":"commentId", "in":"path", "description":"Comment ID.
", "required":true, "schema":{ "type":"integer", "format":"int64" } } ], "requestBody":{ "description":"Comment details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CommentBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/CommentBean" } } } }, "responses":{ "204":{ "description":"Scenario comment successfully updated.
" }, "400":{ "description":"Bad Request
Failed to update scenario comment. The scenario ID or comment ID may be invalid.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"scenarios-{scenarioId}-comments-{commentId}-put", "x-filename-id":"scenarios-scenarioid-comments-commentid-put" }, "delete":{ "tags":[ "Scenarios" ], "summary":"Delete Comment", "description":"Deletes a scenario comment by ID.
", "operationId":"Scenarios.deleteComment", "parameters":[ { "name":"scenarioId", "in":"path", "description":"Scenario ID.
", "required":true, "schema":{ "type":"integer", "format":"int64" } }, { "name":"commentId", "in":"path", "description":"Comment ID.
", "required":true, "schema":{ "type":"integer", "format":"int64" } } ], "responses":{ "204":{ "description":"No Content
Scenario comment deleted successfully.
" }, "400":{ "description":"Bad Request
Failed to delete scenario comment. The scenario ID or comment ID may be invalid.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"scenarios-{scenarioId}-comments-{commentId}-delete", "x-filename-id":"scenarios-scenarioid-comments-commentid-delete" } }, "/scenarios/{scenarioId}/participants/{userId}":{ "delete":{ "tags":[ "Scenarios" ], "summary":"Delete Participant", "description":"Deletes a scenario participant.
", "operationId":"Scenarios.deleteParticipant", "parameters":[ { "name":"scenarioId", "in":"path", "description":"Scenario ID.
", "required":true, "schema":{ "type":"integer", "format":"int64" } }, { "name":"userId", "in":"path", "description":"Participant ID.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"No Content
Scenario participant deleted successfully.
" }, "400":{ "description":"Bad Request
Failed to delete scenario participant. The scenario ID may be invalid, or the scenario may already have been submitted for approval.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"scenarios-{scenarioId}-participants-{userId}-delete", "x-filename-id":"scenarios-scenarioid-participants-userid-delete" } }, "/scenarios/{id}/changes":{ "get":{ "tags":[ "Scenarios" ], "summary":"Get Changes", "description":"Gets scenario data changes. If you are the owner, approver, or participant for a given scenario, you can compare scenario and base models.
", "operationId":"Scenarios.getChangeData", "parameters":[ { "name":"id", "in":"path", "description":"Scenario ID.
", "required":true, "schema":{ "type":"integer", "format":"int64" } } ], "responses":{ "200":{ "description":"p>OKScenario changes returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ScenarioChangesListResponse" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ScenarioChangesListResponse" } } } }, "400":{ "description":"Bad Request
Failed to get scenario changes. The scenario ID may be invalid.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"scenarios-{id}-changes-get", "x-filename-id":"scenarios-id-changes-get" } }, "/scenarios/databases":{ "get":{ "tags":[ "Scenarios" ], "summary":"Get Scenario Enabled Cubes", "description":"Gets information about all the databases registered for scenario management.
", "operationId":"Scenarios.getRegisteredCubes", "responses":{ "200":{ "description":"OK
Scenario-enabled cubes returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ScenarioCubesList" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ScenarioCubesList" } } } }, "400":{ "description":"Bad Request
Failed to get scenario-enabled cubes.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"scenarios-databases-get", "x-filename-id":"scenarios-databases-get" } }, "/scenarios/{scenarioId}/scripts":{ "get":{ "tags":[ "Scenarios" ], "summary":"Get Scenario Scripts", "description":"Gets scenario scripts.
", "operationId":"Scenarios.getScripts", "parameters":[ { "name":"scenarioId", "in":"path", "description":"Scenario ID.
", "required":true, "schema":{ "type":"integer", "format":"int64" } } ], "responses":{ "200":{ "description":"OK
Scenario scripts returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ScriptListResponse" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ScriptListResponse" } } } }, "400":{ "description":"Bad Request
Failed to get scenario scripts. The scenario ID may be invalid.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"scenarios-{scenarioId}-scripts-get", "x-filename-id":"scenarios-scenarioid-scripts-get" } }, "/scenarios/{scenarioId}/scripts/{scriptType}":{ "put":{ "tags":[ "Scenarios" ], "summary":"Update Scenario with Script", "description":"Updates scenario using script of specified type.
", "operationId":"Scenarios.updateScript", "parameters":[ { "name":"scenarioId", "in":"path", "description":"Scenario ID.
", "required":true, "schema":{ "type":"integer", "format":"int64" } }, { "name":"scriptType", "in":"path", "description":"Script type. Valid values are: refresh to revert to base, apply to commit to base, and clear to set to #Missing.
Script details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ScriptBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ScriptBean" } } } }, "responses":{ "204":{ "description":"OK
Scenario updated successfully.
" }, "400":{ "description":"Bad Request
Failed to update scenario with script. The scenario ID or script type may be invalid.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"scenarios-{scenarioId}-scripts-{scriptType}-put", "x-filename-id":"scenarios-scenarioid-scripts-scripttype-put" } }, "/applications/{applicationName}/databases/{databaseName}/scripts/{scriptName}/permissions":{ "get":{ "tags":[ "Scripts" ], "summary":"Get Essbase Script Permissions", "description":"Retrieves permissions for the specified script. Applicable only for calculation scripts.
", "operationId":"Scripts.getScriptPermissions", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"scriptName", "in":"path", "description":"Script name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OKScript permissions retrieved successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/UserGroupProvisionInfoList" } } }, "application/xml":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/UserGroupProvisionInfoList" } } } } }, "400":{ "description":"
Bad Request
Failed to get permissions for the script. The application, database, or script name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-scripts-{scriptName}-permissions-get", "x-filename-id":"applications-applicationname-databases-databasename-scripts-scriptname-permissions-get" }, "post":{ "tags":[ "Scripts" ], "summary":"Add Calc Script Permissions", "description":"Adds permissions to the specified script for the specified user or group. Applicable only for calculation scripts.
", "operationId":"Scripts.addScriptPermission", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"scriptName", "in":"path", "description":"Script name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"User or group details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UserGroupProvisionInfo" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/UserGroupProvisionInfo" } } }, "required":true }, "responses":{ "200":{ "description":"OKScript permission added successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UserGroupProvisionInfo" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/UserGroupProvisionInfo" } } } }, "400":{ "description":"Bad Request
Failed to add permissions for the script. The application, database, or script name may be incorrect; the user or group ID may be incorrect; or the specified user or group may not have sufficient privileges.
" }, "415":{ "description":"Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-scripts-{scriptName}-permissions-post", "x-filename-id":"applications-applicationname-databases-databasename-scripts-scriptname-permissions-post" } }, "/applications/{applicationName}/databases/{databaseName}/scripts/scriptops/copy":{ "post":{ "tags":[ "Scripts" ], "summary":"Copy Calc Script", "description":"Copies the script in the specified application and database and returns the created script. Applicable only for calculation scripts.
", "operationId":"Scripts.copyScript", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Script copy details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ScriptCopy" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ScriptCopy" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Script copied successfully, including script details and links to get, edit, or delete the script and to get its contents.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Script" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Script" } } } }, "400":{ "description":"Bad Request
Failed to copy the script. The application, database, or script name may be incorrect, or the specified script name may already exist.
" }, "415":{ "description":"Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-scripts-scriptops-copy-post", "x-filename-id":"applications-applicationname-databases-databasename-scripts-scriptops-copy-post" } }, "/applications/{applicationName}/databases/{databaseName}/scripts":{ "get":{ "tags":[ "Scripts" ], "summary":"List Calc or MDX Scripts", "description":"Returns calculation or MDX scripts from the specified Essbase application and cube.
", "operationId":"Scripts.listScripts", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database (cube) name.
", "required":true, "schema":{ "type":"string" } }, { "name":"file", "in":"query", "description":"Type of script file to return. Valid values: calc or mdx. Default value, if unspecified, is calc.
column:direction. For example, name:asc.",
"schema":{
"type":"string",
"default":""
}
},
{
"name":"keyword",
"in":"query",
"description":"Filter the list of scripts using a keyword.
", "schema":{ "type":"string", "default":"" } } ], "responses":{ "200":{ "description":"OK
Scripts retrieved successfully, including script details and links to get, edit, or delete the script and to get its contents.
", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/ScriptList" } } }, "application/xml":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/ScriptList" } } } } }, "400":{ "description":"Bad Request
Failed to get the scripts. The application or database name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-scripts-get", "x-filename-id":"applications-applicationname-databases-databasename-scripts-get" }, "post":{ "tags":[ "Scripts" ], "summary":"Create Essbase Script", "description":"Creates the script in the specified application and database and returns the created script.
", "operationId":"Scripts.createScript", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"file", "in":"query", "description":"Type of script file.
", "schema":{ "type":"string", "default":"calc" } } ], "requestBody":{ "description":"Script details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Script" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Script created successfully, including script details and links to get, edit, or delete the script and to get its contents.
", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Script" } } } }, "400":{ "description":"Bad Request
Failed to create the script. The application or database name may be incorrect, the JSON for the script may be incorrect, or the specified script name may already exist.
" }, "415":{ "description":"Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-scripts-post", "x-filename-id":"applications-applicationname-databases-databasename-scripts-post" } }, "/applications/{applicationName}/databases/{databaseName}/scripts/{scriptName}":{ "get":{ "tags":[ "Scripts" ], "summary":"Get Calc or MDX Script", "description":"Returns the named calculation or MDX script from the specified application and database.
", "operationId":"Scripts.getScript", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"scriptName", "in":"path", "description":"Script name.
", "required":true, "schema":{ "type":"string" } }, { "name":"file", "in":"query", "description":"Type of script file.
", "schema":{ "type":"string", "default":"calc" } } ], "responses":{ "200":{ "description":"OK
Script returned successfully, including links get, edit, or delete the script and to get its contents.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Script" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Script" } } } }, "400":{ "description":"Bad Request
Failed to get the script. The application, database, or script name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-scripts-{scriptName}-get", "x-filename-id":"applications-applicationname-databases-databasename-scripts-scriptname-get" }, "put":{ "tags":[ "Scripts" ], "summary":"Update Essbase Script", "description":"Updates the specified script in the specified application and database and returns the updated script.
", "operationId":"Scripts.editScript", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"scriptName", "in":"path", "description":"Script name.
", "required":true, "schema":{ "type":"string" } }, { "name":"file", "in":"query", "description":"Type of script file.
", "schema":{ "type":"string", "default":"calc" } } ], "requestBody":{ "description":"Script details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Script" } } }, "required":true }, "responses":{ "200":{ "description":"OKScript updated successfully. Includes script details and links get, edit, or delete the script and to get its contents.
", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Script" } } } }, "400":{ "description":"Bad Request
Failed to update the script. The application or database name may be incorrect, the JSON for the script may be incorrect, or the specified script name may already exist.
" }, "415":{ "description":"Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-scripts-{scriptName}-put", "x-filename-id":"applications-applicationname-databases-databasename-scripts-scriptname-put" }, "delete":{ "tags":[ "Scripts" ], "summary":"Delete Calc or MDX Script", "description":"Deletes the specified calculation or MDX script in the specified application and database.
", "operationId":"Scripts.deleteScript", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"scriptName", "in":"path", "description":"Calc or MDX script name.
", "required":true, "schema":{ "type":"string" } }, { "name":"file", "in":"query", "description":"Type of script file. Supported types are calc (the default), or mdx.
", "schema":{ "type":"string", "default":"calc" } } ], "responses":{ "204":{ "description":"No ContentScript deleted successfully.
" }, "400":{ "description":"Bad Request
Failed to delete the script. The application, database, or script name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-scripts-{scriptName}-delete", "x-filename-id":"applications-applicationname-databases-databasename-scripts-scriptname-delete" } }, "/applications/{applicationName}/databases/{databaseName}/scripts/{scriptName}/rtsv":{ "get":{ "tags":[ "Scripts" ], "summary":"Get Essbase Script RTSVs", "description":"Returns the runtime substitution variables used in the specified script name.
", "operationId":"Scripts.getRTSVsForScripts", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"scriptName", "in":"path", "description":"Script name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
List of runtime substitution variables returned successfully.
", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/RTSVList" } } }, "application/xml":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/RTSVList" } } } } }, "400":{ "description":"Bad Request
Failed to get variables. The application, database, or script name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-scripts-{scriptName}-rtsv-get", "x-filename-id":"applications-applicationname-databases-databasename-scripts-scriptname-rtsv-get" } }, "/applications/{applicationName}/databases/{databaseName}/scripts/{scriptName}/content":{ "get":{ "tags":[ "Scripts" ], "summary":"Get Essbase Script Contents", "description":"Returns the contents of the specified script from the specified application and database.
", "operationId":"Scripts.getScriptContent", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"scriptName", "in":"path", "description":"Script name.
", "required":true, "schema":{ "type":"string" } }, { "name":"file", "in":"query", "description":"Type of script file. If omitted, the default is calc. Values can be: calc, mdx, maxl, or report.
", "schema":{ "type":"string", "default":"calc" } } ], "responses":{ "200":{ "description":"OKScript content retrieved successfully.
" }, "400":{ "description":"Bad Request
Failed to get script contents. The application, database, or script name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-scripts-{scriptName}-content-get", "x-filename-id":"applications-applicationname-databases-databasename-scripts-scriptname-content-get" }, "put":{ "tags":[ "Scripts" ], "summary":"Upload Script Content", "description":"Uploads or replaces the content of the specified script in an application database.
", "operationId":"uploadScriptContent", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"scriptName", "in":"path", "description":"Script name.
", "required":true, "schema":{ "type":"string" } }, { "name":"file", "in":"query", "description":"Type of script file.
", "schema":{ "type":"string", "default":"calc" } } ], "requestBody":{ "content":{ "text/plain":{ "schema":{ "type":"object" } }, "application/octet-stream":{ "schema":{ "type":"object" } } } }, "responses":{ "default":{ "description":"default response", "content":{ "application/json":{ }, "application/xml":{ } } } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-scripts-{scriptName}-content-put", "x-filename-id":"applications-applicationname-databases-databasename-scripts-scriptname-content-put" } }, "/applications/{applicationName}/databases/{databaseName}/scripts/{scriptName}/permissions/{userGroupId}":{ "delete":{ "tags":[ "Scripts" ], "summary":"Remove Calc Script Permissions", "description":"Removes permissions from the specified script for the specified user or group. Applicable only for calculation scripts.
", "operationId":"Scripts.removeScriptPermission", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"scriptName", "in":"path", "description":"Script name.
", "required":true, "schema":{ "type":"string" } }, { "name":"userGroupId", "in":"path", "description":"ID of the user or group.
", "required":true, "schema":{ "type":"string" } }, { "name":"group", "in":"query", "description":"True if the userGroupId refers to a group.
", "required":true, "schema":{ "type":"boolean", "default":false } } ], "responses":{ "204":{ "description":"No ContentScript permission removed successfully.
" }, "400":{ "description":"Bad Request
Failed to delete permissions for the script. The application, database, or script name may be incorrect, or the user or group ID may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-scripts-{scriptName}-permissions-{userGroupId}-delete", "x-filename-id":"applications-applicationname-databases-databasename-scripts-scriptname-permissions-usergroupid-delete" } }, "/applications/{applicationName}/databases/{databaseName}/scripts/scriptops/rename":{ "post":{ "tags":[ "Scripts" ], "summary":"Rename Calc Script", "description":"Renames the script in the specified application and database and returns the created script. Applicable only for calculation scripts.
", "operationId":"Scripts.renameScript", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Script rename details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ScriptCopy" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ScriptCopy" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Script renamed successfully. Includes script details and links to get, edit, or delete the script and to get its contents.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Script" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Script" } } } }, "400":{ "description":"Bad Request
Failed to rename the script. The application, database, or script name may be incorrect, or the specified script name may already exist.
" }, "415":{ "description":"Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-scripts-scriptops-rename-post", "x-filename-id":"applications-applicationname-databases-databasename-scripts-scriptops-rename-post" } }, "/applications/{applicationName}/databases/{databaseName}/scripts/scriptops/validate":{ "post":{ "tags":[ "Scripts" ], "summary":"Validate Calc Script", "description":"Validates the specified script. Applicable only for calculation scripts.
", "operationId":"Scripts.validateScript", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"file", "in":"query", "description":"File.
", "schema":{ "type":"string", "default":"calc" } } ], "requestBody":{ "description":"Script details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Script" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Script" } } }, "required":true }, "responses":{ "200":{ "description":"OKScript validated successfully.
" }, "400":{ "description":"Bad Request
Failed to validate the script. The application or database name may be incorrect, or the contents may be incomplete for the specified script name.
" }, "415":{ "description":"Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-scripts-scriptops-validate-post", "x-filename-id":"applications-applicationname-databases-databasename-scripts-scriptops-validate-post" } }, "/applications/{applicationName}/databases/{databaseName}/scripts/{scriptName}/scriptops/validate":{ "post":{ "tags":[ "Scripts" ], "summary":"Validate Calc Script", "description":"Validates the specified script. Applicable only for calculation scripts.
", "operationId":"Scripts.validateScriptFile", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"scriptName", "in":"path", "description":"Script name.
", "required":true, "schema":{ "type":"string" } }, { "name":"file", "in":"query", "description":"File.
", "schema":{ "type":"string", "default":"calc" } } ], "responses":{ "200":{ "description":"OKScript validated successfully.
" }, "400":{ "description":"Bad Request
Failed to validate the script. The application or database name may be incorrect, or the contents may be incomplete for the specified script name.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-scripts-{scriptName}-scriptops-validate-post", "x-filename-id":"applications-applicationname-databases-databasename-scripts-scriptname-scriptops-validate-post" } }, "/sessions":{ "get":{ "tags":[ "Sessions" ], "summary":"List Sessions", "description":"Returns a list of session currently active for a user or request.
", "operationId":"Sessions.getAllActiveSessions", "parameters":[ { "name":"application", "in":"query", "description":"Application name.
", "schema":{ "type":"string" } }, { "name":"database", "in":"query", "description":"Database name.
", "schema":{ "type":"string" } }, { "name":"userId", "in":"query", "description":"User ID for whom to return the active sessions. If not provided, all the sessions are retrieved.
", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OKSession details returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SessionAttributes" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/SessionAttributes" } } } }, "400":{ "description":"Bad Request
Essbase or platform security exception.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"sessions-get", "x-filename-id":"sessions-get" }, "delete":{ "tags":[ "Sessions" ], "summary":"Delete All Sessions", "description":"Deletes all the sessions currently active or kills all the requests currently processing.
", "operationId":"Sessions.deleteAllActiveSessions", "parameters":[ { "name":"application", "in":"query", "description":"Application name.
", "schema":{ "type":"string" } }, { "name":"database", "in":"query", "description":"Database name.
", "schema":{ "type":"string" } }, { "name":"userId", "in":"query", "description":"User ID.
", "schema":{ "type":"string" } }, { "name":"disconnect", "in":"query", "description":"Disconnect value (Boolean). If false, the request is killed. Otherwise, the session is logged off.
", "schema":{ "type":"boolean", "default":false } } ], "responses":{ "200":{ "description":"1. Deletes all the sessions for the parameter 'application', 'database' and 'userid' provided. If no parameters are specified, deletes all active sessions.
2. Cannot disconnect user. Essbase Error(1051041): Insufficient privilege for this operation.
" }, "400":{ "description":"Bad Request
Essbase or platform security exception.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"sessions-delete", "x-filename-id":"sessions-delete" } }, "/sessions/{sessionId}":{ "delete":{ "tags":[ "Sessions" ], "summary":"Delete Session By ID", "description":"Deletes a particular session or kills a particular request using the session id.
", "operationId":"Sessions.deleteSessionWithId", "parameters":[ { "name":"disconnect", "in":"query", "description":"Disconnection value. Default is false, meaning kill the request. If true, disconnect the user session.
", "schema":{ "type":"boolean", "default":false } }, { "name":"sessionId", "in":"path", "description":"sessionId of the session to be disconnected or request killed.
", "required":true, "schema":{ "type":"integer", "format":"int64" } } ], "responses":{ "200":{ "description":"OK
Session or request terminated successfully.
" }, "400":{ "description":"Bad Request
Error: No session with specified login id.Internal Server Error.
" } }, "x-internal-id":"sessions-{sessionId}-delete", "x-filename-id":"sessions-sessionid-delete" } }, "/applications/{applicationName}/databases/{databaseName}/dataload/{streamId}":{ "post":{ "tags":[ "Streaming Data Load" ], "summary":"Push Data", "description":"Pushes data for data load. Data can be pushed in chunks in CSV format by repeating this request multiple times.
", "operationId":"Dataload.streamData", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"streamId", "in":"path", "description":"Stream ID returned from the Start Data Load operation.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Comma-separated data.
", "content":{ "text/plain":{ "schema":{ "type":"string" } }, "text/csv":{ "schema":{ "type":"string" } } } }, "responses":{ "200":{ "description":"OK
Data pushed successfully; includes links to push more data and end data load if links=true parameter is passed.
Bad Request
Failed to push data. The stream ID may be invalid.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-dataload-{streamId}-post", "x-filename-id":"applications-applicationname-databases-databasename-dataload-streamid-post" }, "delete":{ "tags":[ "Streaming Data Load" ], "summary":"End Data Load", "description":"Ends streaming data load.
", "operationId":"Dataload.end", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"streamId", "in":"path", "description":"Stream ID.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Data load ended successfully; includes status.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/StreamProcessEndResponse" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/StreamProcessEndResponse" } } } }, "400":{ "description":"Bad Request
Failed to end data load. The stream ID may be invalid.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-dataload-{streamId}-delete", "x-filename-id":"applications-applicationname-databases-databasename-dataload-streamid-delete" } }, "/applications/{applicationName}/databases/{databaseName}/dataload":{ "post":{ "tags":[ "Streaming Data Load" ], "summary":"Start Data Load", "description":"Starts streaming data load. This call generates a unique stream ID that is consumed by subsequent calls Push Data and End Data Load.
", "operationId":"Dataload.start", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Data load options such as rule file name and delimiter.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DataLoadStartPayload" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/DataLoadStartPayload" } } } }, "responses":{ "200":{ "description":"OK
Data load started successfully; includes unique stream id which can be passed to subsequent requests. If links=true parameter is passed, also includes links to push more data and end the data load.
Bad Request
The logged in user may not have the appropriate application role.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-dataload-post", "x-filename-id":"applications-applicationname-databases-databasename-dataload-post" } }, "/applications/{applicationName}/databases/{databaseName}/dimbuild/{streamId}":{ "post":{ "tags":[ "Streaming Dimension Build" ], "summary":"Push Dimensions", "description":"Pushes data for streaming dimension build.
", "operationId":"DimensionBuild.streamDimBuildData", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"streamId", "in":"path", "description":"Stream ID.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"CSV data.
", "content":{ "text/plain":{ "schema":{ "type":"string" } }, "text/csv":{ "schema":{ "type":"string" } } } }, "responses":{ "200":{ "description":"OK
Data pushed successfully; includes links to push more data and end dimension build if links=true parameter is passed.
Bad Request
Failed to push data. The stream ID may be invalid, or the dimension build may not have started.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-dimbuild-{streamId}-post", "x-filename-id":"applications-applicationname-databases-databasename-dimbuild-streamid-post" }, "delete":{ "tags":[ "Streaming Dimension Build" ], "summary":"End Streaming Dimension Build", "description":"Ends an incremental dimension build and triggers a restructuring of the cube.
", "operationId":"DimensionBuild.end", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"streamId", "in":"path", "description":"Stream ID.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Dimension build ended successfully; includes status.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/StreamProcessEndResponse" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/StreamProcessEndResponse" } } } }, "400":{ "description":"Bad Request
Failed to end dimension build. The stream ID may be invalid.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-dimbuild-{streamId}-delete", "x-filename-id":"applications-applicationname-databases-databasename-dimbuild-streamid-delete" } }, "/applications/{applicationName}/databases/{databaseName}/dimbuild/{streamId}/{ruleFileName}":{ "post":{ "tags":[ "Streaming Dimension Build" ], "summary":"Start Dimension Build", "description":"Starts a dimension build with a rule file.
", "operationId":"DimensionBuild.startDimBuild", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"streamId", "in":"path", "description":"Stream ID.
", "required":true, "schema":{ "type":"string" } }, { "name":"ruleFileName", "in":"path", "description":"Rule File Name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Dimension build started successfully. If links=true parameter is passed, also includes links to push more data.
Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-dimbuild-{streamId}-{ruleFileName}-post", "x-filename-id":"applications-applicationname-databases-databasename-dimbuild-streamid-rulefilename-post" }, "delete":{ "tags":[ "Streaming Dimension Build" ], "summary":"End Dimension Build", "description":"Ends a dimension build with a rules file.
", "operationId":"DimensionBuild.endDimBuild", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"streamId", "in":"path", "description":"Stream ID.
", "required":true, "schema":{ "type":"string" } }, { "name":"ruleFileName", "in":"path", "description":"Rules file name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Dimension build ended successfully. Returns status. If links=true parameter is passed, also includes links to restructure.
Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-dimbuild-{streamId}-{ruleFileName}-delete", "x-filename-id":"applications-applicationname-databases-databasename-dimbuild-streamid-rulefilename-delete" } }, "/applications/{applicationName}/databases/{databaseName}/dimbuild":{ "post":{ "tags":[ "Streaming Dimension Build" ], "summary":"Start Streaming Dimension Build", "description":"Starts an incremental dimension build to push metadata to an Essbase outline. This call generates a unique stream ID that is consumed by subsequent calls in this order:
", "operationId":"DimensionBuild.start", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Dimension build attributes, such as the restructure option. If empty, the default value for restructure option is PRESERVE_ALL_DATA.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/DimBuildStartPayload"
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/DimBuildStartPayload"
}
}
}
},
"responses":{
"200":{
"description":"
OK
Dimension build started successfully; includes unique stream id which can be passed to subsequent requests. If links=true parameter is passed, also includes links to start dimension build with rules file.
Bad Request
The logged in user may not have the appropriate application role.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-dimbuild-post", "x-filename-id":"applications-applicationname-databases-databasename-dimbuild-post" } }, "/users/{id}":{ "get":{ "tags":[ "Users" ], "summary":"Get User", "description":"Gets details for a specified user ID.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
", "operationId":"Users.get", "parameters":[ { "name":"id", "in":"path", "description":"ID of user.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
User details returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UserBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/UserBean" } } } }, "404":{ "description":"Not Found
User not found.
" }, "400":{ "description":"Bad Request
The logged in user may not have the appropriate service role.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"users-{id}-get", "x-filename-id":"users-id-get" }, "put":{ "tags":[ "Users" ], "summary":"Update User", "description":"Updates a user.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
", "operationId":"Users.PUT", "parameters":[ { "name":"id", "in":"path", "description":"ID of user.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Updated user.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UserBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/UserBean" } } }, "required":true }, "responses":{ "200":{ "description":"OK
User updated successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UserBean" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/UserBean" } } } }, "400":{ "description":"Bad Request
The logged in user may not have the appropriate service role.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"users-{id}-put", "x-filename-id":"users-id-put" }, "delete":{ "tags":[ "Users" ], "summary":"Delete User", "description":"Deletes a user.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
", "operationId":"Users.delete", "parameters":[ { "name":"id", "in":"path", "description":"ID of user.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
User deleted successfully.
" }, "400":{ "description":"Bad Request
The logged in user may not have the appropriate service role.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"users-{id}-delete", "x-filename-id":"users-id-delete" } }, "/users":{ "get":{ "tags":[ "Users" ], "summary":"Search or Export Users", "description":"Get a list of users based on search results, or export users as CSV file.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
", "operationId":"Users.search", "parameters":[ { "name":"filter", "in":"query", "description":"User ID wildcard pattern. Filter by name of user if header Accept='application/json' or Accept='application/xml'.
Maximum number of users to return if header Accept='application/json' or Accept='application/xml'. Default of -1 = no maximum.
Value can be all or none. Default value is all, meaning service role and groups are returned for each user. If none is specified, service role and groups are not returned.
OK
User results returned successfully. Response type can be either JSON, XML, or CSV stream, depending on the Accept header. If Accept='application/json' or Accept='application/xml', the users are returned in the response body. If Accept='application/octet-stream', the users are returned as a JSON stream.
Bad Request
The logged in user may not have the appropriate service role.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"users-get", "x-filename-id":"users-get" }, "post":{ "tags":[ "Users" ], "summary":"Add or Import Users", "description":"Add or import user(s).
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
", "operationId":"Users.add", "requestBody":{ "description":"Users details to create, if Accept='application/json' or Accept='application/xml'. Or CSV file from which to import users, if Accept='application/octet-stream'.
OK
User added successfully. If Accept='application/json' or Accept='application/xml', the users are returned in the response body. If Accept='application/octet-stream', the added users are imported but not included in the response body.
Bad Request
The logged in user may not have the appropriate service role.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"users-post", "x-filename-id":"users-post" } }, "/users/actions/delete":{ "post":{ "tags":[ "Users" ], "summary":"Delete Users", "description":"Deletes the users specified in the text file. Requires service administrator role.
If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.
", "operationId":"Users.deleteUsers", "responses":{ "200":{ "description":"OK
Users deleted successfully.
" }, "400":{ "description":"Bad Request
Validation failed. The logged in user may not have the appropriate service role.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"users-actions-delete-post", "x-filename-id":"users-actions-delete-post" } }, "/variables":{ "get":{ "tags":[ "Server Variables" ], "summary":"Get Server Variables", "description":"Returns all the substitution variables from the Essbase server.
", "operationId":"Variables.listServerVariables", "parameters":[ { "name":"orderBy", "in":"query", "description":"Order By specification in format:column:direction. For example, name:asc.",
"schema":{
"type":"string",
"default":""
}
},
{
"name":"all",
"in":"query",
"schema":{
"type":"string",
"default":"false"
}
}
],
"responses":{
"200":{
"description":"OK
Variables retrieved successfully. Includes variable details and links to get, edit, or delete the variables.
", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/VariableList" } } }, "application/xml":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/VariableList" } } } } }, "400":{ "description":"Bad Request
Failed to get variables.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"variables-get", "x-filename-id":"variables-get" }, "post":{ "tags":[ "Server Variables" ], "summary":"Create Server Variable", "description":"Creates a server substitution variable and returns details about it.
", "operationId":"Variables.createServerVariable", "requestBody":{ "description":"Variable details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Variable" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Variable" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Variable created successfully. Includes variable details and links to get, edit, or delete the variable.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Variable" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Variable" } } } }, "400":{ "description":"Bad Request
Failed to create variable. The JSON may be incorrect, or a variable with that name may already exist.
" }, "415":{ "description":"Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"variables-post", "x-filename-id":"variables-post" } }, "/variables/{variableName}":{ "get":{ "tags":[ "Server Variables" ], "summary":"Get Server Variable", "description":"Returns substitution variable details from the server.
", "operationId":"Variables.getServerVariable", "parameters":[ { "name":"variableName", "in":"path", "description":"Variable name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Variable retrieved successfully. Includes variable details and links to get, edit, or delete the variable.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Variable" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Variable" } } } }, "400":{ "description":"Bad Request
Failed to get the variable. The variable name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"variables-{variableName}-get", "x-filename-id":"variables-variablename-get" }, "put":{ "tags":[ "Server Variables" ], "summary":"Update Server Variable", "description":"Updates a substitution variable on the server and returns the updated variable.
", "operationId":"Variables.editServerVariable", "parameters":[ { "name":"variableName", "in":"path", "description":"Variable name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Variable details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Variable" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Variable" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Variable updated successfully. Includes variable details and links to get, edit, or delete the variable.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Variable" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Variable" } } } }, "400":{ "description":"Bad Request
Failed to update the variable. The variable name may be incorrect.
" }, "415":{ "description":"Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"variables-{variableName}-put", "x-filename-id":"variables-variablename-put" }, "delete":{ "tags":[ "Server Variables" ], "summary":"Delete Server Variable", "description":"Deletes the given substitution variable from the server.
", "operationId":"Variables.deleteServerVariable", "parameters":[ { "name":"variableName", "in":"path", "description":"Variable name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"OK
Variable deleted successfully.
" }, "400":{ "description":"Bad Request
Failed to delete the variable. The variable name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"variables-{variableName}-delete", "x-filename-id":"variables-variablename-delete" } }, "/applications/{applicationName}/variables":{ "get":{ "tags":[ "Variables" ], "summary":"Get Application Variables", "description":"Returns all substitution variables from the specified application.
", "operationId":"Variables.listAppVariables", "parameters":[ { "name":"orderBy", "in":"query", "description":"Order By specification in format:column:direction. For example, name:asc.",
"schema":{
"type":"string",
"default":""
}
},
{
"name":"includeDatabaseVariables",
"in":"query",
"description":"Include database variables in application variables result.
", "schema":{ "type":"boolean", "default":false } }, { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Variables returned successfully, with links to get, edit, or delete.
", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/VariableList" } } }, "application/xml":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/VariableList" } } } } }, "400":{ "description":"Bad Request
Failed to get the variables. The application name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-variables-get", "x-filename-id":"applications-applicationname-variables-get" }, "post":{ "tags":[ "Variables" ], "summary":"Create Application Variable", "description":"Creates a substitution variable in the specified application and returns the created variable.
", "operationId":"Variables.createAppVariable", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Variable details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Variable" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Variable" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Variable created successfully, with links to get, edit, or delete.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Variable" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Variable" } } } }, "400":{ "description":"Bad Request
Failed to create the variable. The application or database name may be incorrect, the JSON for the variable may be incorrect, or the specified variable name may already exist.
" }, "415":{ "description":"Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-variables-post", "x-filename-id":"applications-applicationname-variables-post" } }, "/applications/{applicationName}/databases/{databaseName}/variables":{ "get":{ "tags":[ "Variables" ], "summary":"Get Database Variables", "description":"Returns all substitution variables from the specified application and database.
", "operationId":"Variables.listVariables", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"orderBy", "in":"query", "description":"Order By specification in format:column:direction. For example, name:asc. ",
"schema":{
"type":"string",
"default":""
}
}
],
"responses":{
"200":{
"description":"OK
Variables returned successfully, with links to get, edit, or delete.
", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/VariableList" } } }, "application/xml":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/VariableList" } } } } }, "400":{ "description":"Bad Request
Failed to get the variables. The application or database name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-variables-get", "x-filename-id":"applications-applicationname-databases-databasename-variables-get" }, "post":{ "tags":[ "Variables" ], "summary":"Create Database Variable", "description":"Creates a substitution variable in the specified application and database and returns the created variable.
", "operationId":"Variables.createVariable", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Variable details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Variable" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Variable" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Variable created successfully, with links to get, edit, or delete.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Variable" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Variable" } } } }, "400":{ "description":"Bad Request
Failed to create the variable. The application or database name may be incorrect, the JSON for the variable may be incorrect, or the specified variable name may already exist.
" }, "415":{ "description":"Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-variables-post", "x-filename-id":"applications-applicationname-databases-databasename-variables-post" } }, "/applications/{applicationName}/variables/{variableName}":{ "get":{ "tags":[ "Variables" ], "summary":"Get Application Variable", "description":"Returns substitution variable details from the specified application.
", "operationId":"Variables.getAppVariable", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"variableName", "in":"path", "description":"Variable name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Variable returned successfully, with links to get, edit, or delete.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Variable" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Variable" } } } }, "400":{ "description":"Bad Request
Failed to get the variable. The application name or variable name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-variables-{variableName}-get", "x-filename-id":"applications-applicationname-variables-variablename-get" }, "put":{ "tags":[ "Variables" ], "summary":"Update Application Variable", "description":"Updates the substitution variable in the specified application and returns the updated variable.
", "operationId":"Variables.editAppVariable", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"variableName", "in":"path", "description":"Variable name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Variable details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Variable" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Variable" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Variable updated successfully, with links to get, edit, or delete.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Variable" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Variable" } } } }, "400":{ "description":"Bad Request
Failed to update the variable. The application name may be incorrect, the JSON for the variable may be incorrect, or the specified variable name may not exist.
" }, "415":{ "description":"Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-variables-{variableName}-put", "x-filename-id":"applications-applicationname-variables-variablename-put" }, "delete":{ "tags":[ "Variables" ], "summary":"Delete Application Variable", "description":"Deletes the specified substitution variable from the specified application.
", "operationId":"Variables.deleteAppVariable", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"variableName", "in":"path", "description":"Variable name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"No Content
Variable deleted successfully.
" }, "400":{ "description":"Bad Request
Failed to delete the variable. The application name or variable name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-variables-{variableName}-delete", "x-filename-id":"applications-applicationname-variables-variablename-delete" } }, "/applications/{applicationName}/databases/{databaseName}/variables/{variableName}":{ "get":{ "tags":[ "Variables" ], "summary":"Get Database Variable", "description":"Returns the substitution variable details from the specified application and database.
", "operationId":"Variables.getVariable", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"variableName", "in":"path", "description":"Variable name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK
Variable returned successfully, with links to get, edit, or delete.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Variable" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Variable" } } } }, "400":{ "description":"Bad Request
Failed to get the variable. The application, database, or variable name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-variables-{variableName}-get", "x-filename-id":"applications-applicationname-databases-databasename-variables-variablename-get" }, "put":{ "tags":[ "Variables" ], "summary":"Update Database Variable", "description":"Updates a substitution variable in the specified application and database and returns the updated variable.
", "operationId":"Variables.editVariable", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"variableName", "in":"path", "description":"Variable name.
", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Variable details.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Variable" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Variable" } } }, "required":true }, "responses":{ "200":{ "description":"OK
Variable updated successfully, with links to get, edit, or delete.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Variable" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Variable" } } } }, "400":{ "description":"Bad Request
Failed to update the variable. The application or database name may be incorrect, the JSON for the variable may be incorrect, or the specified variable name may not exist.
" }, "415":{ "description":"Not Acceptable
The media type isn't supported or wasn't specified.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-variables-{variableName}-put", "x-filename-id":"applications-applicationname-databases-databasename-variables-variablename-put" }, "delete":{ "tags":[ "Variables" ], "summary":"Delete Database Variable", "description":"Deletes the specified substitution variable from the specified application and database.
", "operationId":"Variables.deleteVariable", "parameters":[ { "name":"applicationName", "in":"path", "description":"Application name.
", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Database name.
", "required":true, "schema":{ "type":"string" } }, { "name":"variableName", "in":"path", "description":"Variable name.
", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"No Content
Variable deleted successfully.
" }, "400":{ "description":"Bad Request
Failed to delete the variable. The application, database, or variable name may be incorrect.
" }, "500":{ "description":"Internal Server Error.
" } }, "x-internal-id":"applications-{applicationName}-databases-{databaseName}-variables-{variableName}-delete", "x-filename-id":"applications-applicationname-databases-databasename-variables-variablename-delete" } }, "/settings":{ "get":{ "tags":[ "Platform Service Settings" ], "summary":"Get Available Platform Service Settings", "description":"Returns the platform service settings. This API returns the links to various settings available in this release.
", "operationId":"PSMSettings.getAll", "responses":{ "200":{ "description":"OK
Platform service settings returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Settings" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Settings" } } } } }, "x-internal-id":"settings-get", "x-filename-id":"settings-get" } }, "/settings/odlLogSettings":{ "get":{ "tags":[ "Platform Service Settings" ], "summary":"Get Diagnostic Log Settings", "description":"Get the Oracle Diagnostic Log (ODL) settings.
", "operationId":"getodllogsettings", "responses":{ "200":{ "description":"OK
Successful operation.
" } }, "x-internal-id":"settings-odlLogSettings-get", "x-filename-id":"settings-odllogsettings-get" }, "put":{ "tags":[ "Platform Service Settings" ], "summary":"Set Diagnostic Log Settings", "description":"Set the Oracle Diagnostic Log (ODL) settings.
", "operationId":"setodllogsettings", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/ODLLogHandlerSetting" } } }, "application/xml":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/ODLLogHandlerSetting" } } } } }, "responses":{ "200":{ "description":"OK
Successful operation.
" } }, "x-internal-id":"settings-odlLogSettings-put", "x-filename-id":"settings-odllogsettings-put" } }, "/settings/maintenance":{ "get":{ "tags":[ "Platform Service Settings" ], "summary":"Get Maintenance Settings", "description":"Gets the platform service maintenance settings, such as disk space and memory.
", "operationId":"PSMSettings.getSystemMaintenanceLimits", "responses":{ "200":{ "description":"OK
Saved platform service resource settings returned successfully.
", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Limits" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/Limits" } } } }, "400":{ "description":"Bad Request
Failed to get resource settings.
" } }, "x-internal-id":"settings-maintenance-get", "x-filename-id":"settings-maintenance-get" } } }, "components":{ "schemas":{ "RoleBean":{ "type":"object", "properties":{ "type":{ "type":"string" }, "roles":{ "type":"array", "items":{ "type":"string" } }, "defaultRole":{ "type":"string" } } }, "Roles":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/RoleBean" } }, "count":{ "type":"integer", "format":"int64" }, "totalResults":{ "type":"integer", "format":"int64" }, "hasMore":{ "type":"boolean" }, "limit":{ "type":"integer", "format":"int64" }, "properties":{ "type":"object", "additionalProperties":{ "type":"string" } }, "offset":{ "type":"integer", "format":"int64" } } }, "OCIChatCredentialSigningKeyDTO":{ "required":[ "chat_model", "compartment_ocid", "fingerprint", "private_key", "tenancy_ocid", "user_ocid" ], "type":"object", "properties":{ "user_ocid":{ "type":"string" }, "tenancy_ocid":{ "type":"string" }, "private_key":{ "type":"string" }, "fingerprint":{ "type":"string" }, "chat_model":{ "type":"string" }, "compartment_ocid":{ "type":"string" } } }, "OCIVectorCredentialDTO":{ "required":[ "compartment_ocid", "embed_model", "fingerprint", "private_key", "tenancy_ocid", "url", "user_ocid" ], "type":"object", "properties":{ "user_ocid":{ "type":"string" }, "tenancy_ocid":{ "type":"string" }, "compartment_ocid":{ "type":"string" }, "private_key":{ "type":"string" }, "fingerprint":{ "type":"string" }, "url":{ "type":"string" }, "embed_model":{ "type":"string" } } }, "CalcAssistGeneratorDTO":{ "required":[ "conversation_count", "user_prompt" ], "type":"object", "properties":{ "user_prompt":{ "type":"string" }, "conversation_id":{ "type":"string" }, "conversation_count":{ "type":"integer", "format":"int32" } } }, "MdxGeneratorDTO":{ "type":"object", "properties":{ "data":{ "type":"object", "additionalProperties":{ "type":"object", "additionalProperties":{ "type":"string" } } } } }, "NNearestNeighbourDTO":{ "type":"object", "properties":{ "data":{ "type":"object", "additionalProperties":{ "type":"object", "additionalProperties":{ "type":"array", "items":{ "type":"string", "xml":{ "name":"data" } } } } } } }, "PassThroughDTO":{ "required":[ "prompt" ], "type":"object", "properties":{ "prompt":{ "type":"string" } } }, "BackupConfigBean":{ "type":"object", "properties":{ "maxParallel":{ "type":"integer", "format":"int32" }, "incrementalDurationMin":{ "type":"integer", "format":"int64" }, "checkpointDurationMin":{ "type":"integer", "format":"int64" }, "forceDurationMin":{ "type":"integer", "format":"int64" }, "systemCheckpointDurationMin":{ "type":"integer", "format":"int64" }, "enabled":{ "type":"boolean" }, "excludedApplication":{ "type":"array", "items":{ "type":"string" } }, "archiveFileSizeLimitMb":{ "type":"integer", "format":"int64" }, "verbose":{ "type":"boolean" } } }, "CommitFilePartUploadResponse":{ "type":"object", "properties":{ "opcRequestId":{ "type":"string" }, "opcMultipartMd5":{ "type":"string" }, "versionId":{ "type":"string" }, "etag":{ "type":"string" }, "lastModified":{ "type":"string", "format":"date-time" } } }, "FilePathDetail":{ "type":"object", "properties":{ "to":{ "type":"string" }, "from":{ "type":"string" } } }, "ZipFileDetails":{ "type":"object", "properties":{ "path":{ "description":"Catalog path to the zip file.
", "type":"string" } } }, "CollectionResponse":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int64" }, "items":{ "type":"array", "items":{ "type":"object" } }, "totalResults":{ "type":"integer", "format":"int64" }, "hasMore":{ "type":"boolean" }, "limit":{ "type":"integer", "format":"int64" }, "properties":{ "type":"object", "additionalProperties":{ "type":"string" } }, "offset":{ "type":"integer", "format":"int64" } } }, "CreateFilePartUploadResponse":{ "type":"object", "properties":{ "uploadId":{ "type":"string" }, "namespace":{ "type":"string" }, "object":{ "type":"string" }, "timeCreated":{ "type":"string" }, "bucket":{ "type":"string" } } }, "Response":{ "type":"object", "properties":{ "opRequestId":{ "type":"string" }, "opcContentMd5":{ "type":"string" }, "etag":{ "type":"string" } } }, "UploadFilePartResponse":{ "type":"object", "properties":{ "partNum":{ "type":"integer", "format":"int32" }, "response":{ "$ref":"#/components/schemas/Response" } } }, "CentralizedURL":{ "type":"object", "properties":{ "name":{ "type":"string" }, "value":{ "type":"string" } } }, "CentralizedURLRes":{ "type":"object", "properties":{ "mode":{ "type":"string" }, "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/CentralizedURL" } } } }, "ApplicationConfigEntry":{ "type":"object", "properties":{ "key":{ "description":"Filter key to refine the configuration property results. For example, if key=A*, all configuration properties beginning with the letter A are returned. Default is *
A description of the configuration property.
", "type":"string" }, "syntax":{ "description":"The syntax for the configuration property. Example: DATACACHESIZE n
Usage example for the configuration property. Example: DATACACHESIZE 90M
Value for the configuration property. Example: 1024
A descriptive string for this connection.
", "type":"string" }, "name":{ "description":"A name for this connection.
", "type":"string" }, "type":{ "description":"Required. Type of connection. FILE to connect to a file on the server, DB to connect to an external source system, or ESSBASE to connect to another cube.
Required for file type connections. Catalog path to the file source of data. Example: /gallery/Technical/Drill Through/DrillthroughDS.csv
", "type":"string" }, "catalog":{ "type":"boolean" }, "host":{ "description":"Host server name or IP. Required for Oracle Database connections. Required for Essbase connections, unless dbURL is used instead.
", "type":"string" }, "port":{ "description":"Port number on the remote host. Required for connections when host is given.
", "type":"integer", "format":"int32" }, "user":{ "description":"Required. User ID with authorization to access the remote source for this connection.
", "type":"string" }, "password":{ "description":"Required. Password of the user ID with authorization to access the remote source for this connection.
", "type":"string" }, "encrypted":{ "type":"boolean" }, "token":{ "type":"string" }, "sid":{ "description":"The Oracle System ID (SID) that uniquely identifies an Oracle Database. Required for Oracle Database connections unless service is used instead.
", "type":"string" }, "service":{ "description":"Service name, if you are defining an Oracle Database connection.
", "type":"string" }, "schema":{ "type":"string" }, "dbURL":{ "description":"URL to an external RDBMS database, or discovery URL to an Essbase instance. For connections to other Essbase instances, this parameter is an alternative to providing the host and port. Example of Essbase discovery URL https://192.0.2.1:443/essbase/agent. For examples of other uses, see documentation for global Get Connection endpoint.
Optional. If type is DB and you are configuring Essbase to use a generic JDBC driver, provide the fully qualified class name of the JDBC driver. For example, oracle.jdbc.driver.OracleDriver.
The type of external source. Supported sources and versions are listed in the Database section of the certification matrix (Platform SQL table).
", "type":"string", "enum":[ "TEMPLATE", "EXCELFILE", "DB", "DELIMITEDFILE", "FIXEDWIDTHFILE", "BI", "ESSBASE", "JDBC", "SPARK", "MS_SQL", "MYSQL", "DB2", "ORACLE", "FILE", "AI" ] }, "walletPath":{ "description":"Path to a wallet file, if required for your connection to Autonomous Data Warehouse (if repoWallet = false). Example: /system/wallets/EssbaseADWS. Obtain a wallet file by selecting Download Client Credentials (Wallet) from your Autonomous Data Warehouse Administration page in Oracle Cloud Infrastructure. If you are using a connection which is already available (a repository connection), you do not need to upload a wallet.
Set to true if you are using an Autonomous Data Warehouse connection which is already available (a repository connection). In this case, you do not need to upload a wallet.
", "type":"boolean" }, "minPoolSize":{ "description":"Minimum connection pool size. Default is 5. If you get connection errors you may need to adjust minimum and maximum connection pool sizes. See About Controlling the Pool Size in UCP in Universal Connection Pool Developer's Guide.
", "type":"integer", "format":"int32" }, "maxPoolSize":{ "description":"Maximum connection pool size. Default is 50. If you get connection errors you may need to adjust minimum and maximum connection pool sizes. See About Controlling the Pool Size in UCP in Universal Connection Pool Developer's Guide.
", "type":"integer", "format":"int32" }, "hidden":{ "type":"boolean" }, "availability":{ "type":"string" }, "aiConnection":{ "type":"string", "xml":{ "name":"ai_connection" } }, "chatCredential":{ "type":"string", "xml":{ "name":"chat_credential" } }, "vectorCredential":{ "type":"string", "xml":{ "name":"vector_credential" } }, "chatModel":{ "type":"string", "xml":{ "name":"chat_model" } }, "ociCompartmentId":{ "type":"string", "xml":{ "name":"oci_compartment_id" } }, "region":{ "type":"string" }, "url":{ "type":"string" }, "embedModel":{ "type":"string", "xml":{ "name":"embed_model" } }, "transferTimeout":{ "type":"string", "xml":{ "name":"transfer_timeout" } }, "ociAPIFormat":{ "type":"string", "xml":{ "name":"oci_apiformat" } }, "narrateIndexName":{ "type":"string", "xml":{ "name":"narrate_index_name" } }, "narrateProfileName":{ "type":"string", "xml":{ "name":"narrate_profile_name" } }, "narrateDocDirectory":{ "type":"string", "xml":{ "name":"narrate_doc_directory" } }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } } }, "xml":{ "name":"connection" } }, "WalletLocation":{ "type":"object", "properties":{ "path":{ "type":"string" } } }, "ConnectionsList":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/Connection" } }, "totalResults":{ "type":"integer", "format":"int64" }, "limit":{ "type":"integer", "format":"int64" }, "offset":{ "type":"integer", "format":"int64" }, "count":{ "type":"integer", "format":"int64" }, "hasMore":{ "type":"boolean" }, "properties":{ "type":"object", "additionalProperties":{ "type":"string" } } } }, "ColumnType":{ "type":"object", "properties":{ "name":{ "type":"string", "xml":{ "attribute":true } }, "type":{ "type":"string", "xml":{ "attribute":true }, "enum":[ "STRING", "DOUBLE", "DATE", "TIMESTAMP", "LONG" ] }, "nullable":{ "type":"boolean", "xml":{ "attribute":true } }, "format":{ "type":"string", "xml":{ "attribute":true } }, "index":{ "type":"integer", "format":"int32", "xml":{ "attribute":true } }, "system":{ "type":"boolean", "xml":{ "attribute":true } } } }, "ColumnsType":{ "required":[ "column" ], "type":"object", "properties":{ "column":{ "type":"array", "xml":{ "name":"Column" }, "items":{ "$ref":"#/components/schemas/ColumnType" } } } }, "Datasource":{ "required":[ "application", "columns", "connection", "cube", "description", "query", "sheet", "startRow", "type", "widths" ], "type":"object", "properties":{ "type":{ "type":"string", "enum":[ "TEMPLATE", "EXCELFILE", "DB", "DELIMITEDFILE", "FIXEDWIDTHFILE", "BI", "ESSBASE", "JDBC", "SPARK", "MS_SQL", "MYSQL", "DB2", "ORACLE", "FILE", "AI" ] }, "connection":{ "description":"Connection used for this Datasource.
", "type":"string" }, "description":{ "description":"Optional description of this Datasource.
", "type":"string" }, "columns":{ "$ref":"#/components/schemas/ColumnsType" }, "name":{ "description":"Datasource name. Must begin with a letter. Can contain only letters, underscore character, and digits.
", "type":"string" }, "ignoreErrorRecords":{ "type":"boolean" }, "delimeter":{ "description":"Delimiter of the data records, if Datasource type is DELIMITEDFILE. Delimiter can be Comma for CSV format or Tab for tab-separated format. To use a custom delimiter, use value Custom, and provide the delimiter as a value to customDelimiter.
Custom delimiter of the data records, if the value provided for delimiter is Custom.
Query associated with the Datasource. For example, a SQL query for an external database, or an MDX query for another Essbase cube. The query selects which data you want to make available in this Datasource.
", "type":"string" }, "application":{ "description":"Applicable if the type of Datasource is ESSBASE. The Essbase application name.
", "type":"string" }, "cube":{ "description":"Applicable if the type of Datasource is ESSBASE. The Essbase database name.
", "type":"string" }, "startRow":{ "description":"Optional (default is 1 if not given). For a Datasource that is an Excel or text file, the starting data row number, excluding headerRow if one exists. For example, if headerRow is specified as 1 and startRow is specified as 10, the actual starting data row will be 11.
", "type":"integer", "format":"int64" }, "endRow":{ "description":"For a Datasource that is an Excel or text file, the ending row number.
", "type":"integer", "format":"int64" }, "headerRow":{ "description":"For a Datasource that is an Excel or text file, the header row number. 0 if there is no header.
", "type":"integer", "format":"int64" }, "sheet":{ "description":"For a Datasource that is an Excel file, the worksheet name.
", "type":"string" }, "skipHiddenRows":{ "type":"boolean" }, "widths":{ "type":"array", "items":{ "type":"integer", "format":"int64", "xml":{ "name":"widths" } } }, "queryParameters":{ "description":"Parameter implementation details, if the Datasource query is parameterized. For example, if the query includes a ? placeholder for passing a parameter, as in the following query: select * from profit_data where year=?, then you need define the implementation details.
Ordinal index of the Datasource query parameter. For example, 1 for the first parameter, 2 for the second parameter, etc.
", "type":"integer", "format":"int32" }, "name":{ "description":"Optional name for the Datasource query parameter, meaningful for your use case. For example, instead of Param1 you can use param_G_month to indicate that the parameter uses a global variable for the current month, or you can rename it to param_appName_month to indicate that the parameter uses an application-level variable for the current month.
", "type":"string" }, "defaultValue":{ "description":"A fixed, default parameter value that the Datasource should use as a fallback in case the parameter has an invalid context at runtime. Example: Jan. Required only if the Datasource query is parameterized (it includes a ? placeholder for passing a parameter) AND the placeholder is not intended to reference a substitution variable nor a user-defined function developed in the external source.
true if the Datasource query parameter is required, or false otherwise.
", "type":"boolean" }, "useSubVariable":{ "description":"true if the Datasource query parameter references an Essbase substitution variable, or false otherwise.
", "type":"boolean" }, "subVariableName":{ "description":"If useSubVariable is true, the name of an Essbase substitution variable.
", "type":"string" }, "type":{ "description":"Datatype of the Datasource query parameter.
", "type":"string", "enum":[ "STRING", "DOUBLE", "DATE", "TIMESTAMP", "LONG" ] } } }, "DatasourceQueryInfo":{ "type":"object", "properties":{ "query":{ "type":"string" }, "delimiter":{ "type":"string" }, "params":{ "type":"object", "additionalProperties":{ "type":"object" } } } }, "DatasourcesList":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/Datasource" } }, "totalResults":{ "type":"integer", "format":"int64" }, "limit":{ "type":"integer", "format":"int64" }, "offset":{ "type":"integer", "format":"int64" }, "count":{ "type":"integer", "format":"int64" }, "hasMore":{ "type":"boolean" }, "properties":{ "type":"object", "additionalProperties":{ "type":"string" } } } }, "DSColumn":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int32" }, "name":{ "type":"string" } }, "xml":{ "name":"column" } }, "ResultBean":{ "type":"object", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } }, "columns":{ "type":"array", "items":{ "$ref":"#/components/schemas/DSColumn" } } }, "xml":{ "name":"Results" } }, "ColumnMappingInfo":{ "type":"object", "properties":{ "dimension":{ "type":"string" }, "generation":{ "type":"string" }, "level":{ "type":"string" }, "type":{ "type":"string", "enum":[ "DIMENSION", "GENERATION", "LEVEL0", "PARENT_CHILD" ] }, "generationNumber":{ "type":"integer", "format":"int32" } } }, "DrillthroughBean":{ "description":"Drill through report definition. Determines the access users should have to external information. Drill through report definitions are associated with a cube, and include a column mapping (required), a drillable region (required), and a mapping for runtime parameters (optional - can be used if the Datasource query is parameterized).
", "type":"object", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } }, "columnMapping":{ "description":"Specification of which external source columns should be included in the drill through report, which Essbase dimensions those columns map to, and (optionally) a generation/level filter condition indicating how much depth of access to provide.
", "type":"object", "additionalProperties":{ "$ref":"#/components/schemas/ColumnMappingInfo" } }, "columns":{ "description":"List of columns from the external Datasource that you want included in the drill through report.
", "type":"array", "items":{ "type":"string" } }, "dataSourceName":{ "description":"Name of the Datasource used for this drill through report definition.
", "type":"string" }, "url":{ "description":"Static or dynamic URL string. Use if you are defining drill through to external data using URLs.
", "type":"string" }, "drillableRegions":{ "description":"Specification of which cell intersections offer access to drill through reports (or a URL). Specify using Essbase member names and (optionally) member-set calculation functions. Example: Market,Year,Scenario,Sales,@LEVMBRS(Product,1)
", "type":"array", "items":{ "type":"string" } }, "useTempTables":{ "description":"Whether Essbase should create temporary tables for drill through performance improvement for queries that have a large number of values in the SQL ???IN??? clause.
", "type":"boolean" }, "parameterMapping":{ "description":"Optional specification of dimension, generation, or level mapping for runtime parameters (if implemented in a Datasource), enabling further customization of drill through report results based on the variable context.
", "type":"object", "additionalProperties":{ "$ref":"#/components/schemas/RunTimeParametersInfo" } }, "name":{ "description":"Name of the drill through report definition.
", "type":"string" }, "type":{ "description":"Type of drill through report definition: DATASOURCE to drill through to an external source system or URL to drill through to a web URL.
The intersection of cells in Smart View.
", "type":"object", "properties":{ "dtrContext":{ "type":"array", "items":{ "$ref":"#/components/schemas/DrillThroughRange" } }, "aliasTable":{ "description":"Optional. Alias table specifying member aliases to use in the drill through report. If unspecified, the default Essbase alias table is used.
", "type":"string" }, "sessionId":{ "type":"string" } } }, "ReportBean":{ "type":"object", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } }, "modifiedTime":{ "type":"integer", "format":"int64" }, "locked":{ "type":"boolean" }, "lockedTime":{ "type":"integer", "format":"int64" }, "lockedBy":{ "type":"string" }, "sizeInBytes":{ "type":"integer", "format":"int64" }, "name":{ "type":"string" } } }, "ReportList":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/ReportBean" } }, "totalResults":{ "type":"integer", "format":"int64" }, "limit":{ "type":"integer", "format":"int64" }, "offset":{ "type":"integer", "format":"int64" }, "count":{ "type":"integer", "format":"int64" }, "hasMore":{ "type":"boolean" }, "properties":{ "type":"object", "additionalProperties":{ "type":"string" } } } }, "ListLinkResponseObject":{ "type":"object", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } } } }, "ServerConfiguration":{ "type":"object", "properties":{ "host":{ "type":"string" }, "port":{ "type":"integer", "format":"int32" }, "user":{ "type":"string" }, "password":{ "type":"string" }, "folder":{ "type":"string" }, "messageAction":{ "type":"string" }, "messageLocation":{ "type":"string" } } }, "EventParameters":{ "type":"object", "properties":{ "application":{ "type":"string" }, "database":{ "type":"string" } } }, "Dimension":{ "type":"object", "properties":{ "generations":{ "type":"array", "items":{ "$ref":"#/components/schemas/Level" } }, "levels":{ "type":"array", "items":{ "$ref":"#/components/schemas/Level" } }, "allowassociationChanges":{ "type":"boolean" }, "allowFormulaChanges":{ "type":"boolean" }, "allowPropertyChanges":{ "type":"boolean" }, "allowUDAChanges":{ "type":"boolean" }, "measureOptions":{ "$ref":"#/components/schemas/MeasureOptions" }, "aggregateLevelUsage":{ "type":"string", "enum":[ "DEFAULT", "ALLLEVELS", "NOAGGREGATION", "TOPLEVELONLY", "NOINTERMEDIATELEVELS", "BOTTOMLEVELONLY" ] }, "addMemberOption":{ "description":"The build method algorithm to add, change, or remove dimensions, members, and aliases in this dimension. Should be based on the properties of the source data; for example, if each record specifies a parent and later a child member, in that order, then PARENT_CHILD is a good method.
", "type":"string", "enum":[ "GENERATION", "SIBLING_LOWEST_LEVEL", "CHILD", "SIBLING_MATCHING_STRING", "LEVEL", "PARENT_CHILD", "GEN_NULLS", "LEVEL_NULLS" ] }, "attributeOptions":{ "$ref":"#/components/schemas/AttributeOptions" }, "configOption":{ "type":"string", "enum":[ "EXISTING", "DENSE", "SPARSE" ] }, "unique":{ "type":"string", "enum":[ "EXISTING", "UNIQUE", "DUPLICATE", "NONE" ] }, "hierarchyType":{ "description":"MULTIPLE if multiple hierarchies should be enabled in this dimension (applicable to aggregate storage cube only). EXISTING to keep the setting unchanged. STORED for aggregate storage stored hierarchy type (no formulas). DYNAMIC for aggregate storage hierarchy type that aggregates using formulas (includes Accounts dimension).
", "type":"string", "enum":[ "EXISTING", "MULTIPLE", "STORED", "DYNAMIC" ] }, "sortOption":{ "description":"Whether and how to sort this dimension's children in hierarchies: None (do not sort), ascending, or descending.
", "type":"string", "enum":[ "NONE", "ASCENDING", "DESCENDING" ] }, "storageType":{ "type":"string", "enum":[ "EXISTING", "STORE", "NEVER_SHARE", "LABEL_ONLY", "DYNAMIC_CALC" ] }, "type":{ "type":"string", "enum":[ "EXISTING", "NONE", "ACCOUNTS", "TIME", "COUNTRY", "ATTRIBUTES" ] }, "updateOption":{ "description":"Incremental dimension build update option. Incremental dimension building is the process of updating existing dimensions by adding, moving, deleting, and reordering members. MERGE (the default) adds new members while retaining existing members. REMOVE_UNSPECIFIED removes members that are not specified in the source (available only when addMemberOption = GENERATION, LEVEL, or PARENT_CHILD). Outlines are invalid if removing members results in level 0 Dynamic Calc members without formulas. RESET_DIMENSION is available only for Index-based rules (i.e., studio = true). Reset Dimension rebuilds the entire dimension. This option enables insert, reorder, move, and delete operations during incremental dimension build, persisting member placement in the hierarchy instead of moving them to the end. To use Reset Dimension, allowMoves should be NOTOK; otherwise, you cannot build shared hierarchies.
Set to OK to allow moving of members and their children to new parents, allowing Essbase to recognize primary members and match them with the source data. Not available for duplicate member outlines. Leave as NOTOK if updateOption = RESET_DIMENSION.
Priority in which the dimension or member is calculated (0 to 127). Higher solve order means the member is calculated later. Members did not assign a solve order inherit it from their dimension.
", "type":"integer", "format":"int32" }, "createAttributeMembers":{ "description":"Set to true to allow Essbase to create attribute members. If false, prevents Essbase from creating attribute members.
", "type":"boolean" }, "share":{ "description":"Set to true if the dimension includes shared members.
", "type":"boolean" }, "incrementalSort":{ "description":"Set to true to sort members after Essbase has processed and added all members from the source data.
", "type":"boolean" }, "autoFixSharedMember":{ "type":"boolean" }, "flexible":{ "type":"boolean" }, "memberName":{ "description":"Parent member name under which to add children. Used with Add as child of build method.
", "type":"string" }, "name":{ "type":"string" }, "dimensionSolveOrder":{ "description":"Solve order of the dimension.
", "type":"integer", "format":"int32" }, "added":{ "description":"Set to true for a new dimension that does not yet exist in the outline. If true, the new dimension will be created during the dimension build. If false, dimension build will fail for a new dimension.
", "type":"boolean" } } }, "DimensionDTO":{ "type":"object", "properties":{ "name":{ "type":"string" }, "stored":{ "type":"boolean" }, "attrBaseDim":{ "type":"string" }, "topSumOfAllStored":{ "type":"boolean" }, "singleTopMember":{ "type":"boolean" }, "denseDimension":{ "type":"boolean" }, "expanded":{ "type":"boolean" }, "weightedAgg":{ "type":"boolean" }, "dimHasAttrAsked":{ "type":"boolean" }, "members":{ "type":"array", "items":{ "$ref":"#/components/schemas/MemberDTO" } }, "weightedAggDim":{ "type":"boolean" }, "isManyToMany":{ "type":"boolean" } } }, "FederatedDataDTO":{ "type":"object", "properties":{ "odometers":{ "type":"array", "items":{ "$ref":"#/components/schemas/OdometerDTO" } }, "hierarchies":{ "type":"array", "items":{ "$ref":"#/components/schemas/Dimension" } }, "queryTimeout":{ "type":"integer", "format":"int32" }, "sequenceNumber":{ "type":"integer", "format":"int32" }, "odometer":{ "type":"array", "writeOnly":true, "items":{ "$ref":"#/components/schemas/OdometerDTO" } }, "isRowPerShared":{ "type":"boolean" } } }, "Generation":{ "required":[ "generationNumber" ], "type":"object", "properties":{ "generationNumber":{ "type":"integer", "format":"int32" }, "columnName":{ "type":"string" } }, "xml":{ "name":"Generation" } }, "MemberDTO":{ "type":"object", "properties":{ "generation":{ "type":"integer", "format":"int32" }, "avHierarchy":{ "type":"integer", "format":"int32" }, "memnoL":{ "type":"integer", "format":"int32" }, "formulaOrder":{ "type":"integer", "format":"int32" }, "baseGeneration":{ "type":"integer", "format":"int32" }, "baseHierarchy":{ "type":"integer", "format":"int32" }, "name":{ "type":"string" }, "formula":{ "type":"string" }, "isNeverAgg":{ "type":"boolean" }, "isOutput":{ "type":"boolean" }, "stored":{ "type":"boolean" } } }, "OdometerDTO":{ "type":"object", "properties":{ "dimensions":{ "type":"array", "items":{ "$ref":"#/components/schemas/DimensionDTO" } }, "fedAvDbmsScheduler":{ "type":"boolean" }, "isCalcComplete":{ "type":"boolean" }, "isProcessNonmissing":{ "type":"boolean" }, "isFedAvInterDepCalc":{ "type":"boolean" }, "selectDOP":{ "type":"string" }, "insertDOP":{ "type":"string" }, "mergeDOP":{ "type":"string" }, "isMultiAssgnPivotCalc":{ "type":"boolean" }, "isPivotCalcPush":{ "type":"boolean" }, "isClassicBottomup":{ "type":"boolean" }, "isFedAvDbmsScheduler":{ "type":"boolean" } } }, "AvDdlDTO":{ "type":"object", "properties":{ "isASO":{ "type":"boolean" }, "isRowPerShared":{ "type":"boolean" }, "dimensions":{ "type":"array", "items":{ "$ref":"#/components/schemas/AvDimDdlDTO" } } } }, "AvDimDdlDTO":{ "type":"object", "properties":{ "name":{ "type":"string" }, "hierarchyToLevelsNumber":{ "type":"array", "items":{ "type":"integer", "format":"int32" } }, "hierarchyToSkipWhenNull":{ "type":"array", "items":{ "type":"boolean" } }, "isManyToManyDim":{ "type":"boolean" }, "isWeightedAggDim":{ "type":"boolean" }, "attrHierarchiesToLevelsNumber":{ "type":"object", "additionalProperties":{ "type":"integer", "format":"int32" } }, "isSkipCreation":{ "type":"boolean" } } }, "CrPartitionSettings":{ "type":"object", "properties":{ "connectionName":{ "type":"string" }, "measureDimensionName":{ "type":"string" }, "mapping":{ "$ref":"#/components/schemas/EssToDsMapDTO" }, "crFactTableName":{ "type":"string" }, "isFactManagedByFederatedCube":{ "type":"boolean" }, "type":{ "type":"string", "enum":[ "CR", "CR2", "DENORMALIZED", "AV" ] } }, "xml":{ "name":"CrPartition" } }, "EssToDsMapDTO":{ "type":"object", "properties":{ "dimensions":{ "type":"array", "items":{ "$ref":"#/components/schemas/Dimension" } }, "pivotDimension":{ "$ref":"#/components/schemas/Dimension" } }, "xml":{ "name":"EssToDsMapDTO" } }, "DenormalizedPartition":{ "type":"object", "properties":{ "dsName":{ "type":"string" }, "measureDimensionName":{ "type":"string" }, "mapping":{ "$ref":"#/components/schemas/EssToDsMapDTO" }, "type":{ "type":"string", "enum":[ "CR", "CR2", "DENORMALIZED", "AV" ] } } }, "UserGroupProvisionInfo":{ "type":"object", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } }, "id":{ "type":"string" }, "name":{ "type":"string" }, "role":{ "type":"string" }, "group":{ "description":"true or false. Whether the id refers to a group.
", "type":"boolean" } }, "xml":{ "name":"permission" } }, "FilterBean":{ "type":"object", "properties":{ "name":{ "type":"string" }, "rows":{ "type":"array", "items":{ "$ref":"#/components/schemas/FilterRow" } }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } } } }, "FilterRow":{ "required":[ "access", "mbrSpec" ], "type":"object", "properties":{ "access":{ "type":"string" }, "mbrSpec":{ "type":"string" } } }, "FilterCopy":{ "required":[ "from", "to" ], "type":"object", "properties":{ "from":{ "type":"string" }, "to":{ "type":"string" } } }, "UserGroupProvisionInfoList":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "format":"int64" }, "count":{ "type":"integer", "format":"int64" }, "limit":{ "type":"integer", "format":"int64" }, "offset":{ "type":"integer", "format":"int64" }, "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/UserGroupProvisionInfo" } }, "hasMore":{ "type":"boolean" }, "properties":{ "type":"object", "additionalProperties":{ "type":"string" } } }, "xml":{ "name":"result" } }, "FilterRowList":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/FilterRow" } }, "count":{ "type":"integer", "format":"int64" }, "totalResults":{ "type":"integer", "format":"int64" }, "hasMore":{ "type":"boolean" }, "limit":{ "type":"integer", "format":"int64" }, "properties":{ "type":"object", "additionalProperties":{ "type":"string" } }, "offset":{ "type":"integer", "format":"int64" } } }, "FilterList":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/FilterBean" } }, "count":{ "type":"integer", "format":"int64" }, "totalResults":{ "type":"integer", "format":"int64" }, "hasMore":{ "type":"boolean" }, "limit":{ "type":"integer", "format":"int64" }, "properties":{ "type":"object", "additionalProperties":{ "type":"string" } }, "offset":{ "type":"integer", "format":"int64" } } }, "GroupBean":{ "type":"object", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } }, "groups":{ "type":"array", "items":{ "type":"string" } }, "role":{ "type":"string" }, "description":{ "type":"string" }, "name":{ "description":"The group name. Limit 256 characters. The following special characters are not permitted: ; , = + * ? [ ] | < > \\ \" ' / Space Tab. Additionally, a period (.) is not permitted in group names.
Comma-separated list of group names associated with this user.
", "type":"array", "items":{ "type":"string" } }, "role":{ "description":"The user role. Valid roles: User, Power User, and Service Administrator.
", "type":"string" }, "password":{ "description":"Password for the user.
", "type":"string" }, "email":{ "type":"string" }, "name":{ "description":"The username. Limit 256 characters. The following special characters are not permitted: ; , = + * ? [ ] | < > \\ \" ' / Space Tab. Additionally, a period (.) is not permitted in group names.
The user ID.
", "type":"string" } }, "xml":{ "name":"User" } }, "Groups":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "format":"int64" }, "count":{ "type":"integer", "format":"int64" }, "limit":{ "type":"integer", "format":"int64" }, "offset":{ "type":"integer", "format":"int64" }, "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/GroupBean" } }, "hasMore":{ "type":"boolean" }, "properties":{ "type":"object", "additionalProperties":{ "type":"string" } } } }, "Users":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "format":"int64" }, "count":{ "type":"integer", "format":"int64" }, "limit":{ "type":"integer", "format":"int64" }, "offset":{ "type":"integer", "format":"int64" }, "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/UserBean" } }, "hasMore":{ "type":"boolean" }, "properties":{ "type":"object", "additionalProperties":{ "type":"string" } } } }, "JobRecordBean":{ "type":"object", "properties":{ "job_ID":{ "type":"integer", "format":"int64" }, "appName":{ "type":"string" }, "dbName":{ "type":"string" }, "jobType":{ "description":"The type of job. Examples: dataload, dimbuild, calc, clear, importExcel, exportExcel, lcmExport, lcmImport, clearAggregation, buildAggregation, asoBufferDataLoad, asoBufferCommit, exportData, mdxScript.
The script file used for the job.
", "type":"string" }, "userName":{ "description":"User who ran the job. Users have access to job listings based on their assigned user role. For example, if you have the Service Administrator role, you can see all jobs; if you have the User role, you can see only the jobs you ran.
", "type":"string" }, "startTime":{ "description":"Start time of the job.
", "type":"integer", "format":"int64" }, "endTime":{ "description":"End time of the job.
", "type":"integer", "format":"int64" }, "statusCode":{ "description":"Job status code indicating progress. Each code has a corresponding statusMessage.
| statusCode | statusMessage |
|---|---|
| 100 | IN_PROGRESS |
| 200 | COMPLETED |
| 300 | COMPLETED_WITH_WARNINGS |
| 400 | FAILED |
Job status message string indicating progress. Each string has a corresponding statusCode.
| statusCode | statusMessage |
|---|---|
| 100 | IN_PROGRESS |
| 200 | COMPLETED |
| 300 | COMPLETED_WITH_WARNINGS |
| 400 | FAILED |
The type of job. Examples: dataload, dimbuild, calc, clear, importExcel, exportExcel, lcmExport, lcmImport, clearAggregation, buildAggregation, asoBufferDataLoad, asoBufferCommit, exportData, mdxScript.
Optional rules file (if the job is a data load or dimension build).
", "type":"string" }, "file":{ "description":"Source file for data load or dimension build. If the file is located somewhere other than the cube directory in the Essbase file catalog, such as in a user or shared directory, prefix the file name with catalog/directory_name/. For example, "file" : "catalog/shared/dataload.txt".
If true, data load stops on the first error. Otherwise, data load continues.
", "type":"string" }, "restructureOption":{ "description":"For dimension build. Preservation options for existing data in the cube. PRESERVE_ALL_DATA: Preserves all existing data blocks (valid for block storage and aggregate storage cubes). PRESERVE_NO_DATA: Discards existing data (valid for block storage and aggregate storage cubes). PRESERVE_LEAFLEVEL_DATA: Preserves existing level zero data (block storage only). PRESERVE_INPUT_DATA: Preserves existing input-level data (block storage only).
", "type":"string" }, "forceDimBuild":{ "description":"For dimension build. If true, continue the dimension build even if other user activities are in progress. This cancels active user sessions.
", "type":"string" }, "script":{ "description":"For calc execution. Calculation script name. Must have .csc file extension. You do not need to give a full path. Files are assumed to be in the relevant cube directory.
", "type":"string" }, "option":{ "description":"For clear data job. Keyword specifying what to clear. Default option, if omitted, is allData. The options for block storage cubes are: allData ??? All data, linked objects, and the outline are cleared. upperLevel ??? Upper-level blocks are cleared. nonInput ??? Non input blocks are cleared. The options for aggregate storage cubes are: allData ??? All data, linked objects, and the outline are cleared. allAggregations ??? All aggregated data is cleared. partialData ??? Only a specified region is cleared (an MDX region specified in partialDataExpression parameter).
", "type":"string" }, "loaddata":{ "description":"For importExcel job type. If true, loads data (if the workbook contains a data worksheet). Otherwise, only metadata is imported into the cube.
", "type":"string" }, "useConnection":{ "description":"For dimbuild or dataload job types. If true, specifies that a saved connection should be used (you must also pass connection parameter indicating the connection name). If false, and the job uses a rules file that connects to an RDBMS, you must specify the username and password to connect to the RDBMS.useConnection
", "type":"string" }, "connection":{ "description":"For dimbuild or dataload job types, when useConnection is true. Name of a saved connection.
", "type":"string" }, "user":{ "description":"For dimbuild or dataload job types, when useConnection is false, and the job uses a rules file that connects to an RDBMS. Name of the user who can connect to the RDBMS.
", "type":"string" }, "password":{ "description":"For dimbuild or dataload job types, when useConnection is false, and the job uses a rules file that connects to an RDBMS. Password of the user who can connect to the RDBMS.
", "type":"string" }, "calc":{ "description":"For exportExcel job type. If true, includes calculation scripts in the export.
", "type":"string" }, "buildMethod":{ "description":"For exportExcel job type. Valid build methods are PARENT-CHILD (the recommended method) and GENERATION.
", "type":"string" }, "data":{ "description":"For exportExcel job type. If true, includes data in the export.
", "type":"string" }, "memberIds":{ "type":"string" }, "zipFileName":{ "description":"For LCMExport and LCMImport job types. Name of compressed file to hold backup files.
", "type":"string" }, "skipdata":{ "description":"For LCMExport job type. If true, do not include data in the backup.
", "type":"string" }, "threads":{ "type":"string" }, "overwrite":{ "description":"For LCMExport and LCMImport job types. If true, overwrite existing backup (for LCMExport) or overwrite existing application (for LCMImport).
", "type":"string" }, "lcmImportFromStorage":{ "description":"For LCMImport job type. If true, import from backup saved on server storage.
", "type":"string" }, "analyzeFileName":{ "type":"string" }, "analyzeSheetName":{ "type":"string" }, "deleteExcelOnSuccess":{ "type":"string" }, "catalogExcelPath":{ "description":"For importExcel job type. Path to application workbook in the file catalog. Use importExcelFileName to specify the file name.
", "type":"string" }, "importExcelFileName":{ "description":"For importExcel job type. File name of application workbook. If not in the cube directory, use catalogExcelPath to specify the path.
", "type":"string" }, "recreateApplication":{ "description":"For importExcel job type. If true, re-create the application if it already exists.
", "type":"string" }, "createFiles":{ "description":"For importExcel job type. If true, create cube artifacts in the cube directory.
", "type":"string" }, "executeScript":{ "description":"For importExcel job type. If true, execute calculation scripts. Applicable only if the application workbook contains a calculation worksheet with Execute Calc set to Yes in the definition.
", "type":"string" }, "buildOption":{ "description":"For importExcel job type. When an application has already been built from a workbook, you can continue to update it by performing additional imports from the workbook. When importing again from a workbook, you can use these incremental-update options: NONE, RETAIN_ALL_DATA or REMOVE_ALL_DATA.
", "type":"string" }, "copyToStorage":{ "description":"For LCMExport job type. If true, save copy of backup on server storage.
", "type":"string" }, "filesystemcopy":{ "type":"string" }, "dataLevel":{ "description":"For exportExcel or exportData job type. Constant indicates how much data is exported. You can pass either the number or the corresponding string value. 0=ALL_DATA, 1=UPPER_LEVEL_BLOCKS, 2=NON_INPUT_BLOCKS, 3=LEVEL_ZERO_BLOCKS, 4=INPUT_LEVEL_DATA_BLOCKS
", "type":"string" }, "columnFormat":{ "description":"For exportExcel or exportData job type. If true, the cube is exported in tabular format; otherwise, it is exported as an application workbook. Exported tabular data contains data and metadata organized into columns with headers that Essbase can use to deploy a new cube. The exported tabular data contains less information than an application workbook.
", "type":"string" }, "targetApplicationName":{ "description":"For LCMImport job type. Optional specification of an application name to import/restore to, if different from the exported/backed up application name.
", "type":"string" }, "partialDataExpression":{ "type":"string" }, "allApp":{ "type":"string" }, "includeServerLevel":{ "description":"For LCMExport and LCMImport job types. If true, include globally defined connections and Datasources as part of the export or import.
", "type":"string", "xml":{ "name":"include-server-level", "attribute":true } }, "enableSandboxing":{ "type":"string" }, "dbType":{ "type":"string" }, "dimDesignationMode":{ "type":"string" }, "unstructuredAnalysis":{ "$ref":"#/components/schemas/CompactDesignation" }, "ratioToStop":{ "description":"For buildAggregation job type. A stopping value. Use this value to give the ratio of the growth size you want to allow during the materialization of an aggregate storage cube, versus the pre-aggregation size of the cube. (Before an aggregation has materialized, the cube contains only input-level data.) For example, if the size of the cube is 1 GB, a stopping value of 1.2 means that the size of the resulting data cannot exceed 20% of 1 GB, for a total size of 1.2 GB. If you do not want to specify a stopping value, enter 0 for this parameter.
", "type":"string" }, "basedOnQueryData":{ "description":"For buildAggregation job type. If true, aggregate whichever views Essbase selects, based on collected user querying patterns. This option is only available if query tracking is turned on.
", "type":"string" }, "enableAlternateRollups":{ "description":"For buildAggregation job type. If true, let Essbase consider secondary hierarchies ('alternate rollups') for view selection.
", "type":"string" }, "compress":{ "description":"For exportExcel or exportData job type. If true, compress the data.
", "type":"string" }, "generateArtifactList":{ "description":"For LCMExport job type. If true, generate a text file list of exported artifacts. You can use the list to control the import; for example, rearranging the order of artifacts to control the import order, or enumerating which items in the list to import.
", "type":"string", "xml":{ "name":"generateartifactlist", "attribute":true } }, "artifactList":{ "description":"For LCMImport job type. Name of artifact list to use (valid only if generateArtifactList was true in the LCMExport job).
", "type":"string" }, "verbose":{ "type":"string" }, "disasterRecovery":{ "type":"string" }, "force":{ "type":"string" }, "backupType":{ "type":"string" }, "appId":{ "type":"string" }, "timestamp":{ "type":"string" }, "maxParallel":{ "type":"string" }, "selectedDimensions":{ "type":"array", "items":{ "type":"string" } }, "rtsv":{ "description":"Runtime substitution variables defined for calc scripts.
", "type":"array", "items":{ "$ref":"#/components/schemas/RTSV" } }, "bufferId":{ "description":"Unique ID of a single aggregate storage data load buffer. Must be a number between 1 and 4294967296. Use either this option or bufferIds option, but not both.
Array of unique aggregate storage data load buffer IDs. Use this option if you want to commit multiple buffers.
", "type":"array", "items":{ "type":"integer", "format":"int32" } }, "commitOption":{ "description":"Integer or keyword describing aggregate storage data load buffer commit options, to specify whether you want to add to existing values, subtract from existing values, or override existing values when committing the contents of the data load buffer to the cube.
STORE_DATA (0) - Store data in the load bufferADD_DATA (1) - Add values in the load buffer to existing stored data valuesSUBTRACT_DATA (2) - Subtract values in the load buffer from existing stored data valuesOVERRIDE_ALL_DATA (3) - Remove the current data values from the cube and replace them with the values in the data load buffer.OVERRIDE_INCREMENTAL_DATA (4) - Remove the current contents of all incremental data slices in the cube and create a new data slice with the contents of the specified data load buffer. The new data is created with the data load property add values (aggregate_sum). If there are duplicate cells between the new data and the primary slice, their values are added together when you query for them.Integer or keyword specifying what to do if there is an error committing the load buffer. COMMIT or 1 - commit anyway. ABORT or 2 - terminate the commit operation.
Integer or keyword specifying final options for committing data slices to the cube from the data load buffer.
INCR_TO_MAIN_SLICE (or 0): Commit the contents of all incremental data slices as a primary (main) slice.INCR_TO_NEW_SLICE (or 1): Replace the contents of all incremental data slices with a new slice.INCR_TO_NEW_SLICE_LIGHTWEIGHT (or 2): Write the data currently stored in the buffer to a new slice in the cube, as a lightweight operation. This option is intended only for small data loads of up to 1,000s of cells that occur concurrently (for example, grid client data-update operations).For exportData job type when columnFormat is true. Include dynamically calculated sparse members in the tabular data export. These are not included by default.
", "type":"string" }, "shadowAppName":{ "description":"Shadow (copied) application name.
", "type":"string" }, "primaryAppName":{ "description":"Main or base (not shadow) application name.
", "type":"string" }, "timeoutToForceUnloadApp":{ "description":"Time interval (in seconds) to wait before forcefully unloading/stopping an application, if it is performing ongoing requests. If a graceful unload process fails or takes longer than permitted by this timeout, Essbase forcefully terminates the application.
", "type":"string" }, "hideShadow":{ "description":"Specify true to hide the shadow application; otherwise, specify false.
", "type":"string" }, "waitForOngoingUpdatesInSecs":{ "description":"Waiting period (in seconds) for any active write-operations to complete.
", "type":"string" }, "reportScriptFilename":{ "type":"string" }, "lockForUpdate":{ "type":"boolean" }, "isScriptContent":{ "type":"boolean" }, "useCatalogPath":{ "type":"boolean" }, "exportdata":{ "type":"boolean" }, "cube":{ "type":"string" }, "filetype":{ "type":"string" }, "exportpartitions":{ "type":"boolean" }, "exportfilters":{ "type":"boolean" }, "backupPath":{ "type":"string" }, "restEncryPassword":{ "type":"string" }, "pivotdimension":{ "type":"string" }, "catalogZipPath":{ "type":"string" }, "physical":{ "type":"boolean" } } }, "RTSV":{ "description":"Details about the runtime substitution variable.
", "type":"object", "properties":{ "name":{ "description":"Name of the runtime substitution variable.
", "type":"string" }, "description":{ "description":"", "type":"string" }, "allowMissing":{ "description":"Set to true to allow data cells for which no data exists, or false to suppress them.
", "type":"boolean" }, "dimension":{ "description":"The name of the dimension from which this variable pulls information. Supported only if type = MEMBER.
", "type":"string" }, "singleChoice":{ "description":"Set to true if only one contextual member selection may be passed to the runtime substitution variable. If there is a single member on the grid or POV, that member is used. If a dimension is on the POV, the active member is used. If a dimension is on the POV and there are multiple members, an error occurs.
Set to false if all dimension members on the grid or the POV are included.
", "type":"boolean" }, "type":{ "description":"Specification of whether the variable is for a member, string, or number.
", "type":"string", "enum":[ "STRING", "NUMBER", "DATE", "MEMBER" ] }, "value":{ "description":"Default value of the runtime substitution variable. RTSV values can be strings, constants, member names, or member combinations.
If the RTSV is designed for calcs executed in Smart View, its value must be set to the constant POV, to indicate that only the current data slice present in the spreadsheet grid should be calculated.
Number of jobs with errors.
", "type":"integer", "format":"int64" }, "succesCt":{ "description":"Number of successful jobs.
", "type":"integer", "format":"int64" }, "warningCt":{ "description":"Number of jobs with warnings.
", "type":"integer", "format":"int64" }, "runningCt":{ "description":"Number of jobs running now.
", "type":"integer", "format":"int64" } } }, "LocationAliasBean":{ "type":"object", "properties":{ "aliasName":{ "description":"Name of the location alias.
", "type":"string" }, "connectionName":{ "description":"If the location alias is based on a saved connection, the name of the connection.
", "type":"string" }, "serverName":{ "description":"If the location alias is not based on a saved connection, the Essbase Server host name of the database/cube to which the location alias refers.
", "type":"string" }, "userName":{ "description":"If the location alias is not based on a saved connection, the name of a user who is authorized to log in to serverName. Optional if both cubes are on the same Essbase Server.
", "type":"string" }, "applicationName":{ "description":"Application name for the database/cube to which the location alias refers.
", "type":"string" }, "databaseName":{ "description":"Name of the database to which the location alias refers.
", "type":"string" }, "applicationLevelConnection":{ "description":"If the location alias is based on a saved connection, this parameter should be true if the connection is application-level, or false if the connection is globally defined.
", "type":"boolean" }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } } } }, "LocationAliasList":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/LocationAliasBean" } }, "offset":{ "type":"integer", "format":"int64" }, "limit":{ "type":"integer", "format":"int64" }, "totalResults":{ "type":"integer", "format":"int64" }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } }, "count":{ "type":"integer", "format":"int64" }, "hasMore":{ "type":"boolean" }, "properties":{ "type":"object", "additionalProperties":{ "type":"string" } } } }, "LockBlock":{ "type":"object", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } }, "user":{ "type":"string" }, "count":{ "type":"integer", "format":"int32" }, "duration":{ "type":"integer", "format":"int32" } } }, "LockBlockList":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/LockBlock" } }, "totalResults":{ "type":"integer", "format":"int64" }, "limit":{ "type":"integer", "format":"int64" }, "offset":{ "type":"integer", "format":"int64" }, "count":{ "type":"integer", "format":"int64" }, "hasMore":{ "type":"boolean" }, "properties":{ "type":"object", "additionalProperties":{ "type":"string" } } } }, "LockObject":{ "type":"object", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } }, "user":{ "type":"string" }, "name":{ "type":"string" }, "type":{ "type":"string", "enum":[ "OUTLINE", "CALCSCRIPT", "REPORT", "RULES", "ALIAS", "STRUCTURE", "ASCBACKUP", "BINBACKUP", "EXCEL", "XLSX", "XLSM", "MAXL", "ZIP", "CSV", "LOTUS2", "LOTUS3", "TEXT", "LOTUS4", "WIZARD", "PARTITION", "SELECTION", "LRO", "EQD", "XML", "JAVA_CDF", "MAX", "BACKUP", "WORKSHEET", "DATA", "ERROR", "OUT", "GROOVY", "DRILLTHROUGH", "ALL", "MDX" ] }, "time":{ "type":"integer", "format":"int64" } } }, "LockObjectList":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/LockObject" } }, "totalResults":{ "type":"integer", "format":"int64" }, "limit":{ "type":"integer", "format":"int64" }, "offset":{ "type":"integer", "format":"int64" }, "count":{ "type":"integer", "format":"int64" }, "hasMore":{ "type":"boolean" }, "properties":{ "type":"object", "additionalProperties":{ "type":"string" } } } }, "About":{ "type":"object", "properties":{ "name":{ "type":"string" }, "version":{ "type":"string" }, "build":{ "type":"string" }, "description":{ "type":"string" }, "listingVersion":{ "type":"string" } }, "xml":{ "name":"about" } }, "AppEncryption":{ "required":[ "type" ], "type":"object", "properties":{ "type":{ "type":"string", "description":"The supported encryption type. The only supported value is OCID, representing Oracle Vault key management.
Required for OCID encryption type. The OCID of the Oracle Vault in OCI.
" }, "masterKeyId":{ "type":"string", "description":"Required for OCID encryption type. The OCID of the Master Encryption Key (MEK) in the Oracle Vault in OCI.
" } } }, "EncryptionConfig":{ "type":"object", "properties":{ "essEncryptionMode":{ "type":"integer", "format":"int32", "xml":{ "name":"EncryptionMode" } }, "types":{ "type":"array", "xml":{ "name":"AvailableTypes" }, "items":{ "type":"string", "xml":{ "name":"AvailableTypes" } } } } }, "CopyRenameBean":{ "required":[ "from", "to" ], "type":"object", "properties":{ "from":{ "type":"string" }, "to":{ "type":"string" } } }, "CubeCopy":{ "required":[ "from", "to" ], "type":"object", "properties":{ "from":{ "type":"string" }, "to":{ "$ref":"#/components/schemas/To" } } }, "To":{ "required":[ "database" ], "type":"object", "properties":{ "database":{ "type":"string" }, "application":{ "type":"string" } } }, "CreateApplication":{ "type":"object", "properties":{ "applicationName":{ "description":"The application name must not exceed 30 characters. Avoid using spaces. Application names are not case-sensitive.
", "type":"string" }, "databaseName":{ "description":"The database (cube) name. The name is not case sensitive. Do not use spaces in the name. Only the following special characters are allowed in the name: %$-{}()!~`#&@^.
true if duplicate member names are permitted. When you enable duplicate member names in an Essbase outline, then member names do not have to be unique. You can have multiple members using the same name in the outline.
", "type":"boolean" }, "enableScenario":{ "description":"true if cubes can be enabled for scenario management. Note that scenario management is supported only for block storage cubes. For aggregate storage cubes, the only supported value for this parameter is false.
", "type":"boolean" }, "memberCount":{ "type":"integer", "format":"int32" }, "databaseType":{ "description":"The type of database (cube) to create. Values: BSO for block storage cube, or ASO for aggregate storage cube.
", "type":"string" }, "memberPrefix":{ "type":"string" }, "appType":{ "type":"string", "enum":[ "native", "utf8" ] }, "dbType":{ "type":"string", "enum":[ "NORMAL", "CURRENCY", "ASO" ] } } }, "ShadowCopyBean":{ "required":[ "hideShadow", "primaryAppName", "shadowAppName", "waitForOngoingUpdatesInSecs" ], "type":"object", "properties":{ "primaryAppName":{ "description":"Name of the primary, non-shadow application.
", "type":"string" }, "shadowAppName":{ "description":"Unique shadow application name which is a copy of the source.
", "type":"string" }, "hideShadow":{ "description":"Specify true to hide the shadow application; otherwise, specify false.
", "type":"boolean" }, "waitForOngoingUpdatesInSecs":{ "description":"Waiting period (in seconds) for any active write-operations to complete.
", "type":"integer", "format":"int32" }, "runInBackground":{ "description":"Specify true to schedule 'Shadow Copy' as a Job; otherwise, specify false.
", "type":"boolean" } } }, "StringCollectionResponse":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "format":"int64" }, "limit":{ "type":"integer", "format":"int64" }, "offset":{ "type":"integer", "format":"int64" }, "items":{ "type":"array", "items":{ "type":"string" } }, "count":{ "type":"integer", "format":"int64" }, "hasMore":{ "type":"boolean" }, "properties":{ "type":"object", "additionalProperties":{ "type":"string" } } }, "xml":{ "name":"Result" } }, "Application":{ "type":"object", "properties":{ "name":{ "type":"string" }, "owner":{ "type":"string" }, "creationTime":{ "type":"integer", "format":"int64" }, "modifiedBy":{ "type":"string" }, "modifiedTime":{ "type":"integer", "format":"int64" }, "status":{ "type":"string" }, "description":{ "type":"string" }, "type":{ "type":"string", "enum":[ "ASO", "BSO", "CURRENCY" ] }, "startTime":{ "type":"integer", "format":"int64" }, "connectedUsersCount":{ "description":"The number of users currently connected to the application.
", "type":"integer", "format":"int32" }, "role":{ "type":"string" }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } }, "easManagedApp":{ "description":"If true, the application is managed in Essbase Administration Services (EAS) Lite instead of the Essbase web interface. Before you can connect to an application in EAS Lite, you must set it as an EAS managed application. The Essbase web interface is the modern administration interface that supports all current platform features, but EAS Lite is available as a limited-option alternative available only for Essbase 21c independent deployment.
", "type":"boolean" }, "startStopAppAllowed":{ "description":"true if users who have at least read permission can start the application.
", "type":"boolean" }, "inspectAppAllowed":{ "type":"boolean" }, "appVariablesSetting":{ "$ref":"#/components/schemas/VariablesSetting" }, "encrypted":{ "type":"boolean" }, "aiConnection":{ "type":"string" } } }, "VariablesSetting":{ "type":"object", "properties":{ "showVariables":{ "type":"boolean" }, "updateVariables":{ "type":"boolean" } } }, "ApplicationList":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/Application" } }, "totalResults":{ "type":"integer", "format":"int64" }, "limit":{ "type":"integer", "format":"int64" }, "offset":{ "type":"integer", "format":"int64" }, "count":{ "type":"integer", "format":"int64" }, "hasMore":{ "type":"boolean" }, "properties":{ "type":"object", "additionalProperties":{ "type":"string" } } } }, "Cube":{ "type":"object", "properties":{ "name":{ "type":"string" }, "application":{ "type":"string" }, "owner":{ "type":"string" }, "creationTime":{ "type":"integer", "format":"int64" }, "modifiedBy":{ "type":"string" }, "modifiedTime":{ "type":"integer", "format":"int64" }, "status":{ "type":"string" }, "startTime":{ "type":"integer", "format":"int64" }, "description":{ "type":"string" }, "type":{ "type":"string", "enum":[ "ASO", "BSO", "CURRENCY" ] }, "applicationRole":{ "type":"string" }, "easManagedApp":{ "description":"If true, the application is managed in Essbase Administration Services (EAS) Lite instead of the Essbase web interface. EAS Lite is available as a limited-option alternative available only for Essbase 21c independent deployment.
", "type":"boolean" }, "startStopDBAllowed":{ "type":"boolean" }, "inspectDBAllowed":{ "type":"boolean" }, "dbVariablesSetting":{ "$ref":"#/components/schemas/VariablesSetting" }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } } } }, "CubeList":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/Cube" } }, "count":{ "type":"integer", "format":"int64" }, "totalResults":{ "type":"integer", "format":"int64" }, "hasMore":{ "type":"boolean" }, "limit":{ "type":"integer", "format":"int64" }, "properties":{ "type":"object", "additionalProperties":{ "type":"string" } }, "offset":{ "type":"integer", "format":"int64" } } }, "ShadowPromoteBean":{ "required":[ "primaryAppName", "shadowAppName", "timeoutToForceUnloadApp" ], "type":"object", "properties":{ "shadowAppName":{ "description":"Unique shadow application name which is a copy of the source.
", "type":"string" }, "primaryAppName":{ "description":"Name of the primary, non-shadow application.
", "type":"string" }, "timeoutToForceUnloadApp":{ "description":"Time interval (in seconds) to wait before forcefully unloading/stopping an application, if it is performing ongoing requests. If a graceful unload process fails or takes longer than permitted by this timeout, Essbase forcefully terminates the application.
", "type":"integer", "format":"int32" }, "runInBackground":{ "description":"Specify true to schedule 'Shadow Promote' as a Job; otherwise, specify false.
", "type":"boolean" } } }, "CurrencySettings":{ "type":"object", "properties":{ "currencyDatabase":{ "description":"The currency cube. By assigning currency tags to members in the main cube outline, you enable Essbase to generate the currency cube automatically. In the Sample_Currency application, the currency cube is Xchgrate.
In a currency cube, the optional currency type dimension that enables different scenarios for currency conversion. Typically, a cube has different exchange rates for different scenarios, such as actual, budget, and forecast. To convert data between scenarios, you select which type of rate to use.
", "type":"string" }, "countryMemberName":{ "description":"For currency databases, the country dimension.
", "type":"string" }, "timeMemberName":{ "description":"For currency databases, the time dimension.
", "type":"string" }, "categoryMemberName":{ "description":"For currency databases, the accounts dimension where currency categories are defined.
", "type":"string" }, "partitionMemberName":{ "description":"Optional. The name of dimension designated as the currency partition. This dimension contains members for both local and base values, and holds the data that users input in their own currencies. The local data is converted to the base data using currency conversion calculation scripts.
", "type":"string" } } }, "BOEOutput":{ "type":"object", "properties":{ "messages":{ "type":"string" } } }, "OtlEditMain":{ "type":"object", "properties":{ "editActions":{ "description":"The outline editing action to perform. See example for details on each.
Whether to validate the outline: true or false
Whether to validate formulas: true or false
Whether to keep transactions: true or false
Restructure option. ALL_DATA to preserve all existing data (this is the default), NO_DATA to discard all existing data, LOW_DATA to preserve existing level 0 blocks (applicable to block storage only), IN_DATA to preserve existing input-level blocks (applicable to block storage only).
true if the virus scanner is enabled; false otherwise.
", "type":"boolean" }, "host":{ "description":"Host for the virus scanner ICAP server.
", "type":"string" }, "port":{ "description":"Port for the virus scanner ICAP server.
", "type":"integer", "format":"int32" } } }, "ResetPasswordBean":{ "type":"object", "properties":{ "oldPassword":{ "type":"string" }, "newPassword":{ "type":"string" } }, "xml":{ "name":"ResetPassword" } }, "Resource":{ "type":"object", "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" }, "description":{ "type":"string" }, "provider":{ "type":"string" }, "path":{ "type":"string" }, "mimeType":{ "type":"string" }, "category":{ "type":"string" }, "url":{ "type":"string" }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } } } }, "ResourceList":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/Resource" } }, "count":{ "type":"integer", "format":"int64" }, "totalResults":{ "type":"integer", "format":"int64" }, "hasMore":{ "type":"boolean" }, "limit":{ "type":"integer", "format":"int64" }, "properties":{ "type":"object", "additionalProperties":{ "type":"string" } }, "offset":{ "type":"integer", "format":"int64" } } }, "DataLoadBuffer":{ "type":"object", "properties":{ "bufferId":{ "description":"Unique ID of a single aggregate storage data load buffer. Must be a number between 1 and 4294967296.
", "type":"integer", "format":"int64" }, "duplicateAggregationMethod":{ "description":"Select an option to resolve cell conflicts for duplicate cells in the aggregate storage data load buffer.
ADD: (Default) Add values when the buffer contains multiple values for the same cell.ASSUME_EQUAL: Treat duplicate values as equal. USE_LAST: Combine duplicate cells by using the value of the cell that was loaded last into the data load buffer.Select an option to determine how missing and zero values in the aggregate storage data load buffer should be handled.
IGNORE_NONE(0): Do not ignore any values in the incoming data streamIGNORE_MISSING_VALUES(1): Ignore #MI values in the incoming data streamIGNORE_ZERO_VALUES(2): Ignore zero values in the incoming data streamIGNORE_MISSING_AND_ZERO_VALUES(3): Ignore #MI and zero values in the incoming data streamWhether to suppress columns containing only data derived from a calculation.
", "type":"boolean" }, "invalid":{ "description":"Whether to suppress columns that contain only invalid values -- cells that are empty only because they are not associated with the context attribute or varying attribute.
", "type":"boolean" }, "zero":{ "description":"Whether to suppress columns that contain only zeroes.
", "type":"boolean" }, "missing":{ "description":"Whether to suppress columns containing only #Missing values.
", "type":"boolean" }, "emptyBlocks":{ "description":"Whether to suppress columns containing only cells for which no data exists in the database.
", "type":"boolean" }, "underScore":{ "description":"Whether to suppress columns that contain underscore characters in member names.
", "type":"boolean" }, "noAccess":{ "description":"Whether to suppress columns containing only values that you do not have the security access to view.
", "type":"boolean" }, "error":{ "type":"boolean" } } }, "FormulaRetention":{ "type":"object", "properties":{ "comments":{ "type":"boolean" }, "zoom":{ "type":"boolean" }, "focus":{ "type":"boolean" }, "retrive":{ "type":"boolean" }, "fill":{ "type":"boolean" } } }, "Preferences":{ "type":"object", "properties":{ "maxRows":{ "type":"integer", "format":"int64" }, "repeatMemberLabels":{ "description":"Whether to repeat member labels in each row or column cell that represents a data point. Setting to true can help with legibility in large grids that require scrolling.
", "type":"boolean" }, "cellText":{ "type":"boolean" }, "zoomIn":{ "description":"Zoom-In options.
", "$ref":"#/components/schemas/ZoomIn" }, "navigate":{ "type":"boolean" }, "withinSelectedGroup":{ "description":"Perform ad hoc operations only on the selected group of cells, leaving unselected cells as is. This setting is meaningful only when there are two or more dimensions down the grid as rows or across the grid as columns. For Zoom, Keep Only, and Remove Only.
", "type":"boolean" }, "removeUnSelectedGroup":{ "description":"For Zoom In or Zoom Out, remove all dimensions and members except the selected member and the members retrieved as a result of zooming.
", "type":"boolean" }, "noAccessText":{ "description":"The string displayed when you do not have the proper security access to view a data value. Default is #NoAccess.
", "type":"string" }, "indentation":{ "description":"How hierarchy levels are indented. NONE: No indentation. SUBITEMS: Indent descendants. Ancestors are left-justified in the column. TOTALS: Indent ancestors. Descendants are left-justified in the column.
", "type":"string", "enum":[ "NONE", "SUBITEMS", "TOTALS" ] }, "rowSupression":{ "description":"Row suppression options.
", "$ref":"#/components/schemas/RowSuppression" }, "rowSuppression":{ "$ref":"#/components/schemas/RowSuppression" }, "columnSupression":{ "description":"Column suppression options.
", "$ref":"#/components/schemas/ColumnSuppression" }, "includeSelection":{ "description":"Display the selected member and the members retrieved as a result of the operation.
", "type":"boolean" }, "includeDescriptionLabel":{ "type":"boolean" }, "missingText":{ "description":"The string displayed for cells that have no data value. Default is #Missing.
", "type":"string" }, "formulaRetention":{ "$ref":"#/components/schemas/FormulaRetention" }, "maxColumns":{ "type":"integer", "format":"int64" } } }, "RowSuppression":{ "type":"object", "properties":{ "derived":{ "description":"Whether to suppress rows containing only data derived from a calculation.
", "type":"boolean" }, "invalid":{ "description":"Whether to suppress rows that contain only invalid values -- cells that are empty only because they are not associated with the context attribute or varying attribute.
", "type":"boolean" }, "zero":{ "description":"Whether to suppress rows that contain only zeroes.
", "type":"boolean" }, "missing":{ "description":"Whether to suppress rows containing only #Missing values.
", "type":"boolean" }, "emptyBlocks":{ "description":"Whether to suppress rows containing only cells for which no data exists in the database.
", "type":"boolean" }, "underScore":{ "description":"Whether to suppress rows that contain underscore characters in member names.
", "type":"boolean" }, "noAccess":{ "description":"Whether to suppress rows containing only values that you do not have the security access to view.
", "type":"boolean" }, "error":{ "type":"boolean" } } }, "ZoomIn":{ "type":"object", "properties":{ "ancestor":{ "type":"string", "enum":[ "top", "bottom" ] }, "mode":{ "type":"string", "enum":[ "children", "descendants", "base" ] } } }, "Data":{ "type":"object", "properties":{ "ranges":{ "type":"array", "items":{ "$ref":"#/components/schemas/GridRange" } } } }, "Grid":{ "type":"object", "properties":{ "alias":{ "description":"The active alias table for the grid.
", "type":"string" }, "slice":{ "description":"The part of the grid that contains columns, rows and data.
", "$ref":"#/components/schemas/Slice" }, "dimensions":{ "description":"The part of the grid that describes the included Essbase dimensions and their locations.
", "type":"array", "items":{ "$ref":"#/components/schemas/GridDimension" } } } }, "GridDimension":{ "description":"Dimension object array describing the position of a dimension. Includes name, column, row, and pov. If column = 0, the dimension is located at 0th column in grid. If row = 1, it is located at first row in the grid. If the dimension contains a POV, then that dimension is marked with the pov filter. In the following example, Product (100-10), Market (New York), and Scenario (Actual) are in the POV, Measures (Sales) is on columns, and Year (Jan) is on rows.
| 100-10 | New York | Actual | |
|---|---|---|---|
| Sales | |||
| Jan | 1052 |
Column location of the dimension in the grid.
", "type":"integer", "format":"int32" }, "row":{ "description":"Row location of the dimension in the grid.
", "type":"integer", "format":"int32" }, "pov":{ "description":"If dimension is in the POV, the member name. POV is point of view: the starting context or scope for the grid.
", "type":"string" }, "expanded":{ "type":"boolean" }, "displayName":{ "type":"string" }, "name":{ "description":"Dimension name.
", "type":"string" }, "hidden":{ "type":"boolean" } } }, "GridRange":{ "type":"object", "properties":{ "types":{ "description":"Data types of the cells.
0: text2: double7: emptyCell statuses. Cell status is additional information that may be returned for a cell value. DC: Dynamic Calc. RO: Read Only. CM: Calculated Member. LO: Linked Object.
", "type":"array", "items":{ "type":"string" } }, "enumIds":{ "type":"array", "items":{ "type":"string" } }, "texts":{ "description":"Cell comments.
", "type":"array", "items":{ "type":"string" } }, "dataFormats":{ "description":"Data formats, if format strings are applied.
", "type":"array", "items":{ "type":"string" } }, "values":{ "description":"Cell values, in single-dimension format.
", "type":"array", "items":{ "type":"string" } }, "end":{ "description":"Number of elements in the grid range.
", "type":"integer", "format":"int32" }, "start":{ "description":"Start of the grid range. 0 by default.
", "type":"integer", "format":"int32" } } }, "Slice":{ "description":"The part of the grid that contains columns, rows and data.
", "type":"object", "properties":{ "columns":{ "description":"Number of columns in the grid.
", "type":"integer", "format":"int32" }, "dirtyCells":{ "description":"Array of indexes marking which values are changed. Required for submit action.
", "type":"array", "items":{ "type":"integer", "format":"int32" } }, "dirtyTexts":{ "description":"Array of indexes marking which cell comments are changed.
", "type":"array", "items":{ "type":"integer", "format":"int32" } }, "rows":{ "description":"Number of rows in the grid.
", "type":"integer", "format":"int32" }, "data":{ "description":"Grid data, consisting of ranges. Ranges contain values, types, texts, statuses, enumIds, data, and dataFormats.
", "$ref":"#/components/schemas/Data" } } }, "GridOperation":{ "description":"Grid operation to perform, specifying the grid, action, coordinates, and ranges.
", "type":"object", "properties":{ "grid":{ "description":"Grid object containing dimensions, the position of each dimension, and the slice consisting of data.
", "$ref":"#/components/schemas/Grid" }, "action":{ "type":"string", "enum":[ "zoomin", "zoomout", "keeponly", "removeonly", "refresh", "pivot", "pivotToPOV", "submit" ] }, "alias":{ "description":"The active alias table for the grid.
", "type":"string" }, "coordinates":{ "description":"Coordinates array for grid operation. Specify using syntax \"coordinates\": [index], where index describes a cell position, starting with 0 for the upper-left-most cell, and counting left to right, row by row.
Range object used for zoomin, zoomout, keeponly, and removeonly grid operations. Specify one or more ranges as an array using the syntax: \"ranges\": [rowNo,colNo,noOfRows,noOfCols], where the first argument is row number (start at 0), the second argument is column (start at 0), third argument is number of rows, and the fourth argument is number of columns.
Query object with a valid MDX query as its string value.
", "type":"string" } } }, "HPA":{ "type":"object", "properties":{ "maxFileCount":{ "type":"integer", "format":"int64" }, "interval":{ "type":"integer", "format":"int64" }, "enabled":{ "type":"boolean" } } }, "PerformanceFile":{ "type":"object", "properties":{ "name":{ "type":"string" }, "lastmodifiedMillis":{ "type":"integer", "format":"int64" }, "size":{ "type":"integer", "format":"int64" } } }, "PerformanceFiles":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/PerformanceFile" } }, "count":{ "type":"integer", "format":"int64" }, "totalResults":{ "type":"integer", "format":"int64" }, "hasMore":{ "type":"boolean" }, "limit":{ "type":"integer", "format":"int64" }, "properties":{ "type":"object", "additionalProperties":{ "type":"string" } }, "offset":{ "type":"integer", "format":"int64" } } }, "Layout":{ "type":"object", "properties":{ "header":{ "description":"Header information about the layout. Includes its name, the user who created it, whether it is the default layout for the cube, and whether it is the default layout for this user.
", "$ref":"#/components/schemas/LayoutHeader" }, "spec":{ "description":"Layout specification object containing information about the dimensions and data in the layout.
", "$ref":"#/components/schemas/LayoutSpec" } } }, "LayoutData":{ "type":"object", "properties":{ "values":{ "type":"array", "items":{ "type":"array", "items":{ "type":"string" } } }, "types":{ "type":"array", "items":{ "type":"array", "items":{ "type":"string" } } }, "texts":{ "type":"array", "items":{ "type":"array", "items":{ "type":"string" } } }, "dataFormats":{ "type":"array", "items":{ "type":"array", "items":{ "type":"string" } } }, "statuses":{ "type":"array", "items":{ "type":"array", "items":{ "type":"string" } } }, "filters":{ "type":"array", "items":{ "type":"array", "items":{ "type":"string" } } }, "enumIds":{ "type":"array", "items":{ "type":"array", "items":{ "type":"string" } } } } }, "LayoutDimension":{ "type":"object", "properties":{ "name":{ "type":"string" }, "displayName":{ "type":"string" }, "page":{ "type":"integer", "format":"int32" }, "hidden":{ "type":"boolean" }, "expanded":{ "type":"boolean" }, "axis":{ "type":"string", "enum":[ "Column", "Row", "POV" ] }, "position":{ "type":"integer", "format":"int32" } } }, "LayoutGrid":{ "type":"object", "properties":{ "alias":{ "description":"The active alias table for the grid.
", "type":"string" }, "dimensions":{ "type":"array", "items":{ "$ref":"#/components/schemas/LayoutDimension" } }, "data":{ "$ref":"#/components/schemas/LayoutData" } } }, "LayoutHeader":{ "type":"object", "properties":{ "name":{ "type":"string" }, "user":{ "type":"string" }, "databaseDefault":{ "type":"boolean" }, "userDefault":{ "type":"boolean" }, "session":{ "type":"boolean" } } }, "LayoutPreferences":{ "type":"object", "properties":{ "indentation":{ "type":"string", "enum":[ "NONE", "SUBITEMS", "TOTALS" ] }, "rowSuppression":{ "$ref":"#/components/schemas/Suppression" }, "columnSuppression":{ "$ref":"#/components/schemas/Suppression" }, "cellText":{ "type":"boolean" }, "zoomIn":{ "$ref":"#/components/schemas/ZoomIn" }, "navigate":{ "type":"boolean" }, "includeSelection":{ "type":"boolean" }, "repeatMemberLabels":{ "type":"boolean" }, "withinSelectedGroup":{ "type":"boolean" }, "removeUnSelectedGroup":{ "type":"boolean" }, "includeDescriptionLabel":{ "type":"boolean" }, "missingText":{ "type":"string" }, "noAccessText":{ "description":"The string displayed when you do not have the proper security access to view a data value. Default is #NoAccess.
", "type":"string" }, "maxRows":{ "type":"integer", "format":"int32" }, "formulaRetention":{ "$ref":"#/components/schemas/FormulaRetention" } } }, "LayoutSpec":{ "type":"object", "properties":{ "description":{ "type":"string" }, "grid":{ "$ref":"#/components/schemas/LayoutGrid" }, "preferences":{ "$ref":"#/components/schemas/LayoutPreferences" } } }, "Suppression":{ "type":"object", "properties":{ "missing":{ "type":"boolean" }, "invalid":{ "type":"boolean" }, "derived":{ "type":"boolean" }, "zero":{ "type":"boolean" }, "underScore":{ "type":"boolean" }, "noAccess":{ "type":"boolean" }, "emptyBlocks":{ "type":"boolean" }, "error":{ "type":"boolean" } } }, "LayoutMetadata":{ "type":"object", "properties":{ "name":{ "type":"string" }, "user":{ "type":"string" }, "userDefault":{ "type":"boolean" }, "dbDefault":{ "type":"boolean" }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } } } }, "Layouts":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int64" }, "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/LayoutMetadata" } }, "totalResults":{ "type":"integer", "format":"int64" }, "hasMore":{ "type":"boolean" }, "limit":{ "type":"integer", "format":"int64" }, "properties":{ "type":"object", "additionalProperties":{ "type":"string" } }, "offset":{ "type":"integer", "format":"int64" } } }, "DefaultLayoutBean":{ "type":"object", "properties":{ "userDefault":{ "type":"boolean" }, "databaseDefault":{ "type":"boolean" } } }, "MDXInput":{ "type":"object", "properties":{ "query":{ "type":"string" }, "preferences":{ "$ref":"#/components/schemas/NamedQueriesPreferences" } } }, "NamedQueriesPreferences":{ "type":"object", "properties":{ "dataless":{ "description":"Set to true to omit data values from the output set. Default is false.
", "type":"boolean" }, "hideRestrictedData":{ "description":"Set to true to hide the restricted cell data in the output.
", "type":"boolean" }, "cellAttributes":{ "description":"Set to true to enable query result to return a set of metadata attributes besides the actual data value.
", "type":"boolean" }, "formatString":{ "description":"Set to true to return the formatted values for cells of type text or date, or cells associated with a format string. Default is true.
", "type":"boolean" }, "formatValues":{ "description":"Set to true to return the formatted values for cells.
", "type":"boolean" }, "meaninglessCells":{ "description":"Set to true to suppress the meaningless cell data in the output. For example, missing or structurally irrelevant cells.
", "type":"boolean" }, "textList":{ "description":"Set to true to return a comma-separated list of all text values associated with the cell in the output.
", "type":"boolean" }, "urlDrillThrough":{ "description":"Set to true to add URLs to each applicable cell so users can click through to the source data. This works only if the Essbase drill-through links are configured.
", "type":"boolean" }, "memberIdentifierType":{ "description":"Specify whether metadata in the output should refer to member names, member aliases, or unique member names (in case of duplicate member enabled outlines).
", "type":"string", "enum":[ "NAME", "ALIAS", "UNIQUE_NAME" ] }, "aliasTableName":{ "description":"When the memberIdentifierType: ALIAS and the aliasTable are set to a valid alias table name, the resulting mdx grid contains member names from the specified table. If the value of this property is not set then names are picked from the Default alias table.
", "type":"string" } } }, "NamedQuery":{ "type":"object", "properties":{ "name":{ "type":"string" }, "type":{ "type":"string", "enum":[ "MDX", "DATA_SOURCE" ] }, "query":{ "$ref":"#/components/schemas/Query" } } }, "Query":{ "type":"object", "properties":{ "description":{ "type":"string" }, "spec":{ "type":"string" }, "preferences":{ "$ref":"#/components/schemas/NamedQueriesPreferences" }, "nlq":{ "type":"string" } } }, "Queries":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int64" }, "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/QueryMetadata" } }, "totalResults":{ "type":"integer", "format":"int64" }, "hasMore":{ "type":"boolean" }, "limit":{ "type":"integer", "format":"int64" }, "properties":{ "type":"object", "additionalProperties":{ "type":"string" } }, "offset":{ "type":"integer", "format":"int64" } } }, "QueryMetadata":{ "type":"object", "properties":{ "name":{ "type":"string" }, "type":{ "type":"string", "enum":[ "MDX", "DATA_SOURCE" ] }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } }, "description":{ "type":"string" }, "aiGenerated":{ "type":"boolean" } } }, "QueryTrackingInputs":{ "type":"object", "properties":{ "fileName":{ "type":"string" } } }, "CompressionInfoOutput":{ "type":"object", "properties":{ "message":{ "type":"string" }, "compressionInfo":{ "type":"array", "items":{ "$ref":"#/components/schemas/EssbaseASODbCompression" } } } }, "EssbaseASODbCompression":{ "type":"object", "properties":{ "name":{ "type":"string", "xml":{ "name":"n", "attribute":true } }, "artifactType":{ "type":"integer", "format":"int32", "xml":{ "name":"aft", "attribute":true } }, "nodeName":{ "type":"string", "xml":{ "name":"node", "attribute":true } }, "appName":{ "type":"string", "xml":{ "name":"app", "attribute":true } }, "dbName":{ "type":"string", "xml":{ "name":"db", "attribute":true } }, "locked":{ "type":"boolean", "xml":{ "name":"lck", "attribute":true } }, "lockedByUser":{ "type":"string", "xml":{ "name":"lu", "attribute":true } }, "dimensionName":{ "description":"Each dimension name in the cube, hypothetically considered to be the compression dimension.
", "type":"string" }, "isCompression":{ "description":"Indicates whether the dimension is the ASO compression dimension. There can be only one compression dimension in an ASO cube.
", "type":"boolean" }, "storedLevel0Members":{ "description":"The number of leaf-level members in the dimension. A large number of stored level-0 members in a dimension indicates that it may not perform well as a compression dimension.
", "type":"number", "format":"double" }, "averageBundleFill":{ "description":"Estimated average number of values per compression dimension bundle. Choosing a compression dimension that has a higher average bundle fill means that the cube compresses better.
", "type":"number", "format":"double" }, "averageValueLength":{ "description":"Estimated average number of bytes required to store a value. Dimensions with a smaller average value length compress the cube better.
", "type":"number", "format":"double" }, "level0MB":{ "description":"Estimated size of the compressed cube, in megabytes. A smaller expected level-0 size indicates that choosing this dimension enables better compression.
Except for the scenario in which there is no compression dimension (None), all estimates assume that all pages are compressed. As compressed pages require additional overhead that uncompressed pages do not, the estimated level-0 cube size for some dimensions may be larger than the value for None.
Retrieval buffer size allocated per retrieval request
", "type":"integer", "format":"int64" }, "dataRetrievalSortBufferSize":{ "description":"Retrieval sort buffer size allocated per retrieval request
", "type":"integer", "format":"int64" } }, "xml":{ "name":"buffers" } }, "CacheSettings":{ "type":"object", "properties":{ "cacheMemoryLocking":{ "description":"Deprecated, along with direct I/O
", "type":"boolean" }, "indexCacheSetting":{ "description":"The index cache size (in KB) setting value currently in effect
", "type":"integer", "format":"int64" }, "indexCacheCurrentValue":{ "description":"Run-time size (in KB) of the index cache
", "type":"integer", "format":"int64" }, "dataFileCacheSetting":{ "description":"The data file cache size setting value currently in effect
", "type":"integer", "format":"int64" }, "dataFileCacheCurrentValue":{ "description":"The run-time data file cache size (in KB) currently in use by the cube. Once you have changed the data file cache size, you must stop and restart the cube for the new data file cache size to take effect.
", "type":"integer", "format":"int64" }, "dataCacheSetting":{ "description":"The data cache size setting value (in KB) currently in effect
", "type":"integer", "format":"int64" }, "dataCacheCurrentValue":{ "description":"The run-time size (in KB) of the data cache
", "type":"integer", "format":"int64" }, "indexPageSetting":{ "description":"The index page size setting (in KB) currently in effect
", "type":"integer", "format":"int32" }, "indexPageCurrentValue":{ "description":"Run-time size (in KB) of an index page
", "type":"integer", "format":"int32" } }, "xml":{ "name":"caches" } }, "CalculationSettings":{ "type":"object", "properties":{ "aggregateMissingValues":{ "description":"If true, aggregate #MISSING values along with the regular cube consolidation. The default is false (missing values are not aggregated).
", "type":"boolean" }, "createBlocksOnEquations":{ "description":"Force creation of data blocks on constant assignment calc equations (only valid for sparse dimensions). If true, blocks are created.
", "type":"boolean" }, "twoPassCalculation":{ "description":"Force two pass calculation when running a full calculation (true if two pass calculation is enabled)
", "type":"boolean" } }, "xml":{ "name":"calculation" } }, "CompressionSettings":{ "description":"Estimated compression statistics for an aggregate storage cube, with different dimensions hypothetically used as the compression dimension. These estimates can help you choose the best compression dimension.
", "type":"object", "properties":{ "isCompression":{ "description":"Whether this is an aggregate storage compression dimension. By default, the compression dimension is the Accounts dimension. There can be only one compression dimension in an aggregate storage cube.
", "type":"boolean" }, "storedLevel0Members":{ "description":"Number of stored level 0 members. Aggregate storage compression dimensions with a large number of stored level 0 members do not perform optimally. As with any dynamically calculated dimension, upper-level retrievals from compression dimensions are slower.
", "type":"number", "format":"double" }, "averageBundleFill":{ "description":"Applies to aggregate storage cubes only. Estimated average number of values per compression dimension bundle. Choosing a compression dimension that has a higher average bundle fill means that the cube compresses better.
", "type":"number", "format":"double" }, "averageValueLength":{ "description":"Estimated average number of bytes required to store a value. Dimensions with a smaller average value length compress the cube better.
", "type":"number", "format":"double" }, "level0MB":{ "description":"Estimated size of the compressed cube, in megabytes. A smaller expected level-0 size indicates that choosing this dimension enables better compression. Except for the scenario in which there is no compression dimension (None), all estimates assume that all pages are compressed. Since compressed pages require additional overhead that uncompressed pages do not, the estimated level-0 database size for some dimensions may be larger than the value for None.
", "type":"number", "format":"double" }, "dimensionName":{ "description":"Dimension name hypothetically considered to be the aggregate storage compression dimension, for purposes of estimating compression statistics.
", "type":"string" } } }, "AttributeOutlineSettings":{ "description":"Specifications for handling member names in attribute dimensions.
", "type":"object", "properties":{ "prefixSuffixValue":{ "description":"A prefix or suffix value to use for attribute member names as needed to support member name uniqueness.Values: NONE, PARENT, GRANDANDPARENT, ALLANCESTORS, DIMENSION
Separator character between the prefix or suffix and the attribute member name. Values: UNDERSCORE, PIPE, CARET
If unique names are required for member names in Boolean, date, and numeric attribute dimensions in the outline, set prefixSuffixValue to something other than NONE and set this value to select a prefix or a suffix. Values: PREFIX or SUFFIX.
Name for True members in Boolean attribute dimensions.
", "type":"string" }, "falseMemberName":{ "description":"Name for False members in Boolean attribute dimensions.
", "type":"string" }, "dateMemberNames":{ "description":"Date member format in attribute dimensions. Values: MMDDYYYY for Month first or DDMMYYYY for day first.
Date range setting for numeric attribute dimensions. Values: UPPER_BOUND_INCLUSIVE, LOWER_BOUND_INCLUSIVE, UPPER_BOUND_NON_INCLUSIVE, LOWER_BOUND_NON_INCLUSIVE
The name of the attribute calculations dimension.
", "type":"string" }, "calcSumMember":{ "description":"In an attribute calculations dimension, the name to use when requesting sum data.
", "type":"string" }, "calcCountMember":{ "description":"In an attribute calculations dimension, the name to use when requesting count data.
", "type":"string" }, "calcMinimumMember":{ "description":"In an attribute calculations dimension, the name to use when requesting minimum data.
", "type":"string" }, "calcMaximumMember":{ "description":"In an attribute calculations dimension, the name to use when requesting maximum data.
", "type":"string" }, "calcAverageMember":{ "description":"In an attribute calculations dimension, the name to use when requesting average data.
", "type":"string" } }, "xml":{ "name":"attributes" } }, "GeneralOutlineSettings":{ "type":"object", "properties":{ "caseSensitiveMembers":{ "type":"boolean" }, "outlineType":{ "type":"string" }, "allowDuplicateMemberNames":{ "description":"true if duplicate member names were enabled at outline creation time, and false otherwise (member names must be unique).
true if typed measures are enabled, and false otherwise. The default is true. Typed measures include date measures and text lists. Both extend the capabilities of Essbase beyond numerical data to text- and date-based analytics.
Date format displayed in queries on date measures (if typed measures are enabled and date measures are implemented). For example: mm/dd/yyyy. Refer to otlUpdate action in Run Batch Outline Edit.
Ratio of the number of requests answered from aggregate storage cache as opposed to from the hard disk. May not be accurate when parallel data load or parallel calculation operations are in use.
", "type":"number", "format":"double" }, "currentCacheSize":{ "description":"The current size of the aggregate storage cache. See also currentCacheSizeLimit.
", "type":"number", "format":"double" }, "currentCacheSizeLimit":{ "description":"The maximum size (in kilobytes) to which the aggregate storage cache may grow.
", "type":"number", "format":"double" }, "pageReadsSinceLastStartup":{ "description":"For an aggregate storage cube, number of data pages read from disk since the last time the application was started.
", "type":"number", "format":"double" }, "pageWritesSinceLastStartup":{ "description":"For an aggregate storage cube, number of data pages written to disk since the last time the application was started.
", "type":"number", "format":"double" }, "pageSize":{ "description":"For an aggregate storage cube, size of the data page in kilobytes.
", "type":"number", "format":"double" }, "diskSpaceAllocatedForData":{ "description":"For an aggregate storage cube, total space used by all disk files in the default tablespace.
", "type":"number", "format":"double" }, "diskSpaceUsedByData":{ "description":"For an aggregate storage cube, total space actually in use within the disk files in the default tablespace (some space within files may be free).
", "type":"number", "format":"double" }, "temporaryDiskSpaceAllocated":{ "description":"For an aggregate storage cube, total space used by all disk files in the temp tablespace.
", "type":"number", "format":"double" }, "temporaryDiskSpaceUsed":{ "description":"For an aggregate storage cube, total space actually in use within the disk files in the temp tablespace (some space within files may be free).
", "type":"number", "format":"double" }, "hitRatioOnIndexCache":{ "type":"number", "format":"double" }, "hitRatioOnDataCache":{ "type":"number", "format":"double" }, "numberOfIndexPageReads":{ "type":"number", "format":"double" }, "numberOfIndexPageWrites":{ "type":"number", "format":"double" }, "numberOfDataBlockReads":{ "type":"number", "format":"double" }, "numberOfDataBlockWrites":{ "type":"number", "format":"double" }, "hitRatioOnDataFileCache":{ "type":"number", "format":"double" } } }, "GeneralSettings":{ "type":"object", "properties":{ "description":{ "description":"General description of the cube
", "type":"string" }, "queryTracking":{ "description":"Whether collection of query data is enabled. Applies only to aggregate storage cubes. If true, query tracking is enabled and can be used for query-based view optimization.
", "type":"boolean" } }, "xml":{ "name":"general" } }, "SettingsList":{ "type":"object", "properties":{ "general":{ "$ref":"#/components/schemas/GeneralSettings" }, "startup":{ "$ref":"#/components/schemas/StartupSettings" }, "calculation":{ "$ref":"#/components/schemas/CalculationSettings" }, "buffers":{ "$ref":"#/components/schemas/BufferSettings" }, "compression":{ "type":"array", "items":{ "$ref":"#/components/schemas/CompressionSettings" } }, "caches":{ "$ref":"#/components/schemas/CacheSettings" }, "transactions":{ "$ref":"#/components/schemas/TransactionSettings" }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } } }, "xml":{ "name":"settings" } }, "StartupSettings":{ "type":"object", "properties":{ "allowUsersToStartDatabase":{ "description":"Enable or disable users from starting the cube, either directly, or as a result of requests requiring the cube to be started. The default is true.
", "type":"boolean" }, "startDatabaseWhenApplicationStarts":{ "description":"Automatically start the cube when the application starts. The default is true. Applicable only when allowUsersToStartDatabase is also true.
", "type":"boolean" } }, "xml":{ "name":"startup" } }, "TransactionSettings":{ "type":"object", "properties":{ "committedAccess":{ "description":"If true, sets the isolation level to committed access, meaning that only one transaction at a time can update data blocks, and Essbase holds read/write locks on all data blocks until the transaction and the commit operations are performed. If concurrencyPreImageAccess is enabled, users (or transactions) can still have read-only access to data at its last commit point. The default is false.
", "type":"boolean" }, "concurrencyWaitSeconds":{ "description":"Lock timeout interval; number of seconds to wait for blocks to be unlocked when the database is in committed mode. If a transaction request is made that cannot be granted in the allotted time, the transaction is rolled back until a lock can be granted. Applicable only when committedAccess is true.
", "type":"integer", "format":"int32" }, "concurrencyPreImageAccess":{ "description":"If true, allow users (or other transactions) read-only access to data at its last commit point when the cube is in committed mode (meaning that data blocks may be locked for the duration of a concurrent transaction). The default is true, when committedAccess is enabled.
", "type":"boolean" }, "commitBlocks":{ "description":"The number of data blocks updated before an explicit commit is performed (during calculation and grid updates). Applicable when committedAccess is false.
", "type":"integer", "format":"int64" }, "commitRows":{ "description":"The number of rows of the input file processed before an explicit commit is performed (during data load). Applicable when committedAccess is false.
", "type":"integer", "format":"int64" } }, "xml":{ "name":"transactions" } }, "GeneralStatistics":{ "type":"object", "properties":{ "databaseStartTime":{ "type":"integer", "format":"int64" }, "databaseElapsedTime":{ "type":"string" }, "numberOfConnections":{ "type":"integer", "format":"int32" }, "numberOfDimensions":{ "type":"integer", "format":"int32" }, "loadStatus":{ "type":"string" } } }, "StatisticsDimensions":{ "type":"object", "properties":{ "name":{ "type":"string" }, "levels":{ "type":"string" }, "bits":{ "type":"number", "format":"double" } } }, "StatisticsList":{ "type":"object", "properties":{ "general":{ "$ref":"#/components/schemas/GeneralStatistics" }, "storage":{ "$ref":"#/components/schemas/StorageStatistics" }, "runtime":{ "$ref":"#/components/schemas/RuntimeStatistics" }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } } }, "xml":{ "name":"statistics" } }, "StorageStatistics":{ "type":"object", "properties":{ "dimensions":{ "type":"array", "items":{ "$ref":"#/components/schemas/StatisticsDimensions" } }, "maxKeyLengthBits":{ "description":"For aggregate storage cubes, the sum of all the bits used by each dimension. For example, there are 20 bits in the key used for dimensions, and the first 4 are used by Year.
", "type":"integer", "format":"int32" }, "maxKeyLengthBytes":{ "description":"For aggregate storage cubes, how many bytes the key uses per cell
", "type":"integer", "format":"int32" }, "numberOfInputLevelCells":{ "description":"For aggregate storage cubes, the number of existing level-0 cells in the database, including incremental slices
", "type":"integer", "format":"int32" }, "numberOfIncrementalDataSlices":{ "description":"For aggregate storage cubes, the number of data slices resulting from incremental data loads
", "type":"integer", "format":"int32" }, "numberOfIncrementalInputCells":{ "description":"For aggregate storage cubes, the number of level-0 cells in the incremental data slices
", "type":"integer", "format":"int32" }, "numberOfAggregateViews":{ "description":"For aggregate storage cubes, the number of aggregate views, including those automatically built on incremental slices
", "type":"integer", "format":"int32" }, "numberOfAggregateCells":{ "description":"For aggregate storage cubes, the number of cells stored in aggregate views
", "type":"integer", "format":"int32" }, "numberOfIncrementalAggregateCells":{ "description":"For aggregate storage cubes, the number of cells stored in the incremental slices' aggregate views
", "type":"integer", "format":"int32" }, "costOfQueryingIncrementalData":{ "description":"For aggregate storage cubes, the average percentage of query time spent processing incremental data slices. This is useful in deciding when slices should be merged to improve query performance.
", "type":"number", "format":"double" }, "inputLevelDataSize":{ "description":"For aggregate storage cubes, the total disk space used by input-level data
", "type":"integer", "format":"int32" }, "aggregateDataSize":{ "description":"For aggregate storage cubes, the total disk space occupied by aggregate cells
", "type":"integer", "format":"int32" }, "numberOfExistingBlocks":{ "description":"Total number of existing data blocks (not the maximum)
", "type":"number", "format":"double" }, "blockSize":{ "type":"integer", "format":"int32" }, "potentialNumberOfBlocks":{ "type":"number", "format":"double" }, "existingLevelZeroBlocks":{ "type":"number", "format":"double" }, "existingUpperLevelBlocks":{ "type":"number", "format":"double" }, "blockDensity":{ "type":"number", "format":"double" }, "percentageOfMaximumBlocksExisting":{ "type":"number", "format":"double" }, "compressionRatio":{ "type":"number", "format":"double" }, "averageClusteringRatio":{ "type":"number", "format":"double" }, "pageFileSize":{ "type":"integer", "format":"int64" }, "indexFileSize":{ "type":"integer", "format":"int64" } } }, "PatchElement":{ "type":"object", "properties":{ "op":{ "description":"Patch operation. Example: replace.
", "type":"string" }, "path":{ "description":"Path to setting you want to patch. See examples.
", "type":"string" }, "value":{ "description":"New value of setting you want to patch. See examples.
", "type":"object" }, "from":{ "type":"string" } } }, "AppSecuritySettings":{ "description":"Application security settings.
", "type":"object", "properties":{ "allowCommands":{ "description":"If true, all users with sufficient permissions can make requests to the database (cube) in the application. By default, commands are enabled. If set to false, no requests are permitted by any user including administrators. The false setting remains in effect only for the duration of the issuer's session. The false setting takes effect immediately, and affects users who are currently logged in, as well as users who log in later during the issuer's session.
", "type":"boolean" }, "allowConnects":{ "description":"If true, all users with sufficient permissions can make connections to the database (cube) in the application. By default, connections are enabled. If false, no user with a permission lower than Application Manager can start the cube nor make connections that require the cube to be started.
", "type":"boolean" }, "allowUpdates":{ "description":"If true, all users with sufficient permissions can make requests to the databases (cube) in the application. By default, updates are enabled. If set to false, updates are not permitted, lasting for the duration of the issuer's session.
", "type":"boolean" } }, "xml":{ "name":"security" } }, "AppGeneralSettings":{ "description":"General application settings, including options for startup, expiration of locks on data, EAS-managed applications, and maximum LRO file sizes.
", "type":"object", "properties":{ "description":{ "description":"Description of the application.
", "type":"string" }, "logLevelAsString":{ "description":"Log level. INFO, WARN, ERROR, FATAL, or DEBUG.
", "type":"string" }, "easManagedApp":{ "description":"If true, the application is managed in Essbase Administration Services (EAS) Lite instead of the Essbase web interface. Before you can connect to an application in EAS Lite, you must set it as an EAS managed application. The Essbase web interface is the modern administration interface that supports all current platform features, but EAS Lite is available as a limited-option alternative available only for Essbase 21c independent deployment.
", "type":"boolean" }, "timeoutOnDataBlockLocks":{ "description":"Maximum time interval that locks on data blocks can be held by Smart View (or other grid client) users. When a client data-block lock is held for more than the time out interval, Essbase removes the lock and the transaction is rolled back. The default interval is 60 minutes. This setting affects all databases in the application.
", "type":"integer", "format":"int64" }, "maxAttachmentFileSizeInKbs":{ "description":"Maximum file size for Linked Reporting Object(LRO) attachments. There is no default. There is no minimum or maximum value, excepting limitations imposed by your system resources.
", "type":"integer", "format":"int64" }, "pendingCacheSizeLimitInMbs":{ "description":"Maximum size to which the aggregate storage cache may grow. The aggregate storage cache grows dynamically until it reaches this limit. This setting takes effect after you restart the application. This setting is ignored if ASODEFAULTCACHESIZE configuration property is in use.
", "type":"integer", "format":"int64" } }, "xml":{ "name":"general" } }, "AppSettingsList":{ "type":"object", "properties":{ "general":{ "$ref":"#/components/schemas/AppGeneralSettings" }, "startup":{ "$ref":"#/components/schemas/AppStartupSettings" }, "security":{ "$ref":"#/components/schemas/AppSecuritySettings" }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } } }, "xml":{ "name":"settings" } }, "AppStartupSettings":{ "description":"Application startup settings.
", "type":"object", "properties":{ "allowUsersToStartApplication":{ "description":"If true, all users who have at least read permission can load (start) the application. Startup is enabled by default.
", "type":"boolean" }, "startApplicationWhenServerStarts":{ "description":"If true, the application starts automatically when Essbase Server starts. By default, autostartup is disabled.
", "type":"boolean" } }, "xml":{ "name":"startup" } }, "ApplicationStatistics":{ "type":"object", "properties":{ "applicationStartTime":{ "type":"integer", "format":"int64" }, "applicationElapsedTime":{ "type":"string" }, "numberOfConnections":{ "type":"integer", "format":"int32" }, "loadStatus":{ "type":"string" } } }, "MemberBean":{ "description":"The member information output that Essbase displays is contextual. The following are examples of properties that may not be displayed when you request information for a member:
Member name.
", "type":"string" }, "dimensionName":{ "description":"Name of the dimension this member belongs to.
", "type":"string" }, "numberOfChildren":{ "description":"Number of children this member has.
", "type":"integer", "format":"int32" }, "levelNumber":{ "description":"The level number of this member. Leaf members are level 0, and the level number increases by 1 with each step closer to the dimension root member.
", "type":"integer", "format":"int32" }, "generationNumber":{ "description":"The generation number of this member. Dimension names are generation 1 members, and the generation number increases by 1 with each step closer to the leaf members.
", "type":"integer", "format":"int32" }, "aliases":{ "type":"object", "additionalProperties":{ "type":"string" } }, "activeAliasName":{ "description":"Currently active alias name of this member, if an alias table other than Default is being used in the current session.
", "type":"string" }, "memberHasUniqueName":{ "description":"false if this member name is a duplicate name within the outline, or true if its name is unique. Applicable only for duplicate member enabled outlines.
", "type":"boolean" }, "uniqueName":{ "description":"The unique name for this member in the outline. If the outline is duplicate-member enabled and the member name is not unique, then this unique name will be a qualified name that differentiates it from other members with the same name. For example: [Market].[New York].[New York] is a unique name.
A permanent, unique identifier for a member, separate from its name. When Essbase auto generates member IDs, they follow an incremental naming pattern: id__0, id__1, id__2, etc.
", "type":"string" }, "uniqueId":{ "type":"string" }, "type":{ "description":"Applicable only if the member is a measure. Which type is designated for the measure; for example, DATE for a measure classified using a date format, SMARTLIST for a text-based measure, NUMERIC.
", "type":"string", "enum":[ "NONE", "NUMERIC", "SMARTLIST", "DATE" ] }, "memberSolveOrder":{ "description":"A solve order, if assigned for this member. If not assigned, members inherit the solve order of their dimension. Solve order can be 0-127. Lower solve-order members are calculated before higher.
", "type":"integer", "format":"int32" }, "descendantsCount":{ "description":"Number of descendants this member has.
", "type":"integer", "format":"int64" }, "previousSiblingsCount":{ "description":"Number of siblings that precede this member in the outline.
", "type":"integer", "format":"int32" }, "dimension":{ "description":"true if this member is a top-level dimension member (the member name = the dimension name).
", "type":"boolean" }, "attribute":{ "description":"true if this member is a member of an attribute dimension.
", "type":"boolean" }, "account":{ "description":"true if this member is a member of an Accounts dimension.
", "type":"boolean" }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } } } }, "RestCollectionResponse":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "type":"object" } }, "hasMore":{ "type":"boolean" }, "totalResults":{ "type":"integer", "format":"int32" }, "limit":{ "type":"integer", "format":"int32" }, "count":{ "type":"integer", "format":"int32" }, "offset":{ "type":"integer", "format":"int32" }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } } } }, "ExportOptions":{ "type":"object", "properties":{ "aliasTable":{ "type":"string" }, "dimensions":{ "type":"array", "items":{ "type":"string" } }, "tree":{ "type":"boolean" } } }, "AreaBean":{ "type":"object", "properties":{ "sourceArea":{ "description":"Partition source area/region, with optional list of slices containing specific member mappings.
", "type":"string" }, "targetArea":{ "description":"Partition target area/region, with optional list of slices containing specific member mappings.
", "type":"string" }, "sourceCellCount":{ "description":"Cell count of the partition source area. The source and target areas of a transparent or replicated partition should contain the same number of cells. Cell count does not include the cells of attribute dimensions.
", "type":"integer", "format":"int64" }, "targetCellCount":{ "description":"Cell count of the partition target area. The source and target areas of a transparent or replicated partition should contain the same number of cells. Cell count does not include the cells of attribute dimensions.
", "type":"integer", "format":"int64" }, "slices":{ "description":"Optional slice definition defining source and target member mappings. Essbase uses this information to determine how to put data into the target if the target and the source use different names for some members and dimensions.
", "type":"array", "items":{ "$ref":"#/components/schemas/MemberMappingBean" } } } }, "ConnectionInfoBean":{ "type":"object", "properties":{ "connectionName":{ "description":"Connection name used for partition connectivity. Required for partitions accessing data outside of a single Essbase instance.
", "type":"string" }, "serverName":{ "description":"URL of the Essbase server, ending in essbase/agent.
Partition username, if authentication info is embedded in the partition definition.
", "type":"string" }, "password":{ "description":"Partition user password, if authentication info is embedded in the partition definition.
", "type":"string" }, "description":{ "type":"string" }, "applicationName":{ "description":"Name of application.
", "type":"string" }, "databaseName":{ "description":"Name of Essbase database/cube.
", "type":"string" }, "datasourceName":{ "description":"Datasource name used for partition connectivity.
", "type":"string" }, "measuresDimensionName":{ "description":"Pivot dimension name defined in federated partition. Can be Measures dimension but does not have to be.
", "type":"string" }, "schemaName":{ "description":"The name of the database schema (used as the repository database for federated partition).
", "type":"string" }, "factTableName":{ "description":"The name of the fact table in Autonomous Database that stores numeric values and keys.
", "type":"string" }, "isFactManagedByFederatedCube":{ "description":"true if the federated partition fact table is managed by Essbase, instead of by the Autonomous Data Warehouse schema administrator.
", "type":"boolean" }, "essbaseToColumnMap":{ "description":"If any federated Essbase cube's outline dimensions or members cannot be mapped to a column in the fact table, you need to map them in this definition.
", "$ref":"#/components/schemas/EsbToColMap" }, "essbaseToDataSourceMap":{ "$ref":"#/components/schemas/EssToDsMapDTO" }, "alterCredentials":{ "type":"boolean" }, "applicationLevelConnection":{ "description":"Must be specified as true if the connection is defined at the application level rather than globally.
", "type":"boolean" }, "applicationLevelDatasource":{ "description":"Must be specified as true if the Datasource is defined at the application level rather than globally.
", "type":"boolean" } } }, "EsbToColMap":{ "description":"For federated Essbase cube, map dimensions or members to columns in the fact table.
", "type":"object", "properties":{ "arr":{ "type":"array", "items":{ "$ref":"#/components/schemas/EsbToColMapInfo" } } } }, "EsbToColMapInfo":{ "description":"For federated Essbase cube, map dimensions or members to columns in the fact table.
", "type":"object", "properties":{ "essbaseName":{ "description":"Essbase dimension or member name.
", "type":"string" }, "columnName":{ "description":"Column name in external fact table.
", "type":"string" } } }, "MemberMappingBean":{ "type":"object", "properties":{ "sourceMember":{ "description":"A member name on the partition source to map to a congruent region on the target.
", "type":"string" }, "targetMember":{ "description":"A member name on the partition target to map to a congruent region on the source.
", "type":"string" } } }, "PartitionBean":{ "type":"object", "properties":{ "id":{ "description":"Partition ID.
", "type":"string" }, "type":{ "description":"Partition type. TRANSPARENT, REPLICATED, or FEDERATED.
", "type":"string" }, "updatable":{ "description":"Whether the partition definition can be updated.
", "type":"boolean" }, "isNew":{ "description":"Whether the partition definition is new.
", "type":"boolean" }, "locked":{ "description":"Whether the partition object is locked.
", "type":"boolean" }, "federatedTypeCR":{ "description":"Obsolete.
", "type":"boolean" }, "federatedTypeAV":{ "description":"Whether federated partition to Autonomous Database is enabled. If true, the cube data is stored in Autonomous Data Warehouse, and Analytic View objects are used for Essbase metadata.
", "type":"boolean" }, "sourceInfo":{ "$ref":"#/components/schemas/ConnectionInfoBean" }, "targetInfo":{ "$ref":"#/components/schemas/ConnectionInfoBean" }, "areas":{ "type":"array", "items":{ "$ref":"#/components/schemas/AreaBean" } }, "mappings":{ "type":"array", "items":{ "$ref":"#/components/schemas/MemberMappingBean" } }, "errorMessage":{ "description":"An error message associated with partition validation.
", "type":"string" }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } } } }, "PartitionList":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/PartitionBean" } }, "offset":{ "type":"integer", "format":"int64" }, "limit":{ "type":"integer", "format":"int64" }, "totalResults":{ "type":"integer", "format":"int64" }, "count":{ "type":"integer", "format":"int64" }, "hasMore":{ "type":"boolean" }, "properties":{ "type":"object", "additionalProperties":{ "type":"string" } } } }, "PropertyEntry":{ "type":"object", "properties":{ "name":{ "type":"string" }, "value":{ "type":"string" }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } } } }, "PropertyList":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/PropertyEntry" } }, "count":{ "type":"integer", "format":"int64" }, "totalResults":{ "type":"integer", "format":"int64" }, "hasMore":{ "type":"boolean" }, "limit":{ "type":"integer", "format":"int64" }, "properties":{ "type":"object", "additionalProperties":{ "type":"string" } }, "offset":{ "type":"integer", "format":"int64" } } }, "DatabaseProvisionReportItem":{ "type":"object", "properties":{ "database":{ "type":"string" }, "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/ProvisionReportItem" } } } }, "DatabaseProvisionReportItemList":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/DatabaseProvisionReportItem" } }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } }, "count":{ "type":"integer", "format":"int64" }, "totalResults":{ "type":"integer", "format":"int64" }, "hasMore":{ "type":"boolean" }, "limit":{ "type":"integer", "format":"int64" }, "properties":{ "type":"object", "additionalProperties":{ "type":"string" } }, "offset":{ "type":"integer", "format":"int64" } } }, "ProvisionReportItem":{ "type":"object", "properties":{ "name":{ "type":"string" }, "inheritedFromGroups":{ "uniqueItems":true, "type":"array", "items":{ "type":"string" } } } }, "ApplicationProvisionReportItem":{ "type":"object", "properties":{ "name":{ "type":"string" }, "roles":{ "$ref":"#/components/schemas/ProvisionReportItemList" }, "filters":{ "$ref":"#/components/schemas/DatabaseProvisionReportItemList" }, "scripts":{ "$ref":"#/components/schemas/DatabaseProvisionReportItemList" } } }, "ApplicationProvisionReportItemList":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/ApplicationProvisionReportItem" } }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } }, "count":{ "type":"integer", "format":"int64" }, "totalResults":{ "type":"integer", "format":"int64" }, "hasMore":{ "type":"boolean" }, "limit":{ "type":"integer", "format":"int64" }, "properties":{ "type":"object", "additionalProperties":{ "type":"string" } }, "offset":{ "type":"integer", "format":"int64" } } }, "MainProvisionReport":{ "type":"object", "properties":{ "service":{ "$ref":"#/components/schemas/ServiceProvisionReportItem" }, "applications":{ "$ref":"#/components/schemas/ApplicationProvisionReportItemList" }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } } } }, "ProvisionReportItemList":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/ProvisionReportItem" } }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } }, "count":{ "type":"integer", "format":"int64" }, "totalResults":{ "type":"integer", "format":"int64" }, "hasMore":{ "type":"boolean" }, "limit":{ "type":"integer", "format":"int64" }, "properties":{ "type":"object", "additionalProperties":{ "type":"string" } }, "offset":{ "type":"integer", "format":"int64" } } }, "ServiceProvisionReportItem":{ "type":"object", "properties":{ "roles":{ "$ref":"#/components/schemas/ProvisionReportItemList" } } }, "ClusterNode":{ "type":"object", "properties":{ "machineName":{ "type":"string" }, "appName":{ "type":"string" }, "dbName":{ "type":"string" }, "state":{ "type":"integer", "format":"int32" }, "agentUrl":{ "type":"string" } }, "xml":{ "name":"items" } }, "ROCluster":{ "type":"object", "properties":{ "name":{ "type":"string" }, "desc":{ "type":"string" }, "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/ClusterNode" } }, "nodeVales":{ "type":"array", "writeOnly":true, "items":{ "type":"array", "items":{ "type":"string" } } } } }, "AttributeBuildProperties":{ "description":"Dimension build properties for attribute dimensions that use numeric ranges.
", "type":"object", "properties":{ "rangeIncrementValue":{ "description":"Increment value for numeric attribute ranges.
", "type":"number", "format":"double" }, "rangeStartValue":{ "description":"Start value for numeric attribute ranges.
", "type":"number", "format":"double" }, "removeAll":{ "type":"boolean" }, "useRanges":{ "description":"True if current attribute dimension is using numeric ranges.
", "type":"boolean" } } }, "AttributeOptions":{ "type":"object", "properties":{ "indepDimensions":{ "type":"array", "items":{ "$ref":"#/components/schemas/IndepDimension" } }, "type":{ "type":"string", "enum":[ "NUMERIC", "BOOLEAN", "TEXT", "DATE", "EXISTING" ] }, "baseDimension":{ "type":"string" }, "modified":{ "type":"boolean" }, "scaassociationMode":{ "type":"string", "enum":[ "NOOVERWRITE", "OVERWRITE" ] }, "scadisAssociationMode":{ "type":"string", "enum":[ "NOOVERWRITE", "OVERWRITE", "EXTEND" ] } } }, "ColumnOperation":{ "description":"Rule operations available to perform at the field level. For example, you can move a field to a new position in the record.
", "type":"object", "properties":{ "updateColumns":{ "type":"boolean" }, "type":{ "description":"Type of column operation.
", "type":"string", "enum":[ "CREATE", "JOIN", "SPLIT", "MOVE", "CREATETEXT", "SUBSTRING" ] }, "position":{ "description":"Target position for column move operation.
", "type":"integer", "format":"int32" } } }, "DataLoadOptions":{ "description":"Rule operations available to perform on the data in a field; for example, changing how data affects existing values, clearing values, or flipping signs. Not applicable for dimension build rules.
", "type":"object", "properties":{ "clearCombinations":{ "description":"Array of text values to clear while loading the data.
", "type":"array", "items":{ "type":"string" } }, "option":{ "description":"A data load option to specify how newly loaded data values affect existing data values. By default, Essbase overwrites the existing values of the cube with the values of the source data. For example, if you load weekly values, you can specify the ADD option to create monthly values in the cube.
", "type":"string", "enum":[ "NONE", "OVERWRITE", "ADD", "SUBTRACT" ] }, "removeAll":{ "type":"integer", "format":"int32" }, "signFlipDimension":{ "description":"Dimension name in which to flip signs. You can reverse, or flip, the value of a data field by flipping its sign. Sign flips are based on the UDA (user defined attribute) that you specify in signFlipUDA. When loading data into the accounts dimension, for example, you can specify that any record whose accounts member has a UDA of Expense change from a plus sign to a minus sign.
", "type":"string" }, "signFlipUDA":{ "description":"UDA (user defined attribute) for which to flip signs. You can reverse, or flip, the value of a data field by flipping its sign. Also specify the signFlipDimension.
", "type":"string" } } }, "DataSource":{ "description":"General Source Properties of a dimension build or data load rule. Use to broadly set how the rule behaves with respect to the source data.
", "type":"object", "properties":{ "header":{ "description":"Header string used in the source data, if known. This will be skipped during the dimension build or data load.
", "type":"string" }, "name":{ "type":"string" }, "tokens":{ "description":"Ignore source data records during the dimension build or data load if the record contains the specified token(s). A token is one delimited string in the source data. To specify multiple tokens, be sure to delimit them and specify a tokensCombineOption. Example of tokens delimited by space: \"tokens\" : [ \"&& UNDEFINED\" ]
If you listed multiple tokens to ignore, specify AND if Essbase should ignore only records that contain all of the tokens. Specify OR if Essbase should ignore records that contain any of the tokens.
", "type":"string", "enum":[ "AND", "OR" ] }, "sqlProperties":{ "description":"SQL Properties enable connectivity to an external system such as an RDBMS to extract data from a relational system using a query.
", "$ref":"#/components/schemas/SQLProperties" }, "fileProperties":{ "$ref":"#/components/schemas/FileProperties" } } }, "DimBuildOptions":{ "description":"Global properties affecting all dimensions included in a dimension build rule.
", "type":"object", "properties":{ "autoConfig":{ "description":"Set to true let Essbase automatically assign dimensions as dense or sparse. By default, density/sparsity settings are kept as either the existing setting or the setting specified in the dimension build rule. Applicable to block storage cubes only.
", "type":"boolean" }, "arrangeDimensions":{ "description":"Set to true to arrange dimensions in hourglass order for calculation performance. Applicable to block storage cubes only. The order is: 1- densest dimensions (accounts and time), 2- remaining dense dimensions (largest to smallest), 3- sparse dimensions (smallest to largest), 4- attribute dimensions.
", "type":"boolean" }, "aliasTable":{ "description":"Select which alias table to update with new aliases from the source data. If unspecified, dimension build updates the default alias table.
", "type":"string" }, "smartLists":{ "description":"Array to add or update a text list object, also known as a Smart List. Text list objects are a way to store metrics as textual values when your accounts dimension is designed to work with text measures, and your outline is enabled for typed measures. To see a sample cube that uses a textual measure dimension, import the sample application Facility Rating, available in the gallery section of the Files catalog.
", "type":"array", "items":{ "$ref":"#/components/schemas/SmartList" } } } }, "EditorOptions":{ "type":"object", "properties":{ "application":{ "type":"string" }, "database":{ "type":"string" }, "server":{ "type":"string" }, "object":{ "type":"string" }, "dataFile":{ "type":"string" }, "dataFileApplication":{ "type":"string" }, "dataFileDatabase":{ "type":"string" }, "dataFileServer":{ "type":"string" }, "startRecord":{ "type":"integer", "format":"int32" }, "viewCount":{ "type":"integer", "format":"int32" }, "viewGridLines":{ "type":"boolean" }, "viewIgnored":{ "type":"boolean" }, "viewRawData":{ "type":"boolean" }, "viewToolbar":{ "type":"boolean" }, "viewMode":{ "type":"string", "enum":[ "DIMBUILD", "DATALOAD" ] }, "dataFileType":{ "type":"string", "enum":[ "NONE", "EXCEL", "LOTUS2", "LOTUS3", "LOTUS4", "TEXT" ] } } }, "EssbaseInfo":{ "type":"object", "properties":{ "server":{ "type":"string" }, "application":{ "type":"string" }, "database":{ "type":"string" }, "user":{ "type":"string" }, "password":{ "type":"string" } } }, "Field":{ "description":"Field properties for performing load rule operations at the record level. For example, you can filter to select or reject certain records before they are loaded into the cube.
", "type":"object", "properties":{ "rejectFilters":{ "description":"Rejection filter criteria for omitting data load or dimension build records while loading to the Essbase cube. Filtration options include string or numeric matching of specific values, logical join options, and case sensitivity.
", "type":"array", "items":{ "$ref":"#/components/schemas/Filter" } }, "selectFilters":{ "description":"Selection filter criteria for approval of data load or dimension build records while loading to the Essbase cube. Filtration options include string or numeric matching of specific values, logical join options, and case sensitivity.
", "type":"array", "items":{ "$ref":"#/components/schemas/Filter" } }, "replaceInformation":{ "description":"Replacement value specification, if the filter is designed for finding and replacing values in source records as you load them to Essbase.
", "type":"array", "items":{ "$ref":"#/components/schemas/ReplaceInfo" } }, "selectFilterJoinOption":{ "description":"If you define more than one selection filter, choose a logical join operator, AND or OR. AND means that all the defined selection criteria must apply (if even one criterion is not met for any given record, then the filter does not apply to that record). OR means the opposite (if even one criterion is met for a given record, the filter applies).
", "type":"string", "enum":[ "AND", "OR" ] }, "rejectFilterJoinOption":{ "description":"If you define more than one rejection filter, choose a logical join operator, AND or OR. AND means that all the defined rejection criteria must apply (if even one criterion is not met for any given record, then the filter does not apply to that record). OR means the opposite (if even one criterion is met for a given record, the filter applies).
", "type":"string", "enum":[ "AND", "OR" ] }, "dateFormat":{ "description":"Date format for the field, if applicable.
", "type":"string" }, "name":{ "type":"string" }, "prefix":{ "description":"Prefix for the field, if applicable.
", "type":"string" }, "suffix":{ "description":"Suffix for the field, if applicable.
", "type":"string" }, "option":{ "type":"string", "format":"byte" }, "convertSpaceToUnderScore":{ "description":"Convert spaces in source data fields to underscores while loading to Essbase.
", "type":"boolean" }, "trim":{ "description":"Trim leading or trailing spaces from around source data fields so that they map correctly to Essbase member names.
", "type":"boolean" }, "width":{ "description":"Width of the field, if applicable (if the source data fields are fixed width).
", "type":"number", "format":"double" }, "smartList":{ "description":"Text list object (smart list) associated with the field, if applicable.
", "type":"string" }, "dimensionBuildOptions":{ "description":"Field-level options you can set for dimension-build rules. For example, Essbase can ignore, split, join, and reposition fields.
", "$ref":"#/components/schemas/FieldDimBuildOptions" }, "dataloadOptions":{ "$ref":"#/components/schemas/FieldDataLoadOptions" }, "transform":{ "$ref":"#/components/schemas/Transform" }, "case":{ "description":"Select a character case-conversion operation to perform on incoming data while loading to Essbase. NOOP: perform no conversion. LOWER_CASE: convert upper case to lower case. UPPER_CASE: convert lower case to upper case. FIRST_CAPITAL_CASE: convert the first character to upper case and the remaining characters to lower case.
", "type":"string", "enum":[ "NOOP", "LOWER_CASE", "UPPER_CASE", "FIRST_CAPITAL_CASE" ] } } }, "FieldDataLoadOptions":{ "description":"Field-level options you can set for data-load rules. For example, Essbase can ignore, rescale, and perform extractions on fields from the source data.
", "type":"object", "properties":{ "referDimension":{ "description":"For duplicate member outlines, specify the dimension and the referOption that indicates the build method (level reference or generation reference) that Essbase uses to map the field.
", "type":"string" }, "referNumber":{ "description":"For duplicate member outlines, use with referOption to specify the generation or level number expected for the source data field.
", "type":"integer", "format":"int32" }, "referOption":{ "description":"For duplicate member outlines, specify referOption that indicates the build method (level reference or generation reference) that Essbase uses to map the field. Use level reference when fields are organized bottom-up in the source data. Use generation reference when fields are organized top down in the source data.
", "type":"integer", "format":"int32" }, "ignore":{ "type":"boolean" }, "scale":{ "description":"Available only for data fields. Set to true if you want to scale the values of the source data to match the scale of values stored in the cube. Must be used with scalingfactor.
", "type":"boolean" }, "useReference":{ "type":"boolean" }, "data":{ "description":"Set to true to indicate that the field is a data (non-metadata) field.
", "type":"boolean" }, "scalingfactor":{ "description":"Available only for data fields and when scale is set to true. A scaling factor, if the values of the source data are not in the same scale as the values of the cube. For example, assume the real value of sales is $5,460. If the Sales source data tracks the values in hundreds, the value is 54.6. If the Essbase cube tracks the real value, you must multiply the value coming in from the Sales source data (54.6) by 100 to have the value display correctly in the Essbase cube (as 5460).
", "type":"number", "format":"double" }, "storeType":{ "description":"Column-level options to extract the source data in a specific way. Available only for data fields. MIN stores the minimum value of the incoming data, including a comparison with existing cube data. MAX stores the maximum value. SUM behaves the same as the ADD global option, adding the incoming data to existing cube data. COUNT stores the count of values present in the incoming data.
", "type":"string", "enum":[ "MIN", "MAX", "AVG", "SUM", "COUNT" ] }, "storeTypeCountMissing":{ "type":"boolean" } } }, "FieldDimBuildOptions":{ "description":"Field-level options you can set for dimension-build rules. For example, Essbase can ignore, split, join, and reposition fields.
", "type":"object", "properties":{ "parent":{ "description":"Parent field generation of this field. For example, a field of generation 3 has a generation-2 field as a parent.
", "type":"integer", "format":"int32" }, "generationType":{ "description":"Type you assign to the source data field to help Essbase build the dimension correctly.
", "type":"string", "enum":[ "NONE", "PARENT", "CHILD", "GENERATION", "LEVEL", "ATTRIBUTE_MEMBER", "ALIAS", "PROPERTY", "FORMULA", "MEMBER_ID", "SOLVE_ORDER", "UDA", "DUPGEN", "DUPLEVEL", "DUPGEN_ALIAS", "DUPLEVEL_ALIAS", "CURRENCY_NAME", "CURRENCY_CATEGORY", "NUMTYPES", "ATTRIBUTE_DIM_LABEL", "ATTRIBUTE_PARENT", "DUPGEN_CAPTION", "DUPLEVEL_CAPTION", "AGGLEVELUSAGE", "ATTR_ASSOCIATE", "REFMEMBER", "GEN_RIGHTJOIN", "COMMENT", "SHARED_GEN", "GEN_NATUREJOIN", "GEN_LEFTJOIN", "GEN_OTLMBR", "COMMENT_EX", "REFMEMBERID", "SMARTLISTID", "SMARTLISTTEXT", "FORMATSTRING", "PROTOTYPE" ] }, "refer":{ "description":"Which field number this field refers to.
", "type":"integer", "format":"int32" }, "referIndex":{ "type":"integer", "format":"int32" }, "shared":{ "type":"integer", "format":"int32" }, "attributeBuildProperties":{ "$ref":"#/components/schemas/AttributeBuildProperties" }, "dimension":{ "type":"string" }, "attributeDimension":{ "type":"string" }, "alias":{ "type":"string" }, "endIndepColumns":{ "type":"array", "items":{ "type":"integer", "format":"int32" } }, "startIndepColumns":{ "type":"array", "items":{ "type":"integer", "format":"int32" } }, "generationProperty":{ "type":"string", "enum":[ "NONE", "CONSOLIDATIONTYPE", "STORAGETYPE", "TIMEBALANCE", "SKIP", "VARIANCEREPORT", "TWOPASSCALC", "HIERARCHYTYPE" ] }, "generation":{ "type":"integer", "format":"int32" }, "ignore":{ "description":"true if record should be ignored during data loads and dimension builds.
", "type":"boolean" }, "staticField":{ "description":"Whether the field value is static. If true, then the name is used for loading.
", "type":"boolean" } } }, "FileProperties":{ "type":"object", "properties":{ "delimiter":{ "description":"If the rule is associated with a delimited file, the delimiter.
", "type":"string" }, "width":{ "description":"If the rule is associated with a fixed-width flat file, the width in bytes.
", "type":"integer", "format":"int32" }, "dataloadRecordNumber":{ "description":"The number of the record to start with when performing a data load.
", "type":"integer", "format":"int32" }, "dimensionBuildRecordNumber":{ "description":"The number of the record to start with when performing a dimension build.
", "type":"integer", "format":"int32" }, "headerRecordNumber":{ "description":"The number of header rows to skip when performing a data load or dimension build. For example, 1 if the first record is a header. 0 if there is no header.
", "type":"integer", "format":"int32" }, "lineSkipCount":{ "description":"Number of lines at the top of the data source to skip.
", "type":"integer", "format":"int32" } } }, "Filter":{ "type":"object", "properties":{ "stringFilter":{ "description":"If true, the condition applies to string matching, and if false, it applies to numeric values.
", "type":"boolean" }, "value":{ "type":"string" }, "condition":{ "description":"Logical condition of the selection or rejection filter.
", "type":"string", "enum":[ "EQUAL_TO", "NOT_EQUAL_TO", "GREATER_THAN", "GREATER_THAN_EQUAL_TO", "LESS_THAN", "LESS_THAN_EQUAL_TO", "CONTAIN", "DOES_NOT_CONTAIN" ] }, "caseSensitive":{ "type":"boolean" }, "type":{ "description":"The type of filter: SELECT if the filter is defined with conditions for approving records to load. REJECT if the filter is defined with conditions for rejecting records to load.
", "type":"string", "enum":[ "REJECT", "SELECT" ] } } }, "IndepDimension":{ "type":"object", "properties":{ "name":{ "type":"string" }, "type":{ "type":"string", "enum":[ "CONTINUOUS", "DISCRETE" ] } } }, "Level":{ "type":"object", "properties":{ "name":{ "type":"string" }, "number":{ "type":"integer", "format":"int32" }, "unique":{ "type":"boolean" } } }, "MeasureOptions":{ "description":"Load rule definition properties relating primarily to the Accounts dimension.
", "type":"object", "properties":{ "currencyCategory":{ "description":"If the dimension is associated with a currency conversion application, the currency category. This is an Accounts member from the currency cube. Example: P&L.
", "type":"string" }, "currencyName":{ "description":"If the dimension is associated with a currency conversion application, the currency name. This is a Country dimension type member from the currency cube. Examples: USD, CND, GPB, EUR
", "type":"string" }, "currencyConversion":{ "description":"Currency conversion action to take during the dimension build. Mark any members that should not be currency-converted as NO_CONVERSION. NONE does not indicate no conversion; rather, it indicates that the conversion category is unspecified (thus inherited).
", "type":"string", "enum":[ "EXISTING", "NONE", "CATEGORY", "NO_CONVERSION" ] }, "skip":{ "description":"If you set the timeBalanceOption as FIRST, LAST, or AVERAGE, then use the skip property to indicate how to calculate the parent value when missing- or zero-values are encountered. NONE: Does not skip data when calculating parent value. MISSING: Skips #MISSING data. ZERO: Skips data that equals zero. MISSING_ZERO: Skips #MISSING data and data that equals zero.
", "type":"string", "enum":[ "NONE", "NA", "MISSING", "ZERO", "MISSING_ZERO" ] }, "timeBalanceOption":{ "description":"The time balance property, if used. By default, a parent in the time dimension is calculated based on the consolidation and formulas of its children. For example, in the Sample.Basic database, the Qtr1 member is the sum of its children (Jan, Feb, and Mar). However, setting a time balance property causes parents, for example Qtr1, to roll up differently.
", "type":"string", "enum":[ "EXISTING", "NONE", "FIRST", "LAST", "AVERAGE" ] }, "varianceReporting":{ "description":"Whether to treat accounts members as expense items. EXISTING to keep the current setting.
", "type":"string", "enum":[ "EXISTING", "NON_EXPENSE", "EXPENSE" ] }, "twoPass":{ "description":"True to mark the dimension as using two-pass calculation.
", "type":"boolean" } } }, "ReplaceInfo":{ "type":"object", "properties":{ "find":{ "type":"string" }, "replace":{ "type":"string" }, "matchWholeWord":{ "type":"boolean" }, "replaceAll":{ "type":"boolean" }, "caseSensitive":{ "type":"boolean" } } }, "Rules":{ "type":"object", "properties":{ "dimensions":{ "description":"Properties defined per dimension, to set how the rule behaves for a dimension.
", "type":"array", "items":{ "$ref":"#/components/schemas/Dimension" } }, "fields":{ "description":"Array of field information, including general properties for all fields, as well as information about specific fields.
", "type":"array", "items":{ "$ref":"#/components/schemas/Field" } }, "timeStamp":{ "type":"integer", "format":"int64" }, "dataSource":{ "description":"General Source Properties of a dimension build or data load rule. Use to broadly set how the rule behaves with respect to the source data.
", "$ref":"#/components/schemas/DataSource" }, "dimensionBuildOptions":{ "$ref":"#/components/schemas/DimBuildOptions" }, "dataLoadOptions":{ "$ref":"#/components/schemas/DataLoadOptions" }, "editorOptions":{ "$ref":"#/components/schemas/EditorOptions" }, "encoding":{ "description":"The encoding type of the rule file.
", "type":"string", "enum":[ "NONE", "NONUNICODE", "UTF8" ] }, "name":{ "type":"string" }, "locale":{ "type":"string" }, "studio":{ "description":"true if the rule is Index-based, and false if the rule is Regular. Index-based rules (sometimes called BPM rules) have different structure than Regular rules. Fields can be in any order; for example, Generation 2 can come before Generation 1, and a property of Generation 1 can come before the actual Generation 1 column. An index-based rule does not offer column operations (join, split, and move), but you can accomplish the same using field expressions.
", "type":"boolean" }, "bibpm":{ "type":"boolean" }, "xolap":{ "type":"boolean" }, "flatFileBased":{ "description":"true if the rule is associated with a flat file.
", "type":"boolean" }, "essbaseInfo":{ "$ref":"#/components/schemas/EssbaseInfo" }, "columnOperations":{ "description":"Rule operations available to perform at the field level. For example, you can move a field to a new position in the record.
", "type":"array", "items":{ "$ref":"#/components/schemas/ColumnOperation" } } } }, "SQLProperties":{ "description":"SQL Properties enable connectivity to an external system such as an RDBMS to extract data from a relational system using a query.
", "type":"object", "properties":{ "server":{ "description":"Connection string or Datasource info to establish SQL-based connectivity. Example for Datasource: REST;URL=LOCAL;DS=Orcl_DS. For Oracle Database with SID: oracle://somedb99:1521/orcl. For Oracle Database with service name: ORACLESERVICE:oracle://somedb99:1234/esscs.host1.oraclecloud.com. For Microsoft SQL Server: sqlserver://myMSSQLHost:1433:myDbName. For MySQL: mysql://HostName:3306:DBName. For Teradata: teradata://192.0.2.110:1025/myDBName. For IBM DB2: db2://myDB2Host:1234:myDbName.
Essbase application name, if connectivity is to another Essbase cube.
", "type":"string" }, "database":{ "description":"Essbase database name, if connectivity is to another Essbase cube.
", "type":"string" }, "dictionary":{ "type":"string" }, "select":{ "description":"The SELECT clause of the query, excluding SELECT.
", "type":"string" }, "from":{ "description":"The FROM clause of the query, excluding FROM.
", "type":"string" }, "where":{ "description":"The WHERE clause of the query, excluding WHERE.
", "type":"string" } } }, "SmartList":{ "type":"object", "properties":{ "incrementalNumber":{ "type":"integer", "format":"int32" }, "startNumber":{ "type":"integer", "format":"int32" }, "missingName":{ "type":"string" }, "name":{ "type":"string" }, "outOfRangeName":{ "type":"string" }, "removeUnspecified":{ "type":"integer", "format":"int32" } } }, "Transform":{ "description":"Transformation options for data processing that you can use in an index-based dimension build rule. Types can be COLUMN, SUBSTR for substring function, CONCAT for joins, STATICSTR for static strings, or IGNORE. The following index-based rule transformation spec is the same as the Essbase Web interface using a field expression of join(column0,column1). \"transform\" : {\"type\": \"CONCAT\", \"nodes\": [ {\"type\": \"COLUMN\", \"index\" : 0}, {\"type\": \"COLUMN\", \"index\": 1}]}}.
Script contents.
", "type":"string" }, "type":{ "type":"string", "enum":[ "REFRESH", "CLEAR", "APPLY" ] } }, "xml":{ "name":"Script" } }, "ApproverListResponse":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/ApproverBean" } }, "count":{ "type":"integer", "format":"int64" }, "totalResults":{ "type":"integer", "format":"int64" }, "hasMore":{ "type":"boolean" }, "limit":{ "type":"integer", "format":"int64" }, "properties":{ "type":"object", "additionalProperties":{ "type":"string" } }, "offset":{ "type":"integer", "format":"int64" } }, "xml":{ "name":"Approvers" } }, "ScenarioChangesListResponse":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "type":"object", "additionalProperties":{ "type":"object" } } }, "count":{ "type":"integer", "format":"int64" }, "totalResults":{ "type":"integer", "format":"int64" }, "hasMore":{ "type":"boolean" }, "limit":{ "type":"integer", "format":"int64" }, "properties":{ "type":"object", "additionalProperties":{ "type":"string" } }, "offset":{ "type":"integer", "format":"int64" } }, "xml":{ "name":"ScenarioChanges" } }, "CommentListResponse":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/CommentBean" } }, "count":{ "type":"integer", "format":"int64" }, "totalResults":{ "type":"integer", "format":"int64" }, "hasMore":{ "type":"boolean" }, "limit":{ "type":"integer", "format":"int64" }, "properties":{ "type":"object", "additionalProperties":{ "type":"string" } }, "offset":{ "type":"integer", "format":"int64" } }, "xml":{ "name":"Comments" } }, "ParticipantListResponse":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/ParticipantBean" } }, "count":{ "type":"integer", "format":"int64" }, "totalResults":{ "type":"integer", "format":"int64" }, "hasMore":{ "type":"boolean" }, "limit":{ "type":"integer", "format":"int64" }, "properties":{ "type":"object", "additionalProperties":{ "type":"string" } }, "offset":{ "type":"integer", "format":"int64" } }, "xml":{ "name":"Participants" } }, "ScenarioCubes":{ "type":"object", "properties":{ "application":{ "type":"string" }, "databases":{ "type":"array", "items":{ "type":"string" } }, "createScenario":{ "type":"boolean" }, "participateInScenario":{ "type":"boolean" }, "databaseAdmin":{ "type":"boolean" }, "easManagedApp":{ "description":"If true, the application is managed in Essbase Administration Services (EAS) Lite instead of the Essbase web interface. EAS Lite is available as a limited-option alternative available only for Essbase 21c independent deployment.
", "type":"boolean" } }, "xml":{ "name":"Database" } }, "ScenarioCubesList":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/ScenarioCubes" } }, "count":{ "type":"integer", "format":"int64" }, "totalResults":{ "type":"integer", "format":"int64" }, "hasMore":{ "type":"boolean" }, "limit":{ "type":"integer", "format":"int64" }, "properties":{ "type":"object", "additionalProperties":{ "type":"string" } }, "offset":{ "type":"integer", "format":"int64" } }, "xml":{ "name":"Databases" } }, "ScenarioCollectionResponse":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "format":"int64" }, "limit":{ "type":"integer", "format":"int64" }, "offset":{ "type":"integer", "format":"int64" }, "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/ScenarioBean" } }, "count":{ "type":"integer", "format":"int64" }, "hasMore":{ "type":"boolean" }, "properties":{ "type":"object", "additionalProperties":{ "type":"string" } } }, "xml":{ "name":"Scenarios" } }, "ScriptListResponse":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/ScriptBean" } }, "count":{ "type":"integer", "format":"int64" }, "totalResults":{ "type":"integer", "format":"int64" }, "hasMore":{ "type":"boolean" }, "limit":{ "type":"integer", "format":"int64" }, "properties":{ "type":"object", "additionalProperties":{ "type":"string" } }, "offset":{ "type":"integer", "format":"int64" } }, "xml":{ "name":"Comments" } }, "ScenarioEditBean":{ "type":"object", "properties":{ "dueDate":{ "type":"integer", "format":"int64" }, "priority":{ "type":"string", "enum":[ "LOW", "MEDIUM", "HIGH" ] }, "owner":{ "type":"string" }, "description":{ "type":"string" } } }, "CopyOptions":{ "type":"object", "properties":{ "properties":{ "type":"boolean" }, "comments":{ "type":"boolean" }, "data":{ "type":"boolean" }, "tasks":{ "type":"boolean" }, "keyMetrics":{ "type":"boolean" }, "slice":{ "type":"boolean" }, "layouts":{ "type":"boolean" }, "approvers":{ "type":"boolean" }, "participants":{ "type":"boolean" } } }, "ScenarioActionPayload":{ "type":"object", "properties":{ "comment":{ "type":"string" }, "to":{ "type":"string" }, "copyOptions":{ "$ref":"#/components/schemas/CopyOptions" } } }, "Script":{ "type":"object", "properties":{ "content":{ "description":"Script contents.
", "type":"string" }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } }, "modifiedTime":{ "type":"integer", "format":"int64" }, "locked":{ "type":"boolean" }, "lockedTime":{ "type":"integer", "format":"int64" }, "lockedBy":{ "type":"string" }, "sizeInBytes":{ "type":"integer", "format":"int64" }, "name":{ "description":"Script name.
", "type":"string" } } }, "ScriptCopy":{ "required":[ "from", "to" ], "type":"object", "properties":{ "from":{ "description":"Script's original name.
", "type":"string" }, "to":{ "description":"Script's new name.
", "type":"string" } } }, "RTSVList":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "format":"int64" }, "count":{ "type":"integer", "format":"int64" }, "limit":{ "type":"integer", "format":"int64" }, "offset":{ "type":"integer", "format":"int64" }, "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/RTSV" } }, "hasMore":{ "type":"boolean" }, "properties":{ "type":"object", "additionalProperties":{ "type":"string" } } }, "xml":{ "name":"result" } }, "ScriptList":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/Script" } }, "count":{ "type":"integer", "format":"int64" }, "totalResults":{ "type":"integer", "format":"int64" }, "hasMore":{ "type":"boolean" }, "limit":{ "type":"integer", "format":"int64" }, "properties":{ "type":"object", "additionalProperties":{ "type":"string" } }, "offset":{ "type":"integer", "format":"int64" } } }, "SessionAttributes":{ "type":"object", "properties":{ "userId":{ "description":"Logged in username.
", "type":"string" }, "sessionId":{ "description":"Numeric session ID.
", "type":"string" }, "loginTimeInSeconds":{ "description":"Number of seconds ago the session began.
", "type":"string" }, "application":{ "description":"Name of active application.
", "type":"string" }, "database":{ "description":"Name of active database.
", "type":"string" }, "dbConnectTimeInSeconds":{ "description":"Number of seconds ago the database was set active.
", "type":"string" }, "request":{ "description":"Type of active request in progress; for example, calculation, data load, or restructure. This information can help you get details about what is occurring during lengthy sessions.
", "type":"string" }, "requestTimeInSeconds":{ "description":"Number of seconds the active request has been running.
", "type":"string" }, "connectionSource":{ "description":"Host name of the connected service.
", "type":"string" }, "requestState":{ "description":"The status of the active request.
", "type":"string" } } }, "StreamProcessEndResponse":{ "type":"object", "properties":{ "status":{ "type":"string" }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } } } }, "StreamProcessStartResponse":{ "type":"object", "properties":{ "streamId":{ "type":"string" }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } } } }, "DataLoadStartPayload":{ "type":"object", "properties":{ "ruleFileName":{ "description":"Name of the rule file to use for the data load. Omit the file extension.
", "type":"string" }, "delimiter":{ "type":"string", "description":"Currently, only Comma is supported as the delimiter for streaming data load.
" } } }, "DimBuildStartPayload":{ "type":"object", "properties":{ "restructureOption":{ "description":"Restructure option. PRESERVE_ALL_DATA to preserve all existing data (this is the default), PRESERVE_NO_DATA to discard all existing data, PRESERVE_LEAFLEVEL_DATA to preserve existing level 0 blocks (applicable to block storage only), PRESERVE_INPUT_DATA to preserve existing input-level blocks (applicable to block storage only).
", "type":"string", "enum":[ "PRESERVE_ALL_DATA", "PRESERVE_LEAFLEVEL_DATA", "PRESERVE_INPUT_DATA", "PRESERVE_NO_DATA" ] } } }, "Variable":{ "type":"object", "properties":{ "name":{ "type":"string" }, "value":{ "type":"string" }, "appName":{ "type":"string" }, "dbName":{ "type":"string" }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } } } }, "VariableList":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/Variable" } }, "count":{ "type":"integer", "format":"int64" }, "totalResults":{ "type":"integer", "format":"int64" }, "hasMore":{ "type":"boolean" }, "limit":{ "type":"integer", "format":"int64" }, "properties":{ "type":"object", "additionalProperties":{ "type":"string" } }, "offset":{ "type":"integer", "format":"int64" } } }, "Cron":{ "type":"object", "properties":{ "years":{ "type":"array", "items":{ "type":"integer", "format":"int32" } }, "minutes":{ "type":"array", "items":{ "type":"integer", "format":"int32" } }, "hours":{ "type":"array", "items":{ "type":"integer", "format":"int32" } }, "daysOfMonth":{ "type":"array", "items":{ "type":"integer", "format":"int32" } }, "months":{ "type":"array", "items":{ "type":"integer", "format":"int32" } }, "daysOfWeek":{ "type":"array", "items":{ "type":"integer", "format":"int32" } } } }, "MaintenanceWindow":{ "type":"object", "properties":{ "windows":{ "type":"array", "items":{ "$ref":"#/components/schemas/Cron" } }, "duration":{ "type":"integer", "format":"int32" } } }, "Settings":{ "type":"object", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } } } }, "Limit":{ "type":"object", "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" }, "value":{ "type":"string" }, "description":{ "type":"string" }, "unlimited":{ "type":"boolean" }, "showUnlimited":{ "type":"boolean" }, "minimum":{ "type":"integer", "format":"int64" }, "maximum":{ "type":"integer", "format":"int64" } } }, "Limits":{ "type":"object", "properties":{ "coreFileSize":{ "$ref":"#/components/schemas/Limit" }, "dataSegmentSize":{ "$ref":"#/components/schemas/Limit" }, "maxMemory":{ "$ref":"#/components/schemas/Limit" }, "openFiles":{ "$ref":"#/components/schemas/Limit" }, "userMaxProcesses":{ "$ref":"#/components/schemas/Limit" }, "virtualMemorySize":{ "$ref":"#/components/schemas/Limit" }, "webLogicHeapSize":{ "$ref":"#/components/schemas/Limit" } } }, "ODLLogHandlerSetting":{ "type":"object", "properties":{ "handlerName":{ "type":"string" }, "logType":{ "type":"string" }, "maxLogSize":{ "type":"string" }, "maxAllLogSize":{ "type":"string" }, "rotationPeriod":{ "type":"string" }, "rotationPeriodCustom":{ "type":"string" }, "retentionPeriod":{ "type":"string" }, "retentionPeriodCustom":{ "type":"string" }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } } } } } }, "swagger":"2.0", "tags":[ { "name":"AI", "description":"The operations from the AI category." }, { "name":"About Essbase", "description":"The operations from the About Essbase category." }, { "name":"Aggregate Storage Load Buffers", "description":"The operations from the Aggregate Storage Load Buffers category." }, { "name":"Application Configuration", "description":"The operations from the Application Configuration category." }, { "name":"Application Connections", "description":"The operations from the Application Connections category." }, { "name":"Application Datasources", "description":"The operations from the Application Datasources category." }, { "name":"Application Logs", "description":"The operations from the Application Logs category." }, { "name":"Application Role Provisioning", "description":"The operations from the Application Role Provisioning category." }, { "name":"Application Settings and Statistics", "description":"The operations from the Application Settings and Statistics category." }, { "name":"Applications", "description":"The operations from the Applications category." }, { "name":"Audit Trail", "description":"The operations from the Audit Trail category." }, { "name":"Batch Outline Editing", "description":"The operations from the Batch Outline Editing category." }, { "name":"CentralizedURL", "description":"The operations from the CentralizedURL category." }, { "name":"Cube designer", "description":"The operations from the Cube designer category." }, { "name":"Database Settings and Statistics", "description":"The operations from the Database Settings and Statistics category." }, { "name":"Database Size Statistics", "description":"The operations from the Database Size Statistics category." }, { "name":"Dimensions", "description":"The operations from the Dimensions category." }, { "name":"Drill Through Reports", "description":"The operations from the Drill Through Reports category." }, { "name":"Email", "description":"The operations from the Email category." }, { "name":"Essbase Configuration", "description":"The operations from the Essbase Configuration category." }, { "name":"Execute MDX", "description":"The operations from the Execute MDX category." }, { "name":"File Scanner", "description":"The operations from the File Scanner category." }, { "name":"Files", "description":"The operations from the Files category." }, { "name":"Filters", "description":"The operations from the Filters category." }, { "name":"Global Connections", "description":"The operations from the Global Connections category." }, { "name":"Global Datasources", "description":"The operations from the Global Datasources category." }, { "name":"Grid", "description":"The operations from the Grid category." }, { "name":"Grid Preferences", "description":"The operations from the Grid Preferences category." }, { "name":"Group Provisioning Report", "description":"The operations from the Group Provisioning Report category." }, { "name":"Groups", "description":"The operations from the Groups category." }, { "name":"Jobs", "description":"The operations from the Jobs category." }, { "name":"Layouts", "description":"The operations from the Layouts category." }, { "name":"Location Aliases", "description":"The operations from the Location Aliases category." }, { "name":"Locks", "description":"The operations from the Locks category." }, { "name":"MDX Reports", "description":"The operations from the MDX Reports category." }, { "name":"Object Storage Configuration", "description":"The operations from the Object Storage Configuration category." }, { "name":"Outline Viewer", "description":"The operations from the Outline Viewer category." }, { "name":"Partitions", "description":"The operations from the Partitions category." }, { "name":"Performance Analyzer", "description":"The operations from the Performance Analyzer category." }, { "name":"Platform Service Settings", "description":"The operations from the Platform Service Settings category." }, { "name":"Preferences", "description":"The operations from the Preferences category." }, { "name":"Properties", "description":"The operations from the Properties category." }, { "name":"ROCluster", "description":"The operations from the ROCluster category." }, { "name":"Roles", "description":"The operations from the Roles category." }, { "name":"Rules", "description":"The operations from the Rules category." }, { "name":"Sandbox Dimension", "description":"The operations from the Sandbox Dimension category." }, { "name":"Scenarios", "description":"The operations from the Scenarios category." }, { "name":"Scripts", "description":"The operations from the Scripts category." }, { "name":"Server Variables", "description":"The operations from the Server Variables category." }, { "name":"Server logs", "description":"The operations from the Server logs category." }, { "name":"Service Role Provisioning", "description":"The operations from the Service Role Provisioning category." }, { "name":"Sessions", "description":"The operations from the Sessions category." }, { "name":"Streaming Data Load", "description":"The operations from the Streaming Data Load category." }, { "name":"Streaming Dimension Build", "description":"The operations from the Streaming Dimension Build category." }, { "name":"Templates and Utilities", "description":"The operations from the Templates and Utilities category." }, { "name":"URLs", "description":"The operations from the URLs category." }, { "name":"User Provisioning Report", "description":"The operations from the User Provisioning Report category." }, { "name":"User Session", "description":"The operations from the User Session category." }, { "name":"Users", "description":"The operations from the Users category." }, { "name":"Variables", "description":"The operations from the Variables category." }, { "name":"Workbook Utilities", "description":"The operations from the Workbook Utilities category." } ] }