Rule Response Format

Nected Rules – SimpleRule, DecisionTable, and Ruleset – use a pre-defined rule response format. The following sections show examples of the rule response format for each rule type.

Simple Rule

{
  "data": {
    "action": {
      "<action_name>(string)": {
        "executionId": "<action_execution_id>(string)",
      },
      ...
    },
    "executionId": "<rule_execution_id>(string)",
    "executionTime": "<execution_duration>(string duration in ms)",
    "output": [{
      "defaultOutputData": "<value>(boolean)",
      ...
    },],
    "ruleId": "<ruleId>(string)"
  },
  "code": "<response_code>(string)",
  "message": "<response_message>(string)",
}

Decision Table

{
  "data": {
    "action": {
      "<action_name>(string)": {
        "executionId": "<action_execution_id>(string)",
      },
      ...
    },
    "executionId": "<decision_table_execution_id>(string)",
    "executionTime": "<execution_duration>(string duration in ms)",
    "output": [{
      "<result_1>(string)": "<value>(any)",
      ...
    }, ...],
    "ruleId": "<ruleId>(string)"
  },
  "code": "<response_code>(string)",
  "message": "<response_message>(string)",
}

Rule Set

{
    "data": {
        "executionId": "<ruleSet_execution_id>(string)",
        "executionTime": "<execution_duration>(string duration in ms)",
        "output": [{
            "action": {
                "<action_name>(string)": {
                "executionId": "<action_execution_id>(string)"
                }
            },
            "output": [{
                "field_1": "field_type(defined type)",
                ...
                }...],
            "ruleId": "<ruleset_rule_id>(string)"
        }, ],
        "ruleId": "<ruleSet_id>(string)"
    },
    "code": "<response_code>(string)",
    "message": "<response_message>(string)",
}

Last updated