Test a global connection
post
/epm/rest/v1/globalConnections/{globalConnectionId}/test
Request
Supported Media Types
- application/json
Path Parameters
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 url for the connection,
"username", the username for the connection, and
"password", the password for the connection.
EPM connections also include
"identityDomain", the identity domain for the connection, and
"folder", the epm folder.
UCM connections also include
"identityDomain", the identity domain for the connection, and
"defaultDocumentAccount", the default document account.
Oracle Object Store connections also include
"bucketName", the name of the default target bucket.
Root Schema : Global Connection Test 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 url for the connection,
"username", the username for the connection, and
"password", the password for the connection.
EPM connections also include
"identityDomain", the identity domain for the connection, and
"folder", the epm folder.
UCM connections also include
"identityDomain", the identity domain for the connection, and
"defaultDocumentAccount", the default document account.
Oracle Object Store connections also include
"bucketName", the name of the default target bucket.
Show Source
-
type:
string
Read Only:
true
Allowed Values:[ "ORACLE_OBJECT_STORE", "EPM", "UCM" ]
Type should be set to "EPM" for Oracle EPM Cloud connections, "UCM" for Oracle ERP Cloud connections and "ORACLE_OBJECT_STORE" for Oracle Object Store connections.
Response
Supported Media Types
- application/json
200 Response
OK
400 Response
Error in body
404 Response
Connection not found
Examples
The following example shows how to test a global 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/globalConnections/b3ee4f46-9b49-4422-b8b5-7113038e7015/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", "type": "UCM" }
Example of Response Body
The following shows an example of the response body in JSON format.
{ "success": true, "messages": null }