| 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 .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
}