List Utilities
get
/essbase/rest/v1/utilities
Returns available utilities. For example: Export Utility, Smart View for Essbase.
Request
There are no request parameters for this operation.
Back to TopResponse
Supported Media Types
- application/json
- application/xml
200 Response
OK
Utilities returned successfully.
400 Response
Bad Request
Failed to get utilities.
Examples
The following example shows how to get a list of available Essbase utilities.
This example uses cURL to access the REST API from a Windows shell script. The calling user's ID and password are variables whose values are set in properties.bat.
Script with cURL Command
call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/utilities" -H "accept: application/json" -u %User%:%Password%Example of Response Body
The following example shows the contents of the response body in JSON format:
{
"items" : [ {
"id" : "exportutility",
"name" : "11g Excel Export Utility",
"description" : "Exports Essbase 11g applications to application workbooks. You can use the application workbooks to re-create the applications on the current Essbase version.",
"provider" : "Oracle",
"mimeType" : "application/zip",
"category" : "Command Line Tools",
"links" : [ {
"rel" : "download",
"href" : "https://myserver.example.com:9001/essbase/rest/v1/utilities/exportutility",
"method" : "get",
"type" : "application/zip"
} ]
}, {
"id" : "smartview",
"name" : "Smart View for Essbase",
"description" : "Smart View for Essbase",
"provider" : "Oracle",
"url" : "http://www.oracle.com/technetwork/middleware/smart-view-for-office/overview/index.html",
"category" : "Smart View"
}, {
"id" : "lcm",
"name" : "11g LCM Export Utility",
"description" : "Exports artifacts from Essbase 11g On-Premise as a .zip file, which you can import in to Essbase 12c or higher. This Life Cycle Management (LCM) utility can also be used to export from, and import to, 11g releases of Essbase. This utility packages into a zip everything you need to support migration to the current version.",
"provider" : "Oracle",
"mimeType" : "application/zip",
"category" : "Command Line Tools",
"links" : [ {
"rel" : "download",
"href" : "https://myserver.example.com:9001/essbase/rest/v1/utilities/lcm",
"method" : "get",
"type" : "application/zip"
} ]
}, {
"id" : "cli",
"name" : "Command Line Interface (CLI)",
"description" : "A scripting interface that uses REST APIs to perform most common Essbase administrative actions. The CLI includes an LCMImport command you can use for migrating 11g LCM Export Utility .zip files exported from Essbase 11g On-Premise. The LCMExport and LCMImport commands also facilitate migrating applications between instances, on versions 12c or higher.",
"provider" : "Oracle",
"mimeType" : "application/zip",
"category" : "Command Line Tools",
"links" : [ {
"rel" : "download",
"href" : "https://myserver.example.com:9001/essbase/rest/v1/utilities/cli",
"method" : "get",
"type" : "application/zip"
} ]
}, {
"id" : "migrationTool",
"name" : "Migration Utility",
"description" : "Utility to manage migration of an entire Essbase instance, for Essbase 12c or higher. In addition to migrating application artifacts, this utility also helps you migrate user role assignments and users/groups from supported identity providers.",
"provider" : "Oracle",
"mimeType" : "application/zip",
"category" : "Command Line Tools",
"links" : [ {
"rel" : "download",
"href" : "https://myserver.example.com:9001/essbase/rest/v1/utilities/migrationTool",
"method" : "get",
"type" : "application/zip"
} ]
}, {
"id" : "EssbaseMaxlClient",
"name" : "Essbase Maxl Client",
"description" : "Essbase Maxl Client for Winamd64",
"provider" : "Oracle",
"mimeType" : "application/zip",
"category" : "Maxl Clients",
"links" : [ {
"rel" : "download",
"href" : "https://myserver.example.com:9001/essbase/rest/v1/utilities/EssbaseMaxlClient",
"method" : "get",
"type" : "application/zip"
} ]
}, {
"id" : "EssbaseLinuxMaxlClient",
"name" : "Essbase Linux Maxl Client",
"description" : "Essbase Maxl Client for Linuxamd64",
"provider" : "Oracle",
"mimeType" : "application/zip",
"category" : "Maxl Clients",
"links" : [ {
"rel" : "download",
"href" : "https://myserver.example.com:9001/essbase/rest/v1/utilities/EssbaseLinuxMaxlClient",
"method" : "get",
"type" : "application/zip"
} ]
}, {
"id" : "EssbaseClientLinux",
"name" : "Essbase Client Linux",
"description" : "Essbase Client Linux",
"provider" : "Oracle",
"mimeType" : "application/zip",
"category" : "Essbase Clients",
"links" : [ {
"rel" : "download",
"href" : "https://myserver.example.com:9001/essbase/rest/v1/utilities/EssbaseClientLinux",
"method" : "get",
"type" : "application/zip"
} ]
}, {
"id" : "EssbaseClientWindows",
"name" : "Essbase Client Windows",
"description" : "Essbase Client Windows",
"provider" : "Oracle",
"mimeType" : "application/zip",
"category" : "Essbase Clients",
"links" : [ {
"rel" : "download",
"href" : "https://myserver.example.com:9001/essbase/rest/v1/utilities/EssbaseClientWindows",
"method" : "get",
"type" : "application/zip"
} ]
}, {
"id" : "EssbaseClientMacosx",
"name" : "Essbase Client Macosx",
"description" : "Essbase Client Macosx",
"provider" : "Oracle",
"mimeType" : "application/zip",
"category" : "Essbase Clients",
"links" : [ {
"rel" : "download",
"href" : "https://myserver.example.com:9001/essbase/rest/v1/utilities/EssbaseClientMacosx",
"method" : "get",
"type" : "application/zip"
} ]
}, {
"id" : "japi",
"name" : "Essbase Java API",
"description" : "Essbase Java API library, samples and Java documentation",
"provider" : "Oracle",
"mimeType" : "application/zip",
"category" : "Essbase JAPI"
}, {
"id" : "esscdext",
"name" : "Cube Designer Extension",
"description" : "Cube Designer Extension for Essbase Smart View",
"provider" : "Oracle",
"mimeType" : "application/vnd.microsoft.portable-executable",
"category" : "Smart View",
"links" : [ {
"rel" : "download",
"href" : "https://myserver.example.com:9001/essbase/rest/v1/utilities/esscdext",
"method" : "get",
"type" : "application/vnd.microsoft.portable-executable"
} ]
}, {
"id" : "EASConsole",
"name" : "Essbase Administration Services console",
"description" : "Essbase Administration Services console",
"provider" : "Oracle",
"mimeType" : "application/zip",
"category" : "Essbase Administration",
"links" : [ {
"rel" : "download",
"href" : "https://myserver.example.com:9001/essbase/rest/v1/utilities/EASConsole",
"method" : "get",
"type" : "application/zip"
} ]
} ]
}