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

public class dtos
{

    /**
    * 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 static class RuleModuleOutput
    {
        public String Workspace = null;
        public String RuleId = null;
        public String RequestId = null;
        public ArrayList<IntegrationDataTable> DataTables = null;
        
        public String getWorkspace() { return Workspace; }
        public RuleModuleOutput setWorkspace(String value) { this.Workspace = value; return this; }
        public String getRuleId() { return RuleId; }
        public RuleModuleOutput setRuleId(String value) { this.RuleId = value; return this; }
        public String getRequestId() { return RequestId; }
        public RuleModuleOutput setRequestId(String value) { this.RequestId = value; return this; }
        public ArrayList<IntegrationDataTable> getDataTables() { return DataTables; }
        public RuleModuleOutput setDataTables(ArrayList<IntegrationDataTable> value) { this.DataTables = 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 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