Get Applications

This REST API returns a list of applications to which the specified user is assigned. It also provides certain key information about the application.

Required Roles

Service Administrator

REST Resource

GET /HyperionPlanning/rest/{api_version}/applications

Request

Supported Media Types: application/json

Parameters:

The following table summarizes the client request.

Table 8-52 Parameters

Name	Description	Type	Required	Default
api_version	Version of the API you are developing with	Path	Yes	None

Response

Supported Media Types: application/json

Parameters:

Table 8-53 Parameters

Name	Description
Items	A list of applications
name	Application name
type	Product type. Possible values: HFM, HP
adminMode	Indicates if the application's login level is set to Administrators. Returns a Boolean value where true indicates that the login level for the application is set to Administrators and false indicates that the login level is set to All Users.
theme	Current theme of the application. Possible values: REDWOOD_ORACLE_R13 REDWOOD_LIGHT_R13 REDWOOD_DARK_R13
webBotDetails	Web bot details of the application
webBotAppId	Web bot application ID register for the application
dpEnabled	Indicates if decision package is enabled in the application. Returns a Boolean value true when enabled.
unicode	Indicates if the application is Unicode enabled. Returns a Boolean value where true indicates that the application is Unicode enabled.
appStorage	Returns the storage type of the application, such as Default, Multidim, or ASO.
appType	Business process type. Possible values are PBCS, EPBCS, and so on.
hybrid	Indicates if the hybrid configuration is enabled in the application. Returns a Boolean value true when enabled.
oglServerUrl	The value of the Oracle Guided Learning (OGL) Server URL in the application settings. For more information, see Integrating EPM Cloud with Oracle Guided Learning in Oracle Guided Learning User Guide. Note that you can use a REST API to configure the OGL Server URL. See Configure the Oracle Guided Learning (OGL) Server.
oglAppId	The value of the Oracle Guided Learning (OGL) Application ID in the application settings. For more information, see Integrating EPM Cloud with Oracle Guided Learning in Oracle Guided Learning User Guide. Note that you can use a REST API to configure the OGL Application ID. See Configure the Oracle Guided Learning (OGL) Server.

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "type": "HP",
    "items": [
        {
            "appType": "PBCS",
            "webBotDetails": "null",
            "helpServerUrl": "https://www.oracle.com",
            "workpaceServerUrl": "https://<BASE-URL>",
            "appStorage": "Multidim",
            "unicode": true,
            "name": "Vision",
            "type": "HP",
            "adminMode": "true",
            "theme": "REDWOOD_LIGHT_R13",
            "hybrid": "true"
            "oglServerUrl":"https://guidedlearning.oracle.com",
            "oglAppId":"vcQ6fAsJRySX_SSGc581Vg"
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://<BASE-URL>",
            "action": "GET"
        }
    ]
}