Test database connection to a project (Oracle environments only)

Available in versions: 2021 R2 and later

Description

For Oracle environments only: Tests the connection to the database for a specific project.

URL

Copy code
/Admin/rest/v1/projects/verifyprojectdbconnection

Remarks

This API should be authorized for the Application, Tenant, and Site Admin permission levels.

HTTP method

POST: Tests a project's connection to the Oracle database server.

Request

Headers:

One of the following:

  • Content-Type: application/xml

  • Content-Type: application/json

Cookies:

ADM_LWSSO={AdmLwssoCookie};

Request body:

An XML or JSON describing the project and other optional details.

The fields in the request are:

ElementDescription
SchemaCredentialsDetails

  • ProjectId. The ID of the project for which the Oracle database connection should be tested (it can be retrieved from the Get Projects REST API). The Lab schema is considered as a particular project with ProjectId=1.

  • Password. The password to use to test the connection in plain text. If null, OpenText Enterprise Performance Engineering tests the connection with the password currently in use by OpenText Enterprise Performance Engineering. You can provide a Base64 encrypted value for the password if it is prefixed with “{a3f701a2-475d-4fe3-89f3-cc7db85a272c}:” (without the quotes), and then encrypted with the prefix.

Request examples:

Copy code
XML example:
<SchemaCredentialsDetails> 
    <ProjectId>1038</ProjectId>
    <Password>MyCustomPassword</Password>
</SchemaCredentialsDetails>
Copy code
JSON example:
{        
    "ProjectId": "205",
    "Password": ""
}

Response

Headers:

One of:

  • Accept: application/xml

  • Accept: application/json

Cookies:

None

HTML Return Code:

One of the HTTP return codes.

HTML body:

Returns data on the database connection.

Response examples:

Copy code
XML example:
<boolean>true</boolean>
Copy code
JSON example:
true

See also: