Use this resource at design time to confirm that attribute definitions referenced in a product model, constraint model, or request payload exist and are active. For each lookup, specify at least one of attributeId, attributeCode, or attributeName. The API resolves lookups by attribute ID, then attribute code, and then developer name, and returns results in the same order as the request.
A result sets isValid to true when the attribute definition exists and IsActive is true. When the attribute is invalid, instructions contains the resolution guidance. Those per-attribute failures are returned in the response body:
- SF-INS-DSAV-00030 — the attribute definition wasn’t found.
- SF-INS-DSAV-00031 — the attribute definition exists but isn’t active.
- SF-INS-DSAV-00032 — the lookup didn’t include an attribute ID, code, or developer name.
Specify contextDefinitionId when you need to resolve dynamic context attributes, such as names that start with DYN__INS__, against a context definition before the API looks up AttributeDefinition records. The API resolves lookups in bulk. Regardless of how many attributes you specify, it issues at most three queries, one for each identifier type, and then matches every lookup against those results.
Top-level errors are returned in errors when the request can’t be validated per attribute. A missing request body or an empty lookup list returns SF-INS-DSAV-00032 with HTTP status 400. Insufficient access, or Digital Insurance not enabled for the org, returns INSUFFICIENT_ACCESS with HTTP status 403. An unexpected failure returns INTERNAL_SERVER_ERROR with HTTP status 500.
Resource
/connect/insurance/design-advisor/attribute-validation
Resource Example
Replace {yourInstance} with the My Domain name of your Salesforce org.
https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/design-advisor/attribute-validation
Available Version
68.0
HTTP Methods
POST
Request Body for POST
JSON Example
{
"contextDefinitionId": "11Oxx0000004CXqEAM",
"attributeLookups": [
{
"attributeId": "0QPxx0000004CAAQ"
},
{
"attributeCode": "Make"
},
{
"attributeName": "Vehicle_Model"
},
{
"attributeCode": "SF-INS-DSAV-00032"
},
{}
]
}
Properties
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| attributeLookups | Insurance Attribute Input[] | Attribute definitions to validate. Each entry identifies one attribute definition by ID, code, or developer name. The API confirms that each definition exists in the org and is active. Results are returned in the same order as this list. | Required | 68.0 |
| contextDefinitionId | String | ID of the context definition. When you specify this ID, dynamic context attributes, such as attributes whose names start with DYN__INS__, are resolved against that context definition’s dynamic-attributes catalog before the API looks up AttributeDefinition records. | Optional | 68.0 |