Response from the endpoint
Main object
Field | Data Type | Description |
---|---|---|
success | boolean | result of the request |
Connection | Connection | Connection details |
Connection object
Field | Data Type | Description |
---|---|---|
Id | boolean | result of the request |
ConnectionName | string | Connection name (will update the a connection if the name already exists) |
ServerName | string | Server URL |
InitialCatalog | string | SQLServer and MySQL Initial Catalog |
Username | string | connection user |
Password | string | connection user password |
Port | integer | If the connection type is Oracle, this is the port to use |
SID | string | If the connection type is Oracle, this is the SID or Service Name to use |
Token | string | If the connection type is DMM_REST, this is the REST API key |
ConnectionType | string | Type of the connection - SQLServer/MySQL/DMM_REST/Oracle |
OracleServerType | string | If the connection type is Oracle, this is the Server Type to use (Dedicated, Shared or Pooled) |
SID_ServiceName | integer | If the connection type is Oracle, set to 1 to use a Service Name and with 2 if to use SID |
OracleSchema | string | If the connection type is Oracle, this is the schema to use |
IsNonOutsystemsDB | boolean | true if this is an external database to be used in the export to database |