API Reference | InRule

📄️ API Reference

How to reference the InRule for JavaScript SDK file after packaging a Rule Application, for use in a browser application.

AuthoringMetadata API reference: read metadata attached to rule application elements at authoring time via getAttributeValue and getAttributes.

inrule API reference: the top-level InRule for JavaScript object, including createRuleSession and getVersion.

Collection API reference: the runtime representation of a collection, accessed via Entity.getCollection(collectionName).

CollectionMember API reference: the runtime representation of a collection member, with getField and getCollection methods.

DataManager API reference: access Inline Tables and Value Lists at runtime via getValueList and getInlineTable.

Entity API reference: the runtime instance of an authored Entity, with getField, getCollection, and related methods.

Field API reference: the runtime representation of a Field, including getName, getElementId, and getValue.

Notification API reference: represents a notification fired by a Fire Notification action at runtime.

PassThruQueryParameter API reference: a name/value pair used as a query value list pass-through parameter.

RuleExecutionLog API reference: the log of engine actions during rule execution, populated only when logging is enabled at packaging.

RuleSession API reference: create entities and execute rules; created via inrule.createRuleSession().

RuleSet API reference: the runtime instance of an authored Independent Rule Set, with getName and execute.

Validation API reference: represents a validation fired by a Mark Field Invalid action at runtime.

ValidationReason API reference: represents a specific reason behind a field invalidation.

ValueList API reference: an authored Value List datatype at runtime, with getItem and getValues.

ValueListItem API reference: a discrete item in a ValueList, exposing its value and display name.