| GET,POST,DELETE | /{Workspace}/ExternalConnection/{ObjectId} | ||
|---|---|---|---|
| GET | /{Workspace}/ExternalConnection |
/** @description Used to register connection details for external systems. Supported ConnectionTypes: 'Database'. Supported DatabaseTypes: 'SqlServer' */
export class ExternalConnection
{
public Workspace: string;
public ObjectId: string;
public Name: string;
public Description: string;
public ConnectionType: string;
public DatabaseType: string;
public Server: string;
public Port: string;
public Database: string;
public UserId: string;
public Password: string;
public AuthorizationType: string;
public BaseUrl: string;
public HttpHeaders: string;
public LastUpdated: string;
public HasCredentials: boolean;
public constructor(init?: Partial<ExternalConnection>) { (Object as any).assign(this, init); }
}
TypeScript ExternalConnection DTOs
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>