Get a global connection
get
/epm/rest/v1/globalConnections/{globalConnectionId}
Request
Path Parameters
Back to Top
Response
Supported Media Types
- application/json
200 Response
GlobalConnection found
Root Schema : GlobalConnection
Type:
Show Source
object
-
connectionDetails:
object Global Connection Details
Discriminator:
type
The details specific to this connection type. All connection types include "type", the type of the connection, see the 'type' object for allowed values, "url", the updated url for the connection, "username", the updated username for the connection, and "password", the updated password for the connection. EPM connections also include "identityDomain", the updated identity domain for the connection, and "folder", the updated epm folder. UCM connections also include "identityDomain", the updated identity domain for the connection, and "defaultDocumentAccount", the updated default document account. Oracle Object Store connections also include "defaultBucket", the updated name of the default target bucket and "defaultBucket", an optional parameter for the sub folder in the target bucket. -
connectionType:
string
Read Only:
true
Allowed Values:[ "ORACLE_OBJECT_STORE", "UCM", "EPM" ]
-
createdByUser:
object User
-
description:
string
Read Only:
true
-
id:
string(uuid)
Read Only:
true
-
links:
array links
Read Only:
true
-
modifiedByUser:
object User
-
name:
string
Read Only:
true
-
supportedApplications:
array supportedApplications
Read Only:
true
-
timeCreated:
integer(int64)
Read Only:
true
-
timeModified:
integer(int64)
Read Only:
true
Nested Schema : Global Connection Details
Type:
object
Discriminator:
type
The details specific to this connection type. All connection types include
"type", the type of the connection, see the 'type' object for allowed values,
"url", the updated url for the connection,
"username", the updated username for the connection, and
"password", the updated password for the connection.
EPM connections also include
"identityDomain", the updated identity domain for the connection, and
"folder", the updated epm folder.
UCM connections also include
"identityDomain", the updated identity domain for the connection, and
"defaultDocumentAccount", the updated default document account.
Oracle Object Store connections also include
"defaultBucket", the updated name of the default target bucket and
"defaultBucket", an optional parameter for the sub folder in the target bucket.
Show Source
-
type(required):
string
Read Only:
true
Allowed Values:[ "ORACLE_OBJECT_STORE", "EPM", "UCM" ]
Type is set to "EPM" for Oracle EPM Cloud connections, "UCM" for Oracle ERP Cloud connections and "ORACLE_OBJECT_STORE" for Oracle Object Store connections.
Nested Schema : User
Type:
Show Source
object
-
artifactAssignments:
array artifactAssignments
-
associatedRoles:
array associatedRoles
-
dataManagerOnAny:
boolean
-
emailAddresses:
array emailAddresses
-
epmIdleSessionTimeout:
integer(int32)
-
firstName:
string
-
fullName:
string
-
grantPermission:
string
Allowed Values:
[ "OWNER", "DATAMANAGER", "PARTICIPANT", "APPROVER", "NOTIFIED", "COMMITTER", "NONE", "METADATAMANAGER" ]
-
homePageLayoutName:
string
-
id:
string(uuid)
-
lastName:
string
-
links:
array links
-
nameInitials:
string
-
preferences:
object Preferences
-
ssoToken:
string
-
userName:
string
Nested Schema : Artifact
Type:
Show Source
object
-
id:
string(uuid)
-
name:
string
-
type:
string
Allowed Values:
[ "CLUSTER", "CARD" ]
Nested Schema : IdNameLink
Type:
Show Source
object
-
description:
string
Read Only:
true
-
id:
string(uuid)
-
links:
array links
-
name:
string
404 Response
GlobalConnection not found
Examples
The following example shows how to get the details of a specific global connection by using a get request on the REST resource using cURL.
cURL Command
curl --user epm_cloud_user -X GET https://servername.fa.us2.oraclecloud.com/epm/rest/v1/globalConnections/b3ee4f46-9b49-4422-b8b5-7113038e7015
Example of Response Body
The following shows an example of the response body in JSON format.
{ "id": "b3ee4f46-9b49-4422-b8b5-7113038e7015", "name": "Fusion", "description": "Fusion", "connectionDetails": { "url": "http[s]://hostname[:port]", "username": "User1", "password": "daa64d99-9c88-4109-a75b-c9756b7d0796", "type": "UCM" }, "connectionType": "UCM", "timeCreated": "2021-06-16T08:57:04.163Z", "timeModified": "2022-01-05T03:22:07.488Z", "supportedApplications": [], "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/globalConnections/b3ee4f46-9b49-4422-b8b5-7113038e7015" }, { "rel": "edit", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/globalConnections/b3ee4f46-9b49-4422-b8b5-7113038e7015", "method": "PUT" }, { "rel": "delete", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/globalConnections/b3ee4f46-9b49-4422-b8b5-7113038e7015", "method": "DELETE" }, { "rel": "testConnection", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/globalConnections/b3ee4f46-9b49-4422-b8b5-7113038e7015/test", "method": "POST" } ], "createdByUser": { "id": "d93d33f8-f24e-4eaa-8c14-df45501d949a", "userName": "Casey.Brown", "fullName": "Casey Brown", "firstName": "Casey", "lastName": "Brown", "emailAddresses": [], "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/d93d33f8-f24e-4eaa-8c14-df45501d949a" } ], "nameInitials": "" }, "modifiedByUser": { "id": "d93d33f8-f24e-4eaa-8c14-df45501d949a", "userName": "Casey.Brown", "fullName": "Casey Brown", "firstName": "Casey", "lastName": "Brown", "emailAddresses": [], "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/d93d33f8-f24e-4eaa-8c14-df45501d949a" } ], "nameInitials": "" } }