Field Squared API Services

<back to all web services

IntegrationDataTableDDL

Generates the database DDL for a given integration data table. Database types supported: SQLServer

The following routes are available for this service:
POST/{Workspace}/IntegrationDataTableDDL
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 MetadataItem:
    name: Optional[str] = None
    datatype: Optional[str] = None
    length: Optional[str] = None
    label: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class IntegrationDataTable:
    name: Optional[str] = None
    columns: Optional[List[MetadataItem]] = None
    rows: Optional[List[List[str]]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class IntegrationDataTableDDL:
    """
    Generates the database DDL for a given integration data table.  Database types supported: SQLServer
    """

    workspace: Optional[str] = None
    database_type: Optional[str] = None
    data_table: Optional[IntegrationDataTable] = None
    ddl: Optional[str] = None

Python IntegrationDataTableDDL DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /{Workspace}/IntegrationDataTableDDL HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Workspace: String,
	DatabaseType: String,
	DataTable: 
	{
		Name: String,
		Columns: 
		[
			{
				Name: String,
				Datatype: String,
				Length: String
			}
		],
		Rows: 
		[
			[
				String
			]
		]
	},
	DDL: String
}