Output representation of the validation result for a single record. When the record
isn’t valid, the instructions paramter describes the
failure and recommended correction.
JSON Example
{
"recordId": "0nSxx0000001DDDAAI",
"recordType": "ProductSurcharge",
"productPath": "01txx0000006iPnAAI/01txx0000006iPnBBB",
"isValid": false,
"instructions": "One or more products in the product path aren't referenced by the active CML model. Update the product path or associate the products with the CML model."
}
Properties
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| instructions | String | Human-readable resolution guidance that describes the reason for a validation failure and how to resolve it. This property contains details when isValid is false. For valid results, this property is either omitted or contains informational context, such as when a BRE-based underwriting rule has no CML rule key. | Big, 68.0 | 68.0 |
| isValid | Boolean | Indicates whether this record passed validation (true) or not (false). When false, see instructions for the failure reason and correction. | Big, 68.0 | 68.0 |
| productPath | String | ProductPath field value from the validated record. This property is shown only when recordType is ProductSurcharge or InsuranceProductClause. | Big, 68.0 | 68.0 |
| recordId | String | ID of the record that’s validated. | Big, 68.0 | 68.0 |
| recordType | String | Type of record. Valid values are Product, ProductSurcharge, InsuranceProductClause, and UnderwritingRule. | Big, 68.0 | 68.0 |