REST API to view all the connections to Oracle Integration Cloud using Task Manager

Required Roles

Service Administrator

REST Resource

GET /HyperionPlanning/rest/fcmapi/{api_version}/{module}/connections

Request

Parameters:

The following table summarizes the client request.

Table 19-9 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 you want to view the connections. Set this value to FCM.	Path	Yes	None

Response

Supported Media Types: application/json

The following table summarizes the parameters.

Table 19-10 Parameters

Parameters	Description
`items`	Collection of information about the resource
`id`	Unique identifier for the connection
`type`	The type of connection. For Oracle Integration Cloud, set this value to ICS.
`url`	The URL of the Integration Cloud environment. Note: The URL must be provided only till the server name, which is oraclecloud.com.
`authType`	Type of authentication: Basic OAuth
`oauthProperties`	Provides the access token, client ID, and scope of the URL for OAuth 2.0 authentication.
`details`	In case of errors, details are published with the error string

Example Response - Basic Authentication

{
    "links": [
        {
            "rel": "self",
            "href": "<URL of Oracle Integration Cloud>",
            "action": "GET"
        }
    ],
    "details": null,
    "items": [
        {
            "username": "ats_admin2",
            "password": null,
            "url": "<URL of Oracle Integration Cloud>",
            "id": 100000000558008,
            "type": "ICS"
            "authType": "BASIC"
        }
    ]
}

Example Response - OAuth 2.0 Authentication

{
    "details": null,
    "items": [
        {
            "id": 100000000037009,
            "url": "<URL of Oracle Integration Cloud>",
            "type": "ICS",
            "authType": "OAUTH2",
            "oauthProperties": {
                "accessTokenUrl": "<Access token URL>",
                "clientId": "<Client ID>",
                "scope": "<Scope URL>"
            }
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "<URL of Oracle Integration Cloud>",
            "action": "GET"
        }
    ]
}