Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

The connections entity to post

Name
string
required

The name of the data connection.

WorkspaceId
string

The id of the Workspace.

ProviderName
string

The name of the ADO.NET provider for the data connection.

ProviderClass
string

The class name of the ADO.NET provider for the data connection.

ConnectionString
string

The connection string for the data connection.

LoadingError
string

The error message in loading current provider.

CreationTime
string

The time of creation.

RowVersion
integer<int64>

The version number of connection.

LastModified
string

The last modified.

ConnectionState
string

The connection state.

LastTested
string

The last time the connection was tested.

Verbosity
string

The verbosity of the connection log, where 0 represents None, 1 represents Error, 2 represents Info, 3 represents Transfer, and 5 represents Verbose.

UseCDataCallbackUrl
string

The Callback URL used, with 1 represents"Use" and 0 represents "Do not use".

UseSyncProxy
boolean

The Sync Proxy Settings used, with true represents"Use" and false represents "Do not use".

MetadataRefreshInterval
string

The refresh interval of metadata cache, -1 equals Never, 0 equals Start of Job, 3600 equals Hourly and 86400 equals Daily.

LicenseState
string

Whether the connection is valid or invalid based on the license.

LicenseMessage
string

Details for why the connection is invalid.

CanUpdate
string

Whether the current entity can be updated by current user.

CanRemove
string

Whether the current entity can be removed by current user.

DestinationSupported
boolean

Whether the current connection supports destination.

Response

connections created

Name
string
required

The name of the data connection.

WorkspaceId
string

The id of the Workspace.

ProviderName
string

The name of the ADO.NET provider for the data connection.

ProviderClass
string

The class name of the ADO.NET provider for the data connection.

ConnectionString
string

The connection string for the data connection.

LoadingError
string

The error message in loading current provider.

CreationTime
string

The time of creation.

RowVersion
integer<int64>

The version number of connection.

LastModified
string

The last modified.

ConnectionState
string

The connection state.

LastTested
string

The last time the connection was tested.

Verbosity
string

The verbosity of the connection log, where 0 represents None, 1 represents Error, 2 represents Info, 3 represents Transfer, and 5 represents Verbose.

UseCDataCallbackUrl
string

The Callback URL used, with 1 represents"Use" and 0 represents "Do not use".

UseSyncProxy
boolean

The Sync Proxy Settings used, with true represents"Use" and false represents "Do not use".

MetadataRefreshInterval
string

The refresh interval of metadata cache, -1 equals Never, 0 equals Start of Job, 3600 equals Hourly and 86400 equals Daily.

LicenseState
string

Whether the connection is valid or invalid based on the license.

LicenseMessage
string

Details for why the connection is invalid.

CanUpdate
string

Whether the current entity can be updated by current user.

CanRemove
string

Whether the current entity can be removed by current user.

DestinationSupported
boolean

Whether the current connection supports destination.