Hold Result Output Items

Output representation of the information related to individual hold result items.

JSON Example 

1[
2  {
3    "name": "Enrollment",
4    "id": "0x7fsss66",
5    "isRuleDriven": true,
6    "isExecuted": true
7  },
8  {
9    "name": "FeePayment",
10    "id": "0x7fsss67",
11    "isRuleDriven": false,
12    "isExecuted": false
13  }
14]

Properties 

Property NameTypeDescriptionFilter Group and VersionAvailable Version
associated​RulesAssociated Rule[]List of rules linked to the hold decision.Big, 64.064.0
descriptionStringDescription or title of the hold item.Big, 64.064.0
isExecutedBooleanIndicates whether the hold result has been executed (true) or not (false).Big, 64.064.0
isRule​BasedBooleanIndicates whether the hold result is driven by rules (true) or not (false).Big, 64.064.0
itemIdStringUnique ID of the hold item.Big, 64.064.0
nameStringName or title of the hold item.Big, 64.064.0