| GET,POST,DELETE | /{Workspace}/ExternalConnection/{ObjectId} | ||
|---|---|---|---|
| GET | /{Workspace}/ExternalConnection |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Workspace | path | string | No | |
| ObjectId | path | string | No | |
| Name | body | string | No | |
| Description | body | string | No | |
| ConnectionType | body | string | No | |
| DatabaseType | body | string | No | |
| Server | body | string | No | |
| Port | body | string | No | |
| Database | body | string | No | |
| UserId | body | string | No | |
| Password | body | string | No | |
| AuthorizationType | body | string | No | |
| BaseUrl | body | string | No | |
| HttpHeaders | body | string | No | |
| LastUpdated | body | string | No | |
| HasCredentials | body | bool | No |
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>