Field Squared API Services

<back to all web services

ExternalConnection

Used to register connection details for external systems.
Supported ConnectionTypes: 'Database'. Supported DatabaseTypes: 'SqlServer'

The following routes are available for this service:
GET,POST,DELETE/{Workspace}/ExternalConnection/{ObjectId}
GET/{Workspace}/ExternalConnection
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* Used to register connection details for external systems. Supported ConnectionTypes: 'Database'.   Supported DatabaseTypes: 'SqlServer'
*/
open class ExternalConnection
{
    var Workspace:String? = null
    var ObjectId:String? = null
    var Name:String? = null
    var Description:String? = null
    var ConnectionType:String? = null
    var DatabaseType:String? = null
    var Server:String? = null
    var Port:String? = null
    var Database:String? = null
    var UserId:String? = null
    var Password:String? = null
    var AuthorizationType:String? = null
    var BaseUrl:String? = null
    var HttpHeaders:String? = null
    var LastUpdated:String? = null
    var HasCredentials:Boolean? = null
}

Kotlin ExternalConnection DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /{Workspace}/ExternalConnection/{ObjectId} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Workspace: String,
	ObjectId: String,
	Name: String,
	Description: String,
	ConnectionType: String,
	DatabaseType: String,
	Server: String,
	Port: String,
	Database: String,
	UserId: String,
	Password: String,
	AuthorizationType: String,
	BaseUrl: String,
	HttpHeaders: String,
	LastUpdated: String,
	HasCredentials: False
}