This API processes the input parameters in a strict order of precedence. The shouldIncludeAllHierarchies parameter takes the highest precedence over hierarchyIds and filters. If shouldIncludeAllHierarchies is set to false, then the specified list of hierarchyIds are considered for validation. If shouldIncludeAllHierarchies is set to false and hierarchyIds list isn't specified, then the filter parameter is used to select the hierarchies for validation.
Resource
/connect/flexible-hierarchies/actions/bulk-validate
Resource Example
https://yourInstance.salesforce.com/services/data/v68.0/connect/flexible-hierarchies/actions/bulk-validate
Available Version
66.0
HTTP Methods
POST
Request Body for POST
JSON Example
{
"filters": {
"conditions": [
{
"column": "Name",
"operator": "Equals",
"value": "SalesHierarchy"
}
],
"expression": "0"
},
"hierarchyIds": [
"001xx000003DGQyAAO",
"001xx000003DGQzAAO"
],
"shouldIncludeAllHierarchies": false
}
Properties
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| filters | Flexible Hierarchy Filters Input | Object that contains filter criteria to dynamically select the flexible hierarchies for validation. | Required if shouldIncludeAllHierarchies is false and hierarchyIds list is empty. | 66.0 |
| hierarchyIds | String[] | IDs of flexible hierarchies for validation. If this list is specified, it takes precedence over the filters parameter. |
Required if shouldIncludeAllHierarchies is set to false. | 66.0 |
| shouldInclude​AllHierarchies | Boolean | Indicates whether all the flexible hierarchies that
are in draft state must be included for validation
(true) or not
(false). If set to true, this parameter takes the highest precedence, and values that are specified in hierarchyIds and filters are not considered for validation. |
Optional | 66.0 |