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

namespace Field2Office.API.Model.Integration
{
    public partial class MetadataItem
    {
        public virtual string Name { get; set; }
        public virtual string Datatype { get; set; }
        public virtual string Length { get; set; }
        public virtual string Label { 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>
    public partial class RuleModuleOutput
    {
        public RuleModuleOutput()
        {
            DataTables = new List<IntegrationDataTable>{};
        }

        public virtual string Workspace { get; set; }
        public virtual string RuleId { get; set; }
        public virtual string RequestId { get; set; }
        public virtual List<IntegrationDataTable> DataTables { get; set; }
    }

}

namespace Field2Office.DomainObjects.Model
{
    public partial class IntegrationDataTable
    {
        public IntegrationDataTable()
        {
            Columns = new List<MetadataItem>{};
            Rows = new List<List<String>>{};
        }

        public virtual string Name { get; set; }
        public virtual List<MetadataItem> Columns { get; set; }
        public virtual List<List<String>> Rows { get; set; }
    }

}

C# RuleModuleOutput DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json