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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Field2Office.API.Model.Integration;
using Field2Office.DomainObjects.Model;

namespace Field2Office.API.Model.Integration
{
    ///<summary>
    ///Generates the database DDL for a given integration data table.  Database types supported: SQLServer
    ///</summary>
    public partial class IntegrationDataTableDDL
    {
        public virtual string Workspace { get; set; }
        public virtual string DatabaseType { get; set; }
        public virtual IntegrationDataTable DataTable { get; set; }
        public virtual string DDL { get; set; }
    }

    public partial class MetadataItem
    {
        public virtual string Name { get; set; }
        public virtual string Datatype { get; set; }
        public virtual string Length { get; set; }
        public virtual string Label { get; set; }
    }

}

namespace Field2Office.DomainObjects.Model
{
    public partial class IntegrationDataTable
    {
        public IntegrationDataTable()
        {
            Columns = new List<MetadataItem>{};
            Rows = new List<List<String>>{};
        }

        public virtual string Name { get; set; }
        public virtual List<MetadataItem> Columns { get; set; }
        public virtual List<List<String>> Rows { get; set; }
    }

}

C# 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"}