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}
RuleModuleOutput Parameters:
NameParameterData TypeRequiredDescription
WorkspacepathstringNo
RuleIdpathstringNo
RequestIdquerystringNo
DataTablesqueryList<IntegrationDataTable>No
IntegrationDataTable Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ColumnsformList<MetadataItem>No
RowsformList<List<String>>No
MetadataItem Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
DatatypeformstringNo
LengthformstringNo
LabelformstringNo

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

HTTP + CSV

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: text/csv