ServerData

id

The data source's system ID

string

serverName

The data source server's caption or name

Y

string

serverType

The data source server's type enumeration

Y

ConnectionStringType

serverIp

The data source server's IP address or FQDN

Y

string

instanceName

The instance name of the data source (if relevant)

string

port

The data source server's port number

integer

int32

writeCapable

Read=0, Write=1, Default:Read

integer

int32

optionalParameters

Optional parameters for data source connection

string

securedByUser

Boolean flag if the data source will be secured by each end-user

boolean

serverAuthenticationMethod

Authentication method details when securing the connection.

ServerAuthenticationMethod

userName

User Id needed for connection

string

password

User password need for connection

string

tenantId

The tenant ID that the data source will be attached to

string

additionalServerProperties

Additional connection properties and settings for the data source

AdditionalServerProperties

useGlobalAccount

Boolean to flag if the global account should be sued for connecting. Default:false

boolean

pulseClient

The Pulse client ID if used with the data source

string

defaultDatabaseName

The default database to be used with the data source

string

overlayPyramidSecurity

Boolean flag if the data source will use Pyramid's security and metadata overlays

boolean

displayFolder

The data source server's display folder

string

description

The data source server's description

string

modifiedDate

The last date that the server has been modified. ignored in server creation

integer

Api2: int64 - epoch time in milliseconds, Api3: String according to iso8601

isPaused

Flag to set the state of the datasource to either be queryable or not

boolean