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