| GET,POST,DELETE | /{Workspace}/ExternalConnection/{ObjectId} | ||
|---|---|---|---|
| GET | /{Workspace}/ExternalConnection |
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
/**
* Used to register connection details for external systems. Supported ConnectionTypes: 'Database'. Supported DatabaseTypes: 'SqlServer'
*/
public static class ExternalConnection
{
public String Workspace = null;
public String ObjectId = null;
public String Name = null;
public String Description = null;
public String ConnectionType = null;
public String DatabaseType = null;
public String Server = null;
public String Port = null;
public String Database = null;
public String UserId = null;
public String Password = null;
public String AuthorizationType = null;
public String BaseUrl = null;
public String HttpHeaders = null;
public String LastUpdated = null;
public Boolean HasCredentials = null;
public String getWorkspace() { return Workspace; }
public ExternalConnection setWorkspace(String value) { this.Workspace = value; return this; }
public String getObjectId() { return ObjectId; }
public ExternalConnection setObjectId(String value) { this.ObjectId = value; return this; }
public String getName() { return Name; }
public ExternalConnection setName(String value) { this.Name = value; return this; }
public String getDescription() { return Description; }
public ExternalConnection setDescription(String value) { this.Description = value; return this; }
public String getConnectionType() { return ConnectionType; }
public ExternalConnection setConnectionType(String value) { this.ConnectionType = value; return this; }
public String getDatabaseType() { return DatabaseType; }
public ExternalConnection setDatabaseType(String value) { this.DatabaseType = value; return this; }
public String getServer() { return Server; }
public ExternalConnection setServer(String value) { this.Server = value; return this; }
public String getPort() { return Port; }
public ExternalConnection setPort(String value) { this.Port = value; return this; }
public String getDatabase() { return Database; }
public ExternalConnection setDatabase(String value) { this.Database = value; return this; }
public String getUserId() { return UserId; }
public ExternalConnection setUserId(String value) { this.UserId = value; return this; }
public String getPassword() { return Password; }
public ExternalConnection setPassword(String value) { this.Password = value; return this; }
public String getAuthorizationType() { return AuthorizationType; }
public ExternalConnection setAuthorizationType(String value) { this.AuthorizationType = value; return this; }
public String getBaseUrl() { return BaseUrl; }
public ExternalConnection setBaseUrl(String value) { this.BaseUrl = value; return this; }
public String getHttpHeaders() { return HttpHeaders; }
public ExternalConnection setHttpHeaders(String value) { this.HttpHeaders = value; return this; }
public String getLastUpdated() { return LastUpdated; }
public ExternalConnection setLastUpdated(String value) { this.LastUpdated = value; return this; }
public Boolean isHasCredentials() { return HasCredentials; }
public ExternalConnection setHasCredentials(Boolean value) { this.HasCredentials = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>