Jump to

• Request
• Response
• Examples

Get all connections for an application

get

/epm/rest/v1/applications/{applicationId}/connections

Request

Path Parameters

• applicationId(required): string(uuid)

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : ItemsConnections

Type: object

Show Source

• count: integer(int32)
• hasMore: boolean
• items: array items
  Read Only: true
• limit: integer(int32)
• links: array links
  Read Only: true
• offset: integer(int32)
• totalResults: integer(int32)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Connection"
            }
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "hasMore":{
            "type":"boolean"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "limit":{
            "type":"integer",
            "format":"int32"
        },
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "offset":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : items

Type: array

Read Only: true

Show Source

• Array of: object Connection

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Connection"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Connection

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "description":"The name of the connection",
            "readOnly":true
        },
        "description":{
            "type":"string",
            "description":"The description of the connection",
            "readOnly":true
        },
        "connectionDetails":{
            "type":"string",
            "description":"A string containing a json representation of the connection details",
            "readOnly":true
        },
        "primary":{
            "type":"boolean",
            "description":"A flag indicating if this is the primary connection for this application"
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "connectionInfo":{
            "description":"The url and authentication information for the connection",
            "readOnly":true,
            "$ref":"#/definitions/ConnectionInfo"
        }
    }
}

Nested Schema : ConnectionInfo

Type: object

Show Source

• accessToken: string
  Read Only: true

  A placeholder value for the connection's access token
• clientId: string
  Read Only: true

  A placeholder value for the connection's clientId
• domain: string
  The identity domain for the connection
• password: string
  Read Only: true

  A placeholder value for the connection's password
• refreshToken: string
  Read Only: true

  A placeholder value for the connection's refresh token
• url: string
  Read Only: true

  The target url of the connection
• username: string
  Read Only: true

  The user name to authenticate the connection

{
    "type":"object",
    "properties":{
        "url":{
            "type":"string",
            "description":"The target url of the connection",
            "readOnly":true
        },
        "username":{
            "type":"string",
            "description":"The user name to authenticate the connection",
            "readOnly":true
        },
        "password":{
            "type":"string",
            "description":"A placeholder value for the connection's password",
            "readOnly":true
        },
        "clientId":{
            "type":"string",
            "description":"A placeholder value for the connection's clientId",
            "readOnly":true
        },
        "accessToken":{
            "type":"string",
            "description":"A placeholder value for the connection's access token",
            "readOnly":true
        },
        "refreshToken":{
            "type":"string",
            "description":"A placeholder value for the connection's refresh token",
            "readOnly":true
        },
        "domain":{
            "type":"string",
            "description":"The identity domain for the connection"
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• method: string
• rel: string
• templated: boolean

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "templated":{
            "type":"boolean"
        },
        "method":{
            "type":"string"
        }
    }
}

Back to Top

Examples

The following example shows how to retrieve the list of connections for an application by submitting 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

Example of Response Body

The following shows an example of the response body in JSON format.

{
  "items": [
    {
      "id": "445e92f5-e232-4100-b709-a875c06cf294",
      "name": "Corporate Planning Server",
      "description": "",
      "connectionDetails": "{\"url\":\"http://epbcsserver/\",\"domain\":\"myidenitydomain\",\"username\":\"user\",\"password\":\"daa64d99-9c88-4109-a75b-c9756b7d0796\"}",
      "primary": true,
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/applications/e63e92c4-4727-4999-97f2-50498cb40ec7/connections/445e92f5-e232-4100-b709-a875c06cf294"
        },
        {
          "rel": "connectionResources",
          "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/applications/e63e92c4-4727-4999-97f2-50498cb40ec7/connections/445e92f5-e232-4100-b709-a875c06cf294/resources",
          "templated": true,
          "method": "GET"
        }
      ]
    },
    {
      "id": "b0228ab4-0078-4e17-a7b3-9becf5e77c68",
      "name": "Backup Planning Server",
      "description": "",
      "connectionDetails": "{\"url\":\"http://backupserver/epbcs\",\"domain\":\"identitydomain\",\"username\":\"sampleUser\",\"password\":\"daa64d99-9c88-4109-a75b-c9756b7d0796\"}",
      "primary": false,
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/applications/e63e92c4-4727-4999-97f2-50498cb40ec7/connections/b0228ab4-0078-4e17-a7b3-9becf5e77c68"
        },
        {
          "rel": "connectionResources",
          "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/applications/e63e92c4-4727-4999-97f2-50498cb40ec7/connections/b0228ab4-0078-4e17-a7b3-9becf5e77c68/resources",
          "templated": true,
          "method": "GET"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/applications/e63e92c4-4727-4999-97f2-50498cb40ec7/connections"
    }
  ],
  "hasMore": false,
  "totalResults": 2,
  "limit": 0,
  "count": 2
}

Back to Top