| GET,POST,DELETE | /{Workspace}/ExternalConnection/{ObjectId} | ||
|---|---|---|---|
| GET | /{Workspace}/ExternalConnection |
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ExternalConnection:
"""
Used to register connection details for external systems. Supported ConnectionTypes: 'Database'. Supported DatabaseTypes: 'SqlServer'
"""
workspace: Optional[str] = None
object_id: Optional[str] = None
name: Optional[str] = None
description: Optional[str] = None
connection_type: Optional[str] = None
database_type: Optional[str] = None
server: Optional[str] = None
port: Optional[str] = None
database: Optional[str] = None
user_id: Optional[str] = None
password: Optional[str] = None
authorization_type: Optional[str] = None
base_url: Optional[str] = None
http_headers: Optional[str] = None
last_updated: Optional[str] = None
has_credentials: bool = False
Python 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>