The Salesforce Developers website will undergo maintenance on May 29, 2024 from 3:00 a.m. UTC to 10:00 a.m. UTC. The maintenance process may affect the availability of our documentation. Please plan accordingly.

Rule Set Combinations API

The Rule Set Combinations API generates a string representation of a boolean expression created by entity filters involved in the passed rule set. When this expression is parsed by substituting the values of context dimensions, the rule set evaluates to true or false and eligibility of offers is determined for a context.

The Rule Set Combinations API call is required if you have rule sets associated with your catalog. If you do not have any rule sets linked to your catalog, you do not need to perform this API call. If this is the case, the CatalogCodeToRuleAssignments node from the response of the Catalog Profile API will be empty.

You can obtain the rulesetId required in the URI of this API from the values of the hash map in the apiResponse.data.catalogCodeToRuleAssignments node in the response body of the Catalog Profile API.

You must first run the Catalog Profile API to obtain the rulesetId required in the request body of this API.

/services/apexrest/{namespace}/v3/admin/ruleset/{rulesetId}/rulesetcombinations

GET

If you specify just one of these two parameters, it follows the behavior described in the table below and accepts your defined time for the parameter you specified. If you are using one or both parameters, you must specify them with the same values for all of the Populate Cache APIs in this sequence.

ParameterExampleDefaultOptional/RequiredNotes
effectiveStartTime2001-07-04T12:08:56Current date and timeOptionaleffectiveStartTime is the time that you want your cached catalog entries to be effective. It should be in the UTC date-time format. Your effectiveStartTime must occur after the current time for which you are executing the Populate Cache APIs or you will receive an error message.
expirationTime2001-07-04T12:08:56effectiveStartTime + TimeToLiveOptionalexpirationTime is the time that you want your cached catalog entries to expire. It should also be in the UTC date-time format. Your expirationTime must occur after your effectiveStartTime or you receive an error message. TimeToLive is a custom setting created in CPQ Configuration Setup. It has a default value of 30 days.

Here is an example of how to pass the URI parameters:

This is an example of how you invoke the API using Apex:

You can run this API in parallel for multiple catalogs. For example, if you have 100 catalogs (Catalog1, Catalog2..Catalog 100), you can run the API for all 100 catalogs in 100 parallel threads.

HeaderDescription
Content-Typeapplication/json

This example shows a string representation of a boolean expression created by entity filters involved in the passed rule set.

CodeDescription
200OK
500Internal Server Error