Update a Connection

Use this REST API to update a specific connection that is saved in an application.

You can update the values using either a plain text password or encrypted password. The response returns the updated connection details.

REST Resource

GET /HyperionPlanning/rest/epm/{api_version}/applications/{application}/connections/{connectionRef}

Request

Supported Media Types: application/json

Parameters:

The following table summarizes the client request.

Table 5-93 Parameters

Name Description Type Required Default
api_version Version of the API you are developing with Path Yes None
application The name of the application for which to update a connection Path Yes None
connectionRef The connection to refer to. The value can be either a connection name or ID. Path Yes None

Table 5-94 Parameters for Connection Information that Can Be Modified

Name Description
name Name of the connection, such as Connection29
description Description of the connection, such as Planning
url The URL of the connection, such as https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning
username The username for the connection, such as admin
password The password of the connection
encryptedPassword The password of the connection in the encrypted format using the EPM Automate encrypt command. See encrypt.

Example Body

Example 1:

{
    "name": "<NEW_CONNECTION_NAME>",
    "description": "<NEW_DESCRIPTION>",
    "url": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning",
    "username": "<NEW_USERNAME>",
    "password": "<NEW_PASSWORD>"
}

Example 2:

{
    "name": "<NEW_CONNECTION_NAME>",
    "description": "<NEW_DESCRIPTION>",
    "url": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning",
    "username": "<NEW_USERNAME>",
    "encryptedPassword": "<ENCRYPTED_PASSWORD>"
}

Response

Supported Media Type: application/json

Table 5-95 Parameters

Parameters Description
items Collection of information about the resource
id Unique identifier for the connection, such as 1c89922d-92ba-46c1-850f-e2a8a416ddf2
name Name of the connection, such as Connection29
description Description of the connection, such as Planning
url The URL of the connection, such as https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning
username The username for the connection, such as admin
modified The time stamp of the last modification to the connection details, such as 2021-01-18 12:23:49.0
modifiedBy The last service administrator to modify the connection details, such as admin
{
    "id": "<ID>",
    "name": "<NEW_CONNECTION_NAME>",
    "description": "<NEW_DESCRIPTION>",
    "url": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning",
    "username": "<NEW_USERNAME>",
    "modified": "2021-02-02 09:16:02.0",
    "modifiedBy": "admin",
    "links": [
        {
            "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/epm/v1/applications/epbcs1/connections/f83b3da2-9505-415e-b7f7-3cf113cc94e4",
            "action": "GET",
            "rel": "self",
            "data": null
        }
    ]
}