Jump to

• Request
• Response
• Examples

Test a connection for an application

post

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

Request

Supported Media Types

• application/json

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}

Body ()

The details of the connection to test

Root Schema : TestApplicationConnectionDetailsCommandJson

Type: object

Show Source

• accessToken: string
  The updated access token for the connection. Required for the OAuth authentication type.
• clientId: string
  The updated client ID for the connection. Required for the OAuth authentication type.
• domain: string
  The identity domain for the non-OAuth connection
• password: string
  The updated password for the connection. Used for the Basic authentication type. Leave blank to use the already stored password.
• refreshToken: string
  The updated refresh token for the connection. Required for the OAuth authentication type.
• url(required): string
  The target url of the connection
• username: string
  The updated username for the connection. Required for the Basic authentication type.

{
    "type":"object",
    "required":[
        "url"
    ],
    "properties":{
        "url":{
            "type":"string",
            "description":"The target url of the connection"
        },
        "domain":{
            "type":"string",
            "description":"The identity domain for the non-OAuth connection"
        },
        "username":{
            "type":"string",
            "description":"The updated username for the connection.  Required for the Basic authentication type."
        },
        "password":{
            "type":"string",
            "description":"The updated password for the connection.  Used for the Basic authentication type.  Leave blank to use the already stored password."
        },
        "clientId":{
            "type":"string",
            "description":"The updated client ID for the connection.  Required for the OAuth authentication type."
        },
        "refreshToken":{
            "type":"string",
            "description":"The updated refresh token for the connection.  Required for the OAuth authentication type."
        },
        "accessToken":{
            "type":"string",
            "description":"The updated access token for the connection.  Required for the OAuth authentication type."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : TestConnectionResult

Type: object

Show Source

• messages: string
• success: boolean

{
    "type":"object",
    "properties":{
        "success":{
            "type":"boolean"
        },
        "messages":{
            "type":"string"
        }
    }
}

400 Response

Error in body

404 Response

Application Connection not found

Back to Top

Examples

The following example shows how to test specific application connection by using a POST request on the REST resource using cURL.

cURL Command

curl --user epm_cloud_user -X POST -H 'Content-Type: application/json' @example_request_payload.json https://servername.fa.us2.oraclecloud.com/epm/rest/v1/applications/e63e92c4-4727-4999-97f2-50498cb40ec7/connections/ea2328ed-48d3-45dd-b033-fc447a5e2a77/test

Example of Request Body

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

    {
        "url": "http[s]://hostname[:port]",
        "username": "User1",
        "password": "daa64d99-9c88-4109-a75b-c9756b7d0796",
        "domain": ""
    }

Example of Response Body

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

    {
        "success": true,
        "messages": null
    }

Back to Top