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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<ExternalConnection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Integration">
  <AuthorizationType>String</AuthorizationType>
  <BaseUrl>String</BaseUrl>
  <ConnectionType>String</ConnectionType>
  <Database>String</Database>
  <DatabaseType>String</DatabaseType>
  <Description>String</Description>
  <HasCredentials>false</HasCredentials>
  <HttpHeaders>String</HttpHeaders>
  <LastUpdated>String</LastUpdated>
  <Name>String</Name>
  <ObjectId>String</ObjectId>
  <Password>String</Password>
  <Port>String</Port>
  <Server>String</Server>
  <UserId>String</UserId>
  <Workspace>String</Workspace>
</ExternalConnection>