Skip to content

Commit

Permalink
docs(operate): document decision API
Browse files Browse the repository at this point in the history
  • Loading branch information
mihail-ca committed Jul 17, 2023
1 parent e3739c4 commit 6601e00
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/apis-tools/operate-api/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -552,14 +552,17 @@ The field flowNodeName is only returned if set in the BPMN diagram, so no flowNo
```

The field `evaluatedInputs` is an array of objects, where each object has the following fields:

```
{
"id": <string>
"name": <string>
"value": <string>
}
```

The field `evaluatedOutputs` is an array of objects, where each object has the following fields:

```
{
"id": <string>
Expand All @@ -569,6 +572,7 @@ The field `evaluatedOutputs` is an array of objects, where each object has the f
"ruleIndex": <number>
}
```

The fields `evaluatedInputs` and `evaluatedOutputs` are not returned in search results, because they can be very large. They are only returned when requesting a specific decision instance by identifier.
The fields `result`, `evaluatedInputs`, and `evaluatedOutputs` cannot be used to filter the search results.

Expand Down

0 comments on commit 6601e00

Please sign in to comment.