Jump to

• Request
• Response
• Examples

Test Saved Connection

post

/essbase/rest/v1/connections/{connectionName}/actions/test

Tests a saved global connection by name.

Request

Path Parameters

• connectionName: string

  Connection name.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

The connection tested successfully.

400 Response

Bad Request

Error occurred while testing connection.

Back to Top

Examples

The following example shows how to test an existing global connection.

This example uses cURL to access the REST API from a Windows shell script. The calling user's ID and password are variables whose values are set in properties.bat.

Script with cURL Command

call properties.bat
curl -X POST -i "https://myserver.example.com:9001/essbase/rest/v1/connections/oraConn/actions/test" -H Accept:application/json -u %User%:%Password%

Example of Response Body

Returns header information (if -i was used), beginning with the status code 200 (if the test was successful). The header information in this example is truncated to show only the status code.

HTTP/1.1 200 OK

Back to Top