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}
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>
    ///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>
    [<AllowNullLiteral>]
    type RuleModuleOutput() = 
        member val Workspace:String = null with get,set
        member val RuleId:String = null with get,set
        member val RequestId:String = null with get,set
        member val DataTables:ResizeArray<IntegrationDataTable> = new ResizeArray<IntegrationDataTable>() with get,set

F# RuleModuleOutput 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.

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