Skip to main content
Version: Next

Evaluate decision

POST 
/decision-definitions/evaluation

Evaluates a decision. You specify the decision to evaluate either by using its unique key (as returned by DeployResource), or using the decision ID. When using the decision ID, the latest deployed version of the decision is used.

Request​

Body

required
    oneOf
    decisionDefinitionKey int64

    The unique key identifying the decision to be evaluated. Cannot be used together with decisionDefinitionId.

    variables object

    The message variables as JSON document.

    property name* any

    Additional properties allowed.

    tenantId string

    The tenant ID of the decision.

Responses​

The decision was evaluated.

Schema
    decisionDefinitionId string

    The ID of the decision which was evaluated.

    decisionDefinitionName string

    The name of the decision which was evaluated.

    decisionDefinitionVersion int32

    The version of the decision which was evaluated.

    decisionRequirementsId string

    The ID of the decision requirements graph that the decision which was evaluated is part of.

    output string

    JSON document that will instantiate the result of the decision which was evaluated.

    failedDecisionDefinitionId string

    The ID of the decision which failed during evaluation.

    failureMessage string

    Message describing why the decision which was evaluated failed.

    tenantId string

    The tenant ID of the evaluated decision.

    evaluatedDecisions object[]

    Decisions that were evaluated within the requested decision evaluation.

  • Array [
    • decisionDefinitionKey int64

    The unique key identifying the decision which was evaluate.

    decisionDefinitionId string

    The ID of the decision which was evaluated.

    decisionDefinitionName string

    The name of the decision which was evaluated.

    decisionDefinitionVersion int32

    The version of the decision which was evaluated.

    decisionDefinitionType string

    The type of the decision which was evaluated.

    output string

    JSON document that will instantiate the result of the decision which was evaluated.

    tenantId string

    The tenant ID of the evaluated decision.

    matchedRules object[]

    The decision rules that matched within this decision evaluation.

  • Array [
    • ruleId string

    The ID of the matched rule.

    ruleIndex int32

    The index of the matched rule.

    evaluatedOutputs object[]

    The evaluated decision outputs.

  • Array [
    • outputId string

    The ID of the evaluated decision output.

    outputName string

    The name of the evaluated decision output.

    outputValue string

    The value of the evaluated decision output.

  • ]
  • ]
    • evaluatedInputs object[]

    The decision inputs that were evaluated within this decision evaluation.

  • Array [
    • inputId string

    The ID of the evaluated decision input.

    inputName string

    The name of the evaluated decision input.

    inputValue string

    The value of the evaluated decision input.

  • ]
  • ]
    • decisionDefinitionKey string

    The unique key identifying the decision which was evaluated.

    decisionRequirementsKey string

    The unique key identifying the decision requirements graph that the decision which was evaluated is part of.

    decisionInstanceKey string

    The unique key identifying this decision evaluation.

Loading...