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: string(uuid)
• connectionId: 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

• domain: string
  The identity domain for the connection
• password: string
  The password to authenticate the connection. Leave blank to use the already stored password.
• url: string
  The target url of the connection
• username: string
  The user name to authenticate the connection

{
    "type":"object",
    "required":[
        "domain",
        "password",
        "url",
        "username"
    ],
    "properties":{
        "url":{
            "type":"string",
            "description":"The target url of the connection"
        },
        "domain":{
            "type":"string",
            "description":"The identity domain for the connection"
        },
        "username":{
            "type":"string",
            "description":"The user name to authenticate the connection"
        },
        "password":{
            "type":"string",
            "description":"The password to authenticate the connection. Leave blank to use the already stored password."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : TestConnectionResult

Type: object

Show Source

• messages(optional): string
• success(optional): 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