Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space DEV and version r0682

D s api version

D toc

Get the list of all vendors of connections that are supported in the instance of the platform.

Info

NOTE: Additional vendors can become available based on the deployment of a set of configuration files for the vendor. Adding vendors that are not on this list may require

D s proserv
. For more information on the available connections, see Connection Types.

Version:  v4

Required Permissions

D s api auth

Request

Request Type: GET

Endpoint:

Code Block
/v4/connections/vendors


Request Body:

Empty.

Response

Response Status Code - Success:  200 - OK

Response Body Example:

Code Block
[
    {
        "name": "db2",
        "displayName": "DB2",
        "type": "db2",
        "category": "relational",
        "credentialType": "basic",
        "operation": "import",
        "connectionParameters": [
            {
                "name": "host",
                "displayName": "Host",
                "type": "string",
                "required": true,
                "category": "location",
                "default": ""
            },
            {
                "name": "port",
                "displayName": "Port",
                "type": "integer",
                "required": true,
                "category": "location",
                "default": "1521"
            },
            {
                "name": "connectStrOpts",
                "displayName": "Connect String Options",
                "type": "string",
                "required": false,
                "category": "location",
                "default": ""
            },
            {
                "name": "database",
                "displayName": "Database Name",
                "type": "string",
                "required": true,
                "category": "location",
                "default": ""
            }
        ]
    },
    {
        "name": "hive",
        "displayName": "Hive",
        "type": "hive",
        "category": "bigdata",
        "credentialType": "conf",
        "operation": "both",
        "connectionParameters": [
            {
                "name": "host",
                "displayName": "Host",
                "type": "string",
                "required": true,
                "category": "location",
                "default": ""
            },
            {
                "name": "port",
                "displayName": "Port",
                "type": "integer",
                "required": true,
                "category": "location",
                "default": "10000"
            },
            {
                "name": "connectStrOpts",
                "displayName": "Connect String Options",
                "type": "string",
                "required": false,
                "category": "location",
                "default": ""
            },
            {
                "name": "defaultDatabase",
                "displayName": "Default Database",
                "type": "string",
                "required": true,
                "category": "location",
                "default": ""
            }
        ]
    },
    {
        "name": "oracle",
        "displayName": "Oracle Database",
        "type": "oracle",
        "category": "relational",
        "credentialType": "basic",
        "operation": "both",
        "connectionParameters": [
            {
                "name": "host",
                "displayName": "Host",
                "type": "string",
                "required": true,
                "category": "location",
                "default": ""
            },
            {
                "name": "port",
                "displayName": "Port",
                "type": "integer",
                "required": true,
                "category": "location",
                "default": "1521"
            },
            {
                "name": "connectStrOpts",
                "displayName": "Connect String Options",
                "type": "string",
                "required": false,
                "category": "location",
                "default": ""
            },
            {
                "name": "ssl",
                "displayName": "Enable SSL",
                "type": "boolean",
                "required": true,
                "category": "location",
                "default": "false"
            },
            {
                "name": "service",
                "displayName": "Service Name",
                "type": "string",
                "required": true,
                "category": "location",
                "default": ""
            }
        ]
    },
    {
        "name": "postgres",
        "displayName": "PostgreSQL",
        "type": "postgres",
        "category": "relational",
        "credentialType": "basic",
        "operation": "both",
        "connectionParameters": [
            {
                "name": "host",
                "displayName": "Host",
                "type": "string",
                "required": true,
                "category": "location",
                "default": ""
            },
            {
                "name": "port",
                "displayName": "Port",
                "type": "integer",
                "required": true,
                "category": "location",
                "default": "5432"
            },
            {
                "name": "connectStrOpts",
                "displayName": "Connect String Options",
                "type": "string",
                "required": false,
                "category": "location",
                "default": ""
            },
            {
                "name": "ssl",
                "displayName": "Enable SSL",
                "type": "boolean",
                "required": true,
                "category": "location",
                "default": "false"
            },
            {
                "name": "database",
                "displayName": "Database",
                "type": "string",
                "required": true,
                "category": "location",
                "default": ""
            }
        ]
    },
    {
        "name": "salesforce",
        "displayName": "SalesForce",
        "type": "salesforce",
        "category": "application",
        "credentialType": "basic",
        "operation": "import",
        "connectionParameters": [
            {
                "name": "servername",
                "displayName": "Server Name",
                "type": "string",
                "required": true,
                "category": "location",
                "default": ""
            },
            {
                "name": "securityToken",
                "displayName": "Security Token generated in account",
                "type": "string",
                "required": true,
                "category": "location",
                "default": ""
            },
            {
                "name": "connectStrOpts",
                "displayName": "Connect String Options",
                "type": "string",
                "required": false,
                "category": "location",
                "default": ""
            }
        ]
    },
    {
        "name": "sqlserver",
        "displayName": "Microsoft SQL Server",
        "type": "sqlserver",
        "category": "relational",
        "credentialType": "basic",
        "operation": "both",
        "connectionParameters": [
            {
                "name": "host",
                "displayName": "Host",
                "type": "string",
                "required": true,
                "category": "location",
                "default": ""
            },
            {
                "name": "port",
                "displayName": "Port",
                "type": "integer",
                "required": true,
                "category": "location",
                "default": "1433"
            },
            {
                "name": "connectStrOpts",
                "displayName": "Connect String Options",
                "type": "string",
                "required": false,
                "category": "location",
                "default": ""
            }
        ]
    },
    {
        "name": "tableau",
        "displayName": "Tableau Server",
        "type": "tableau",
        "category": "application",
        "credentialType": "basic",
        "operation": "publish",
        "connectionParameters": [
            {
                "name": "host",
                "displayName": "Server URL",
                "type": "string",
                "required": true,
                "category": "location",
                "default": ""
            }
        ]
    },
    {
        "name": "teradata",
        "displayName": "Teradata Data Warehouse",
        "type": "teradata",
        "category": "relational",
        "credentialType": "basic",
        "operation": "both",
        "connectionParameters": [
            {
                "name": "host",
                "displayName": "Host",
                "type": "string",
                "required": true,
                "category": "location",
                "default": ""
            },
            {
                "name": "port",
                "displayName": "Port",
                "type": "integer",
                "required": true,
                "category": "location",
                "default": "1025"
            },
            {
                "name": "connectStrOpts",
                "displayName": "Connect String Options",
                "type": "string",
                "required": false,
                "category": "location",
                "default": ""
            },
            {
                "name": "ssl",
                "displayName": "Enable SSL",
                "type": "boolean",
                "required": true,
                "category": "location",
                "default": "false"
            }
        ]
    }
] 

Reference

For each connection type, the following parameters are available.

PropertyDescription
nameName of the connection type
displayNameDescription value of the connection type
typeVendor identifier for the connection type
category

Tab in the Connections screen where connections of this type can be created

credentialType

Type of credentials that are accepted for this connection type:

  • basic - used for relational connections, except as noted below
  • trifacta_service - used for Hive connections only

  • aws - used for Redshift connections only
  • Kerberos delegate - Connection uses the Kerberos-delegated principal to connect to the database. No credentials are submitted as part of the connection definition. This method requires additional configuration. See Enable SSO for Relational Connections.

operation

Supported operations for the connection type:

  • import - import datasets only
  • publish - publish datasets only
  • both - import and publish

connectionParameters properties:

For each of the connection properties, the following attributes are specified:

AttributeDescription
nameName of connection property
displayNameDisplay value of the property, which appears above the textbox in the application
typeData type of the connection property
requiredIf true, the property must be populated to create a connection of this type.
category

Defines the order for how the properties are listed in the Create Connection dialog.

If set to location, the order is determined by the order in which the properties are listed under the vendor object.

defaultThe default value for the connection property