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
namespace Field2Office.API.Model.Integration

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type MetadataItem() = 
        member val Name:String = null with get,set
        member val Datatype:String = null with get,set
        member val Length:String = null with get,set
        member val Label:String = null with get,set

    [<AllowNullLiteral>]
    type IntegrationDataTable() = 
        member val Name:String = null with get,set
        member val Columns:ResizeArray<MetadataItem> = new ResizeArray<MetadataItem>() with get,set
        member val Rows:ResizeArray<List<String>> = new ResizeArray<List<String>>() with get,set

    ///<summary>
    ///Generates the database DDL for a given integration data table.  Database types supported: SQLServer
    ///</summary>
    [<AllowNullLiteral>]
    type IntegrationDataTableDDL() = 
        member val Workspace:String = null with get,set
        member val DatabaseType:String = null with get,set
        member val DataTable:IntegrationDataTable = null with get,set
        member val DDL:String = null with get,set

F# IntegrationDataTableDDL DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

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