Contents:
Get the specified connection.
For more information on connections, see Connection Types.
Version: v4
Required Permissions
NOTE: Each request to the Designer Cloud Powered by Trifacta® platform must include authentication credentials. See https://api.trifacta.com/ee/6.0/index.html#section/Authentication.
Request
Request Type: GET
Endpoint:
/v4/connections/<id>
where:
| Parameter | Description |
|---|---|
<id> | Internal identifier for the connection |
Request URI - Example:
/v4/connections/3
Request Body:
Empty.
Response
Response Status Code - Success: 200 - OK
Response Body Example:
{
"connectParams": {
"vendor": "hive",
"vendorName": "hive",
"host": "hadoop",
"port": "10000",
"jdbc": "hive2",
"defaultDatabase": "default"
},
"id": 1,
"host": "hadoop",
"port": 10000,
"vendor": "hive",
"params": {
"jdbc": "hive2",
"connectStringOptions": "",
"defaultDatabase": "default"
},
"ssl": false,
"vendorName": "hive",
"name": "hive",
"description": null,
"type": "jdbc",
"isGlobal": true,
"credentialType": "conf",
"credentialsShared": true,
"uuid": "3c8672f0-13ea-11e9-82f7-3ff8e3d74b3f",
"disableTypeInference": false,
"createdAt": "2019-01-09T08:40:37.023Z",
"updatedAt": "2019-01-09T08:40:37.037Z",
"credentials": [],
"creator": {
"id": 1
},
"updater": {
"id": 1
},
"workspace": {
"id": 1
}
}
Reference
| Property | Description |
|---|---|
| connectParams.vendor | The type of connection. See Connection Types. |
| connectParams.host | Host of the source |
| connectParams.port | Port number for the source |
| connectParams.jdbc | JDBC type for the connection |
| connectParams.defaultDatabase | (if applicable) Name of the default database |
| connectParams.extraLoadParams | (if applicable) If the connection types supports them, this setting contains additional parameters to be passed to the host when making the connection. |
| id | Internal identifier for the connection |
| host | Host of the source |
| port | Port number for the source |
| vendor | String identifying the connection's vendor |
| params | This setting is populated with any parameters that are passed to the source during connection and operations. For relational sources, this setting may include the default database and extra load parameters. |
| ssl | When |
| vendorName | Name of the vendor of the connection |
| name | Internal name of the connection |
| description | User-friendly description for the connection |
| type | Type of connection |
| isGlobal | If NOTE: After a connection has been made public, it cannot be made private again. It must be deleted and recreated. Default is |
| credentialType | The type of credentials used for the connection. This value varies depending on where the credentials are stored. See CLI for Connections. |
| credentialsShared | If true, the credentials used for the connection are available for use by users who have been shared the connection. |
| uuid | A universal object identifier, which is unique across instances of the platform. This internal identifier is particularly useful when create import mapping rules. |
| disableTypeInference | If set to When type inferencing has been disabled, the Designer Cloud Powered by Trifacta platform does not apply Alteryx types to data when it is imported. For more information, see Configure Type Inference. |
| createdAt | Timestamp for when the connection was made |
| updatedAt | Timestamp for when the connection was last updated |
| credentials | If present, these values are the credentials used to connect to the database. NOTE: For security reasons, you can store the connection's credentials in an external file on the Alteryx node, after which they do not appear in this setting. See CLI for Connections. |
| creator.id | Internal identifier of the user who created the connection. |
| updater.id | Internal identifier of the user who last updated the connection. |
| workspace.id | Internal identifier of the workspace with which this connection is associated. |
This page has no comments.