REST API to update a specific connection to Oracle Integration Cloud using Task Manager

REST Resource

PUT /HyperionPlanning/rest/fcmapi/{api_version}/{module}/connections/{id}

Required Roles

Service Administrator

Request

Supported Media Types: application/json

Parameters:

The following table summarizes the client request.

Table 19-11 Parameters

Name	Description	Type	Required	Default
`api_version`	Version of the API you are developing with (must be v1)	Path	Yes	None
`module`	The name of the module for which to update a connection. Set this value to FCM.	Path	Yes	None
`id`	The identifier of the connection that must be updated	Path	Yes	None
`url`	The URL of the Integration Cloud environment. Note: The URL must be provided only till the server name, which is oraclecloud.com.	Payload	Yes	None
`authType`	Type of authentication: Basic OAuth Note: The parameter is applicable only for OAuth 2.0 authentication type.
`oauthProperties`	Specify the access token, client ID, and scope of the URL for OAuth 2.0 authentication. Note: The parameter is applicable only for OAuth 2.0 authentication type.
`username`	A username with Service Administrator predefined role. Note: This parameter is applicable only for basic authentication type.	Payload	Yes	None
`password`	The encrypted password for the user. For security reasons, only an encrypted password is allowed. Use the EPM Automate encrypt command to generate the encrypted password. See encrypt . Note: This parameter is applicable only for basic authentication type.	Payload	Yes	None
`type`	The type of connection. For Oracle Integration Cloud, set this value to ICS.	Payload	Yes	None

Example of Request Body - Basic Authentication

{
    "url": "<URL of Oracle Integration Cloud>",
    "username": "<NEW_USERNAME>",
    "password": "<NEW_PASSWORD>"
    "authType": "BASIC"
}

Example of Request Body – OAuth 2.0 Authentication

  {
     "url": "<URL of Oracle Integration Cloud>",
      "type": "ICS",
      "authType": "OAUTH2",
      "oauthProperties": {
                "accessTokenUrl": "<Access token URL>",
                "clientId": "<Client ID>",
                "scope": "<Scope URL>",
                "clientSecret": "<EPMAUTOMATE Encrypted password>"
            }
}

Response

Supported Media Type: application/json

Table 19-12 Parameters

Parameters	Description
`details`	In case of errors, details are published with the error string.

Example of Response Body

Example 1:

{
  "details": "Connection updated successfully."
}

Example 2:

{
  "details": "Invalid parameters. Test Connection is failed"
}