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}
import Foundation
import ServiceStack

/**
* 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. 
*/
public class RuleModuleOutput : Codable
{
    public var workspace:String
    public var ruleId:String
    public var requestId:String
    public var dataTables:[IntegrationDataTable] = []

    required public init(){}
}

public class IntegrationDataTable : Codable
{
    public var name:String
    public var columns:[MetadataItem] = []
    public var rows:[[String]] = []

    required public init(){}
}

public class MetadataItem : Codable
{
    public var name:String
    public var datatype:String
    public var length:String
    public var label:String

    required public init(){}
}


Swift 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