Version 26.1.9516

• List All Connections
• Create a Connection
• Modify a Connection
• Delete a Connection
• Test a Connection
• List Tables
• List Columns
• Reset OAuth Credentials

The Connection Management API supports the following actions:

• List all Connections
• Create a Connection
• Modify a Connection
• Delete a Connection
• Test a Connection
• List Tables for a Connection
• List Table Columns for a Connection
• Reset OAuth Credentials

The following sections describe each of these actions.

List All Connections

The following command returns a list of all connections within the CData Sync application:

GET http://MyDomain.com:8019/api.rsc/connections(Name)

Query Parameter

Create a Connection

The following command creates a new connection in the Sync application:

POST http://MyDomain.com:8019/api.rsc/connections

Body Parameters

Example Request

{ 
  "Name": "MyNewConnection", 
  "ProviderName": "CData Salesforce",
  "ConnectionString": "user=MyUser;Password=MyPassword;SecurityToken=MyToken"
}

Modify a Connection

The following command modifies an existing connection:

PUT http://MyDomain.com:8019/api.rsc/connections(Name)

Note: You cannot modify a connection that is in use in a running job.

Query Parameter

Body Parameters

Example Request

{ 
  "ConnectionString": "user=MyUser;Password=MyPassword;SecurityToken=MyNewToken"
}

Delete a Connection

The following command removes a connection from the Sync application:

DELETE http://MyDomain.com:8019/api.rsc/connections(Name)

Note: You cannot delete a connection that is in use in a running job.

Query Parameter

Test a Connection

The following command tests a previously created connection.

POST http://MyDomain.com:8019/api.rsc/testConnection

Note: The response is either a success message or an error message.

Body Parameters

Example Request

{ 
  "ConnectionName": "MyConnection"
}

List Tables

The following command retrieves a list of available tables for a connection:

POST http://MyDomain.com:8019/api.rsc/getConnectionTables

Body Parameters

Example Request

{ 
  "ConnectionName": "MyConnection",
  "TableOrView": "ALL",
  "IncludeSchema": "True"
}

List Columns

The following command retrieves a list of available columns for a table:

POST http://MyDomain.com:8019/api.rsc/getConnectionTableColumns

Body Parameters

Example Request

{ 
  "ConnectionName": "MyConnection",
  "Table": "Accounts"
}

Reset OAuth Credentials

The following command resets the stored OAuth credentials for an existing connection.

POST http://MyDomain.com:8019/api.rsc/resetOAuthCredentials

This command clears the stored OAuth tokens for the specified connection. The connection is disconnected after the reset, and any operations that require authentication (for example, testing or running jobs) fail until you re-authenticate.

You must have Update Connection permission to perform this action. Users without this permission receive an error message indicating that they do not have sufficient privileges.

Body Parameter

Example Request

{
  "ConnectionName": "MyConnection"
}