You are viewing the documentation for Blueriq 17. Documentation for other versions is available in our documentation directory.
This custom schema element represents a justification tree for the configured attribute. When you add this element to your domain schema, it looks like this:
Parameters
The following parameters are available:
Parameter name | Required | Default value | Description |
---|---|---|---|
entityName | yes | n/a | The name of the entity |
attributeName | yes | n/a | The name of the attribute within the entity for which the justification tree should be created |
assetFormat | no | 'Text' | A comma separated string of asset formats that should be returned for the justification tree justification texts. The asset will only be included in the result if expanding the asset yields a non-empty result. |
useTechnicalName | no | False | By default, the functional name of the attribute is included in the result. If you set this parameter to 'True', the technical name (Entity.Attribute) will be used instead. |
Example
A Justification Tree V2 in a response of a BaaRS could look like this:
{ "Costs": 3000.0, "AQ_JustificationTreeV2": { "key": "Tax.AnnualAmount", "values": [ { "type": "number", "value": 3000.0 } ], "justification": [ { "key": "AdditionalText", "value": "Additional Justification tax statement." }, { "key": "Text", "value": "A car that is over 60k has a high annual tax." } ], "used_values": [ { "key": "Car.ModelYear", "values": [ { "type": "integer", "value": 1993 } ], "justification": null }, { "key": "Car.Value", "values": [ { "type": "number", "value": 70000.0 } ], "justification": null } ] } }
Differences with AQ_JustificationTree
- The V2 schema element will return typed values
- The V2 schema element will include the name of the asset format and it will be able to return multiple justification texts for different purposes
- In the V2 schema element, it is possible to configure that the technical name should be used
- The default behavior is to show the functional name. This changes the behavior of SOAP messages compared to AQ_JustificationTree, which always returned the technical name, but is now changed to match the Rest implementation.
Overview
Content Tools