REST API Reference

REST API Reference

Create Connection

Create Connection

The POST connections request creates a connection in Test Data Management.

Resource URL

/tdm/v1/connections

HTTP Request

POST http(s)://
<host>
:
<port>
/api/public/tdm/v1/connections

Request Header

The request header includes the following headers:
Header
Description
accept
Use the following value:
application/json
Authorization
Required. Use the following value:
Basic <user name>

Request Body

The properties that you include in a request body differ based on the type of connection you want to create.
To create the request body, perform the following steps:
  1. Run the
    utilities/template/connection
    API.
  2. Select the type of connection that you want to create from the
    db_type
    list.
  3. Download the response file or copy the properties that appear in the response body. The file is a template of properties that you need to enter to create the type of connection.
  4. Enter the values for the connection that you want to create.
  5. Enter the properties to the request body of the
    /tdm/v1/connections
    API.
  6. Run the POST
    /tdm/v1/connections
    API to create the connection.

Sample Request

POST http://<host>:6605/api/public/tdm/v1/connections

Sample Request Body

The following code is an example of a request body to create an Oracle connection:
{ "id": null, "name": "Oracle_Connection1", "connection_type": null, "db_type": "Oracle", "description": null, "connection_properties": [ { "name": "parallel_mode", "value": "false", "comment": "optional" }, { "name": "code_page", "value": "7-bit ASCII", "comment": "optional" }, { "name": "password", "value": "tiger", "comment": "mandatory" }, { "name": "connection_environment_sql", "value": null, "comment": "optional" }, { "name": "username", "value": "scott", "comment": "mandatory" }, { "name": "jdbc_url", "value": "jdbc:informatica:oracle://localhost:1521;SID=ora11g", "comment": "mandatory" }, { "name": "passthrough_security_enabled", "value": "false", "comment": "optional" }, { "name": "use_kerberos_authentication", "value": "false", "comment": "optional" }, { "name": "connection_string", "value": "orcl", "comment": "mandatory" }, { "name": "connection_retry_period", "value": "0", "comment": "optional" }, { "name": "transaction_environment_sql", "value": null, "comment": "optional" }, { "name": "use_parameter_in_password", "value": "false", "comment": "optional" } ] }

Sample Response

{ "id": "U:Nk_7i1T2EemkGmGSivLASA", "name": "Oracle_Connection1", "connection_type": "Relational", "db_type": "Oracle", "description": null, "connection_properties": [ { "name": "parallel_mode", "value": "false", "comment": null }, { "name": "owner_domain", "value": "Domain", "comment": null }, { "name": "owner_username", "value": "Administrator", "comment": null }, { "name": "connection_environment_sql", "value": "", "comment": null }, { "name": "jdbc_url", "value": "jdbc:informatica:oracle://localhost:1521;SID=ora11g", "comment": null }, { "name": "use_kerberos_authentication", "value": "false", "comment": null }, { "name": "connection_string", "value": "orcl", "comment": null }, { "name": "code_page", "value": "7-bit ASCII", "comment": null }, { "name": "password", "value": "tiger", "comment": null }, { "name": "owner_namespace", "value": "Native", "comment": null }, { "name": "username", "value": "scott", "comment": null }, { "name": "passthrough_security_enabled", "value": "false", "comment": null }, { "name": "connection_retry_period", "value": "0", "comment": null }, { "name": "transaction_environment_sql", "value": "", "comment": null }, { "name": "use_parameter_in_password", "value": "false", "comment": null } ] }

0 COMMENTS

We’d like to hear from you!