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 Foundation
import ServiceStack

/**
* Used to register connection details for external systems. Supported ConnectionTypes: 'Database'.   Supported DatabaseTypes: 'SqlServer'
*/
public class ExternalConnection : Codable
{
    public var workspace:String
    public var objectId:String
    public var name:String
    public var Description:String
    public var connectionType:String
    public var databaseType:String
    public var server:String
    public var port:String
    public var database:String
    public var userId:String
    public var password:String
    public var authorizationType:String
    public var baseUrl:String
    public var httpHeaders:String
    public var lastUpdated:String
    public var hasCredentials:Bool

    required public init(){}
}


Swift 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
}