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

Namespace Global

    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 Overridable Property Workspace As String
            Public Overridable Property DatabaseType As String
            Public Overridable Property DataTable As IntegrationDataTable
            Public Overridable Property DDL As String
        End Class

        Public Partial Class MetadataItem
            Public Overridable Property Name As String
            Public Overridable Property Datatype As String
            Public Overridable Property Length As String
            Public Overridable Property Label As String
        End Class
    End Namespace

    Namespace Field2Office.DomainObjects.Model

        Public Partial Class IntegrationDataTable
            Public Sub New()
                Columns = New List(Of MetadataItem)
                Rows = New List(Of List(Of String))
            End Sub

            Public Overridable Property Name As String
            Public Overridable Property Columns As List(Of MetadataItem)
            Public Overridable Property Rows As List(Of List(Of String))
        End Class
    End Namespace
End Namespace

VB.NET 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>