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 java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Generates the database DDL for a given integration data table.  Database types supported: SQLServer
    */
    public static class IntegrationDataTableDDL
    {
        public String Workspace = null;
        public String DatabaseType = null;
        public IntegrationDataTable DataTable = null;
        public String DDL = null;
        
        public String getWorkspace() { return Workspace; }
        public IntegrationDataTableDDL setWorkspace(String value) { this.Workspace = value; return this; }
        public String getDatabaseType() { return DatabaseType; }
        public IntegrationDataTableDDL setDatabaseType(String value) { this.DatabaseType = value; return this; }
        public IntegrationDataTable getDataTable() { return DataTable; }
        public IntegrationDataTableDDL setDataTable(IntegrationDataTable value) { this.DataTable = value; return this; }
        public String getDdl() { return DDL; }
        public IntegrationDataTableDDL setDdl(String value) { this.DDL = value; return this; }
    }

    public static class IntegrationDataTable
    {
        public String Name = null;
        public ArrayList<MetadataItem> Columns = null;
        public ArrayList<ArrayList<String>> Rows = null;
        
        public String getName() { return Name; }
        public IntegrationDataTable setName(String value) { this.Name = value; return this; }
        public ArrayList<MetadataItem> getColumns() { return Columns; }
        public IntegrationDataTable setColumns(ArrayList<MetadataItem> value) { this.Columns = value; return this; }
        public ArrayList<ArrayList<String>> getRows() { return Rows; }
        public IntegrationDataTable setRows(ArrayList<ArrayList<String>> value) { this.Rows = value; return this; }
    }

    public static class MetadataItem
    {
        public String Name = null;
        public String Datatype = null;
        public String Length = null;
        public String Label = null;
        
        public String getName() { return Name; }
        public MetadataItem setName(String value) { this.Name = value; return this; }
        public String getDatatype() { return Datatype; }
        public MetadataItem setDatatype(String value) { this.Datatype = value; return this; }
        public String getLength() { return Length; }
        public MetadataItem setLength(String value) { this.Length = value; return this; }
        public String getLabel() { return Label; }
        public MetadataItem setLabel(String value) { this.Label = value; return this; }
    }

}

Java IntegrationDataTableDDL DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<IntegrationDataTableDDL xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Integration">
  <DDL>String</DDL>
  <DataTable xmlns:d2p1="http://schemas.datacontract.org/2004/07/Field2Office.DomainObjects.Model">
    <d2p1:Columns xmlns:d3p1="http://schemas.datacontract.org/2004/07/Field2Office.DomainObjects.Model.Rules">
      <d3p1:MetadataItem>
        <d3p1:Datatype>String</d3p1:Datatype>
        <d3p1:Length>String</d3p1:Length>
        <d3p1:Name>String</d3p1:Name>
      </d3p1:MetadataItem>
    </d2p1:Columns>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:Rows xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:ArrayOfstring>
        <d3p1:string>String</d3p1:string>
      </d3p1:ArrayOfstring>
    </d2p1:Rows>
  </DataTable>
  <DatabaseType>String</DatabaseType>
  <Workspace>String</Workspace>
</IntegrationDataTableDDL>