Configure the Oracle Guided Learning (OGL) Server

Use this REST API to update the Oracle Guided Learning (OGL) server URL and application ID in application settings. This makes the process of updating the OGL server configuration more efficient than configuring it manually in application settings.

You can also use a REST API to get the value of the Oracle Guided Learning (OGL) Application ID and Server URL in application settings. See Get Applications.

Required Roles

Service Administrator

REST Resource

POST /HyperionPlanning/rest/{api_version}/applications/(application)/(jobs)

Request

Supported Media Types: application/json

Parameters:

The following table summarizes the client request parameters specific to this job. For parameters that are common to all jobs, see Execute a Job.

Using this REST API requires prerequisites, such as understanding how to use jobs. See Prerequisites. Be sure that you understand how to use jobs as described in Managing Jobs.

Table 8-39 Parameters

Name	Description	Required	Default
jobType	OGL Server Settings	Yes	None
jobName	The name of this job. Example: Set OGL Parameters	No	None
parameters	You can specify these parameters: oglAppId: the value of the OGL application ID to be set in application settings. For more information, see Integrating EPM Cloud and EDM Cloud with Oracle Guided Learning. oglServerUrl: The value of the OGL Server URL to be set in application settings. For more information, see Integrating EPM Cloud and EDM Cloud with Oracle Guided Learning. Notes: One of these parameters must be specified to update the OGL settings. The OGL application ID must not be more than 100 characters. The OGL server URL must not be more than 300 characters.	No	No

Example URL and Payload

https://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/jobs

Payload Example: Sets the OGL application ID and server URL in application settings.

{
    "jobType": "OGL Server Settings",
    "jobName": "Set OGL Parameters",
    "parameters":
        {
             "oglAppId": "vcQ6fAsJRySX_SSGc581Vg",
             "oglServerUrl": "https://guidedlearning.oracle.com"
        }
}