Create a new Data Source

{ createDataServer }

Adds a new data source server to the system.

Method

/API3/dataSources/createDataServer
  • API Section: /API3/dataSources
  • API Version: 3.0
  • From Release: 2023.10
  • Can be used by Enterprise Admin users only
  • REST API and Client SDK libraries. REST APIs via POST actions only.
  • Input Parameters

    Name

    serverData

    Object Type

    Description

    The data source server object and its settings.

    Output Response

    Successful Result Code

    200

    Response Type

    Description of Response Type

    Generic API response object with success or failure flag and related messages.

    Notes

    Data sources represent data servers that can be queried.

    Examples

    Code Snippets

    Use the Authentication API methods to generate an access 'key' or 'token' for use in code as shown below.

    JavaScript
    Curl
    Java
    C#
    Python
    PHP
    curl -X POST \
    -H "paToken: [[apiKey]]" \
     -H "Accept: application/json" \
     -H "Content-Type: application/json" \
     "http://Your.Server.URL/API3/dataSources/createDataServer" \
     -d '{
      "instanceName" : "instanceName",
      "overlayPyramidSecurity" : true,
      "useGlobalAccount" : true,
      "serverName" : "serverName",
      "description" : "description",
      "securedByUser" : true,
      "userName" : "userName",
      "writeCapable" : 6,
      "password" : "password",
      "defaultDatabaseName" : "defaultDatabaseName",
      "serverAuthenticationMethod" : "UserPassword",
      "port" : 0,
      "pulseClient" : "pulseClient",
      "serverType" : "None",
      "tenantId" : "tenantId",
      "modifiedDate" : "2000-01-23T04:56:07.000+00:00",
      "serverIp" : "serverIp",
      "id" : "id",
      "additionalServerProperties" : {
        "customTrustStore" : "customTrustStore",
        "certValidationCustomRootCaType" : "None",
        "disableDBTables" : true,
        "hierarchyType" : "DRILL_PATH",
        "defaultTrustStorePassword" : "defaultTrustStorePassword",
        "salesforceSecurityToken" : "salesforceSecurityToken",
        "krbServiceName" : "krbServiceName",
        "disableAnalyticViews" : true,
        "googleAnalyticsType" : "UniversalAnalytics",
        "msOlapConnectionType" : "REGULAR",
        "bwSupportStructures" : true,
        "messageServerHost" : "messageServerHost",
        "ftpSettings" : {
          "isRequireReuseTLS" : true,
          "portRangeMin" : 5,
          "ftpSecurityType" : "FTP_UNSECURE",
          "portRangeMax" : 2,
          "ftpDataMode" : "NOT_SET"
        },
        "customKeyStoreType" : "customKeyStoreType",
        "sapBwServerConnectionType" : "APP_SERVER",
        "sharedFolderPath" : "sharedFolderPath",
        "showInfoAreaTree" : true,
        "shouldValidateServerCertHostname" : true,
        "hdfsPort" : 5,
        "hdfsIP" : "hdfsIP",
        "mdxCompatibility" : 7,
        "keytabPath" : "keytabPath",
        "s3StagingDir" : "s3StagingDir",
        "systemR3Name" : "systemR3Name",
        "customJdbcId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "sysNumber" : "sysNumber",
        "bringNonOleDbComponents" : true,
        "messageServerService" : "messageServerService",
        "quotaProjectId" : "quotaProjectId",
        "bulkWritingType" : "NONE",
        "useClientCertificate" : true,
        "isCustomTrustStore" : true,
        "awsBucketName" : "awsBucketName",
        "customJdbcProps" : {
          "key" : "customJdbcProps"
        },
        "clientKeyPath" : "clientKeyPath",
        "bwDataBaseListTechnique" : "STANDARD_1",
        "warehouse" : "warehouse",
        "accessToken" : "accessToken",
        "customTrustStorePassword" : "customTrustStorePassword",
        "isOperatingSystemTrustStore" : true,
        "isDatabaseSchema" : true,
        "useSSL" : true,
        "accountId" : "accountId",
        "odbcDirectQueryOptions" : {
          "baseSqlStyle" : "None"
        },
        "avoidMultiPassAuthentication" : true,
        "urlPortal" : "urlPortal",
        "privateCertId" : "privateCertId",
        "supportsBwFlatQueries" : true,
        "bwInfoAreaTreeViewType" : "NONE",
        "shouldValidateServerCert" : true,
        "sapRouter" : "sapRouter",
        "timezone" : "timezone",
        "disableCalculationViews" : true,
        "sncPartnerName" : "sncPartnerName",
        "groupServer" : "groupServer",
        "isOverrideConnectionString" : true,
        "consumerSecret" : "consumerSecret",
        "isCustomKeyStore" : true,
        "customTrustStoreType" : "customTrustStoreType",
        "disableAttributeViews" : true,
        "customCertHostname" : "customCertHostname",
        "consumerKey" : "consumerKey",
        "clientCertPath" : "clientCertPath",
        "awsSecretAccessKey" : "awsSecretAccessKey",
        "isCustomCertHostname" : true,
        "oauthDataSourceSettings" : {
          "redirectUri" : "redirectUri",
          "clientId" : "clientId",
          "loadSuperFromGlobal" : true,
          "scope" : "scope",
          "jwksUri" : "jwksUri",
          "openIdAuthType" : "None",
          "clientSecret" : "clientSecret",
          "tokenEntryPoint" : "tokenEntryPoint",
          "authenticationEndPointUrl" : "authenticationEndPointUrl",
          "inheritanceType" : "OauthDataSourceSettings"
        },
        "hiveIP" : "hiveIP",
        "defaultCulture" : "defaultCulture",
        "awsRegion" : "awsRegion",
        "bwInfoAreaIconIds" : "bwInfoAreaIconIds",
        "useCustomCertificateConfig" : true,
        "awsAccessKeyId" : "awsAccessKeyId",
        "roleId" : "roleId",
        "hivePort" : 1,
        "clientNumber" : "clientNumber",
        "keytabId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "proxyAccountInUse" : "ProxyAccount",
        "accessTokenSecret" : "accessTokenSecret",
        "relativeFolderName" : "relativeFolderName",
        "customKeyStore" : "customKeyStore",
        "sparkTransportMode" : "BINARY",
        "clientKeyPassword" : "clientKeyPassword",
        "customKeyStorePassword" : "customKeyStorePassword",
        "resolveColumnLabel" : true,
        "machineAccountFallback" : true,
        "authMethod" : "EffectiveUserName",
        "customRootCaCert" : "customRootCaCert"
      },
      "displayFolder" : "displayFolder",
      "optionalParameters" : "optionalParameters"
    }'
    
    import com.pyramidanalytics.*;
    import com.pyramidanalytics.auth.*;
    import com.pyramidanalytics.model.*;
    import com.pyramidanalytics.api.DataSourcesServiceApi;
    
    import java.util.*;
    
    public class DataSourcesServiceApiExample {
        public static void main(String[] args) {
            ApiClient defaultClient = Configuration.getDefaultApiClient();
            defaultClient.setBasePath("http://Your.Server.URL/");
            
            // Configure API key authorization: paToken
            ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
            paToken.setApiKey("YOUR API KEY");
            // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
            //paToken.setApiKeyPrefix("Token");
    
            // Create an instance of the API class
            DataSourcesServiceApi apiInstance = new DataSourcesServiceApi();
            // Initialize the serverData parameter object for the call
            ServerData serverData = ; // ServerData | 
    
            try {
                ModifiedItemsResult result = apiInstance.createDataServer(serverData);
                System.out.println(result);
            } catch (ApiException e) {
                System.err.println("Exception when calling DataSourcesServiceApi#createDataServer");
                e.printStackTrace();
            }
        }
    }
    
    const PyramidAnalyticsWebApi = require('pyramid_analytics_web_api');
    const defaultClient = PyramidAnalyticsWebApi.ApiClient.instance;
    
    // Configure API key authorization: paToken
    const paToken = defaultClient.authentications['paToken'];
    paToken.apiKey = "YOUR API KEY";
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //paToken.apiKeyPrefix['paToken'] = "Token";
    
    // Create an instance of the API class
    const api = new PyramidAnalyticsWebApi.DataSourcesServiceApi("http://Your.Server.URL")
    const serverData = ; // {ServerData} 
    
    const callback = function(error, data, response) {
      if (error) {
        console.error(error);
      } else {
        console.log('API called successfully. Returned data: ' + data);
      }
    };
    api.createDataServer(serverData, callback);
    
    using System;
    using System.Diagnostics;
    using PyramidAnalytics.Sdk.Api;
    using PyramidAnalytics.Sdk.Client;
    using PyramidAnalytics.Sdk.Model;
    
    public class createDataServerExample
    {
        public static void Main()
        {
            Configuration conf = new Configuration();
            conf.BasePath = "http://Your.Server.URL/";
            
            // Configure API key authorization: paToken
            conf.ApiKey.Add("paToken", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // conf.ApiKeyPrefix.Add("paToken", "Bearer");
    
            GlobalConfiguration.Instance = conf;
            
            // Create an instance of the API class
            var apiInstance = new DataSourcesServiceApi();
            // Initialize the serverData parameter object for the call
            var serverData = new ServerData(); // ServerData | 
    
            try {
                // Adds a new data source server to the system.
                ModifiedItemsResult result = apiInstance.createDataServer(serverData);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DataSourcesServiceApi.createDataServer: " + e.Message );
            }
        }
    }
    
    
    import com.pyramidanalytics
    from com.pyramidanalytics import ApiException
    from pprint import pprint
    
    
    # Configure API key authorization: paToken
    api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # api_config.api_key_prefix['paToken'] = 'Bearer'
    
    with com.pyramidanalytics.ApiClient(api_config) as api_client:
        # Create an instance of the API class
        api_instance = com.pyramidanalytics.DataSourcesServiceApi(api_client)
        # Initialize the serverData parameter object for the call
        serverData =  # ServerData | 
    
        try:
            # Adds a new data source server to the system.
            api_response = api_instance.create_data_server(serverData)
            pprint(api_response)
        except ApiException as e:
            print("Exception when calling DataSourcesServiceApi->createDataServer: %s\n" % e)
    setHost('http://Your.Server.URL');
    
    // Configure API key authorization: paToken
    OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
    // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    // OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');
    
    // Create an instance of the API class
    $api_instance = new OpenAPITools\Client\Api\DataSourcesServiceApi();
    $serverData = ; // ServerData | 
    
    try {
        $result = $api_instance->createDataServer($serverData);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling DataSourcesServiceApi->createDataServer: ', $e->getMessage(), PHP_EOL;
    }
    ?>