Get a connection for an application
get
/epm/rest/v1/applications/{applicationId}/connections/{connectionId}
Request
Path Parameters
-
applicationId(required): string(uuid)
-
connectionId(required): string(uuid)
Pattern:
[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
Response
Supported Media Types
- application/json
200 Response
Connection found
Root Schema : Connection
Type:
Show Source
object
-
connectionDetails:
string
Read Only:
true
A string containing a json representation of the connection details -
connectionInfo:
object ConnectionInfo
-
description:
string
Read Only:
true
The description of the connection -
id:
string(uuid)
Read Only:
true
-
links:
array links
Read Only:
true
-
name:
string
Read Only:
true
The name of the connection -
primary:
boolean
A flag indicating if this is the primary connection for this application
Nested Schema : ConnectionInfo
Type:
Show Source
object
-
domain:
string
The identity domain for the connection
-
password:
string
Read Only:
true
A placeholder value for the connection's password -
url:
string
Read Only:
true
The target url of the connection -
username:
string
Read Only:
true
The user name to authenticate the connection
404 Response
Connection not found
Examples
The following example shows how to get the details of a specific application 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/applications/e63e92c4-4727-4999-97f2-50498cb40ec7/connections/ea2328ed-48d3-45dd-b033-fc447a5e2a77
Example of Response Body
The following shows an example of the response body in JSON format.
{ "id": "ea2328ed-48d3-45dd-b033-fc447a5e2a77", "name": "Production", "description": "Production Pod", "connectionDetails": "{\"url\":\"http[s]://hostname[:port]\",\"domain\":\"\",\"username\":\"User1\",\"password\":\"daa64d99-9c88-4109-a75b-c9756b7d0796\"}", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/applications/e63e92c4-4727-4999-97f2-50498cb40ec7/connections/ea2328ed-48d3-45dd-b033-fc447a5e2a77" }, { "rel": "edit", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/applications/e63e92c4-4727-4999-97f2-50498cb40ec7/connections/ea2328ed-48d3-45dd-b033-fc447a5e2a77", "method": "PUT" }, { "rel": "testConnection", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/applications/e63e92c4-4727-4999-97f2-50498cb40ec7/connections/ea2328ed-48d3-45dd-b033-fc447a5e2a77/test", "method": "POST" }, { "rel": "connectionResources", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/applications/e63e92c4-4727-4999-97f2-50498cb40ec7/connections/ea2328ed-48d3-45dd-b033-fc447a5e2a77/resources", "templated": true, "method": "GET" } ], "connectionInfo": { "url": "http[s]://hostname[:port]", "username": "User1", "password": "daa64d99-9c88-4109-a75b-c9756b7d0796", "domain": "" }, "primary": true }