Field Squared API Services

<back to all web services

RuleModuleOutput

Returns output of each module for the rule specified. When called without a requestid, the rule will be
executed by an integration server and the shape and first 10 rows of the output of each module will be stored. The service will return a requestID. When
queried with a previously generated requestid, the service will return the stored data if it's available.

The following routes are available for this service:
GET/{Workspace}/RuleModuleOutput/{RuleId}
GET/{Workspace}/RuleModuleOutput/ReturnLast/{RuleId}
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

        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

        '''<Summary>
        '''Returns output of each module for the rule specified.  When called without a requestid, the rule will be executed by an integration server and the shape and first 10 rows of the output of each module will be stored.  The service will return a requestID.  When queried with a previously generated requestid, the service will return the stored data if it's available. 
        '''</Summary>
        Public Partial Class RuleModuleOutput
            Public Sub New()
                DataTables = New List(Of IntegrationDataTable)
            End Sub

            Public Overridable Property Workspace As String
            Public Overridable Property RuleId As String
            Public Overridable Property RequestId As String
            Public Overridable Property DataTables As List(Of IntegrationDataTable)
        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 RuleModuleOutput 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.

GET /{Workspace}/RuleModuleOutput/{RuleId} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/csv