Connection Management API
Version 22.0.8481
Version 22.0.8481
Connection Management API
Connection Management
- List all Connections
- Create a Connection
- Modify a Connection
- Delete a Connection
- Test a Connection
- List Tables for a Connection
- List TableColumns for a Connection
List all Connections
Returns a list of all Connections within the Sync application.
GET http://mydomain.com:8019/api.rsc/connections(Name)
Query Parameters
Name | Description |
---|---|
Name | The name of the connection to retrieve. |
Create a Connection
Create a new Connection in the Sync application.
POST http://mydomain.com:8019/api.rsc/connections
Body Parameters
Name | Description |
---|---|
Name (required) | The name of the connection to create. |
ProviderName | The name of the connector to make the connection to. I.E. CData Salesforce. |
ConnectionString | The connection string for the data connection. |
{
"Name": "MyNewConnection",
"ProviderName": "CData Salesforce",
"ConnectionString": "user=MyUser;Password=MyPassword;SecurityToken=MyToken"
}
Modify a Connection
Modifies an Existing Connection. You are unable to modify a Connection that is currently being used in a running Job.
PUT http://mydomain.com:8019/api.rsc/connections(Name)
Query Parameters
Name | Description |
---|---|
Name (required) | The name of the connection to modify. |
Body Parameters
Name | Description |
---|---|
ConnectionString | The connection string for the data connection. |
{
"ConnectionString": "user=MyUser;Password=MyPassword;SecurityToken=MyNewToken"
}
Delete a Connection
Remove a Connection from the Sync application. You are unable to delete a Connection that is currently in use in a Job.
DELETE http://mydomain.com:8019/api.rsc/connections(Name)
Query Parameters
Name | Description |
---|---|
Name | Name of the Connection to Delete. |
Test a Connection
Test a previously created connection. Response will contain Success or Error Message
POST http://mydomain.com:8019/api.rsc/testConnection
Body Parameters
Name | Description |
---|---|
ConnectionName | Name of the Connection to Test. |
{
"ConnectionName": "MyConnection"
}
List Tables
Retrieve a list of available Tables for a Connection.
POST http://mydomain.com:8019/api.rsc/getConnectionTables
Body Parameters
Name | Description |
---|---|
ConnectionName | Name of the Connection to retieve Tables from. |
TableOrView | The types (tables or views) that should be listed. Values: TABLES,VIEWS,ALL |
Schema | Restrict tables to only this schema. |
IncludeSchema | Whether to include schema with the Table name in the form [Schema].[Table] |
IncludeCatalog | Whether to include catalog with the Table name in the form [Catalog].[Schema].[Table] |
{
"ConnectionName": "MyConnection",
"TableOrView": "ALL",
"IncludeSchema": "True"
}
List Columns
Retrieve a list of available Columns for a Table.
POST http://mydomain.com:8019/api.rsc/getConnectionTableColumns
Body Parameters
Name | Description |
---|---|
ConnectionName | Name of the Connection to retieve Tables from. |
Table | Name of the Table to retieve Columns from. |
{
"ConnectionName": "MyConnection",
"Table": "Accounts"
}