HTTP Request Member Definitions

Name

Description

RequestId

(Guid) A GUID that is sent back with the response that can be used as a correlation identifier.

RequestId is optional.

RuleApp

Parent element containing information used to load the rule application from disk or irCatalog.

RuleEngineServiceOptions

Parent element containing override options for Session, Endpoints and Data Elements.

RuleEngineServiceOptions are optional.

RuleEngineServiceOutputTypes

Parent element defining filters for the outgoing response.

RuleEngineServiceOutputTypes are optional.

EntityState

(string) An encoded XML representation of an entity that rules are going to be executed against.

EntityState must contain an xml declaration tag:

<?xml version="1.0" encoding="UTF-8" ?>

When encoded inside of JSON, quotes need to be escaped as double quotes.

When encoded inside of XML, standard XML escaping applies:

Used by ApplyRules, ExecuteIndependentRuleSet and ExecuteRuleSet.

EntityName

(string) Name of the XML encoded entity in EntityState.

Used by ApplyRules and ExecuteRuleSet.

RuleSetName

(string) Independent or Entity RuleSet name to execute.

Used by ExecuteIndependentRuleSet and ExecuteRuleSet.

EntityStateFieldName

(string) Name of the entity parameter of the Independent Rule Set which will be loaded from EntityState.

Note: This property is deprecated after InRule version 5.0.28. Going forward use the Parameters array to pass in Rule Set Input Parameters.

Used by ExecuteIndependentRuleSet.

Parameters

(Parameter[]) Array of Parameter objects that correlate to Input Parameters in Rule Sets.

Used by ExecuteIndependentRuleSet and ExecuteRuleSet.