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

application/json

Body

required

oneOf

EvaluateDecisionRequestByKey

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.

EvaluateDecisionRequestById

decisionDefinitionId string

The ID of the decision to be evaluated. Cannot be used together with decisionDefinitionKey. When using the decision ID, the latest deployed version of the decision is used.

variables object

The message variables as JSON document.

property name* any

Additional properties allowed.

tenantId string

The tenant ID of the decision.

Responses

200

The decision was evaluated.

application/json

Schema

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.

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.

evaluatedDecisions object[]
Decisions that were evaluated within the requested decision evaluation.
Array [
decisionDefinitionKey string
The unique key identifying the decision which was evaluate.
]

Example (from schema)

{
  "decisionDefinitionKey": "string",
  "decisionRequirementsKey": "string",
  "decisionInstanceKey": "string",
  "evaluatedDecisions": [
    {
      "decisionDefinitionKey": "string",
      "decisionDefinitionId": "string",
      "decisionDefinitionName": "string",
      "decisionDefinitionVersion": 0,
      "decisionDefinitionType": "string",
      "output": "string",
      "tenantId": "string",
      "matchedRules": [
        {
          "ruleId": "string",
          "ruleIndex": 0,
          "evaluatedOutputs": [
            {
              "outputId": "string",
              "outputName": "string",
              "outputValue": "string"
            }
          ]
        }
      ],
      "evaluatedInputs": [
        {
          "inputId": "string",
          "inputName": "string",
          "inputValue": "string"
        }
      ]
    }
  ],
  "decisionDefinitionId": "string",
  "decisionDefinitionName": "string",
  "decisionDefinitionVersion": 0,
  "decisionRequirementsId": "string",
  "output": "string",
  "failedDecisionDefinitionId": "string",
  "failureMessage": "string",
  "tenantId": "string"
}

application/vnd.camunda.api.keys.number+json

Schema

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.

decisionDefinitionKey int64

The unique key identifying the decision which was evaluated.

decisionRequirementsKey int64

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

decisionInstanceKey int64

The unique key identifying this decision evaluation.

evaluatedDecisions object[]
Decisions that were evaluated within the requested decision evaluation.
Array [
decisionDefinitionKey int64
The unique key identifying the decision which was evaluate.
]

Example (from schema)

{
  "decisionDefinitionKey": 0,
  "decisionRequirementsKey": 0,
  "decisionInstanceKey": 0,
  "evaluatedDecisions": [
    {
      "decisionDefinitionKey": 0,
      "decisionDefinitionId": "string",
      "decisionDefinitionName": "string",
      "decisionDefinitionVersion": 0,
      "decisionDefinitionType": "string",
      "output": "string",
      "tenantId": "string",
      "matchedRules": [
        {
          "ruleId": "string",
          "ruleIndex": 0,
          "evaluatedOutputs": [
            {
              "outputId": "string",
              "outputName": "string",
              "outputValue": "string"
            }
          ]
        }
      ],
      "evaluatedInputs": [
        {
          "inputId": "string",
          "inputName": "string",
          "inputValue": "string"
        }
      ]
    }
  ],
  "decisionDefinitionId": "string",
  "decisionDefinitionName": "string",
  "decisionDefinitionVersion": 0,
  "decisionRequirementsId": "string",
  "output": "string",
  "failedDecisionDefinitionId": "string",
  "failureMessage": "string",
  "tenantId": "string"
}

application/vnd.camunda.api.keys.string+json

Schema

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.

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.

evaluatedDecisions object[]
Decisions that were evaluated within the requested decision evaluation.
Array [
decisionDefinitionKey string
The unique key identifying the decision which was evaluate.
]

Example (from schema)

{
  "decisionDefinitionKey": "string",
  "decisionRequirementsKey": "string",
  "decisionInstanceKey": "string",
  "evaluatedDecisions": [
    {
      "decisionDefinitionKey": "string",
      "decisionDefinitionId": "string",
      "decisionDefinitionName": "string",
      "decisionDefinitionVersion": 0,
      "decisionDefinitionType": "string",
      "output": "string",
      "tenantId": "string",
      "matchedRules": [
        {
          "ruleId": "string",
          "ruleIndex": 0,
          "evaluatedOutputs": [
            {
              "outputId": "string",
              "outputName": "string",
              "outputValue": "string"
            }
          ]
        }
      ],
      "evaluatedInputs": [
        {
          "inputId": "string",
          "inputName": "string",
          "inputValue": "string"
        }
      ]
    }
  ],
  "decisionDefinitionId": "string",
  "decisionDefinitionName": "string",
  "decisionDefinitionVersion": 0,
  "decisionRequirementsId": "string",
  "output": "string",
  "failedDecisionDefinitionId": "string",
  "failureMessage": "string",
  "tenantId": "string"
}

400

The provided data is not valid.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

404

The decision is not found.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

500

An internal error occurred while processing the request.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Loading...