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}

export class MetadataItem
{
    public Name: string;
    public Datatype: string;
    public Length: string;
    public Label: string;

    public constructor(init?: Partial<MetadataItem>) { (Object as any).assign(this, init); }
}

export class IntegrationDataTable
{
    public Name: string;
    public Columns: MetadataItem[];
    public Rows: string[][];

    public constructor(init?: Partial<IntegrationDataTable>) { (Object as any).assign(this, init); }
}

/** @description 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.  */
export class RuleModuleOutput
{
    public Workspace: string;
    public RuleId: string;
    public RequestId: string;
    public DataTables: IntegrationDataTable[];

    public constructor(init?: Partial<RuleModuleOutput>) { (Object as any).assign(this, init); }
}

TypeScript 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