Business Rules

The Business Rules API supports the creation and management of business rules. These business rules are organized within rule sets.

Rule Sets

Contains the operations for creating, reading, and deleting rule sets.
get
Get all rule sets
Internal-Use OnlyReturns a resource collection of all the rule sets./ruleSets
post
Create a rule set
Internal-Use OnlyCreates a new rule set./ruleSets
head
Get the headers of a rule set
Internal-Use OnlyReturns the headers for the specified rule set./ruleSets/{ruleSetId}
get
Get a rule set
Internal-Use OnlyReturns the rule set for the provided ID./ruleSets/{ruleSetId}
put
Update a rule set
Internal-Use OnlyUpdates the rule set with the provided content./ruleSets/{ruleSetId}
delete
Delete a rule set
Internal-Use OnlyDeletes the specified rule set./ruleSets/{ruleSetId}
get
Get a rule set
Internal-Use OnlyReturns the decisioning revision summary of a rule set for the provided ID./ruleSets/{ruleSetId}
get
Get a rule set with all the rules
Internal-Use OnlyReturns the rule set with all the rules from the latest revision./ruleSets/{ruleSetId}
get
Get execution order of rules
Internal-Use OnlyReturns the order of the rules within the rule set./ruleSets/{ruleSetId}/order
put
Update rules execution order
Internal-Use OnlyReturns the execution order for rules within the rule set based on the provided body./ruleSets/{ruleSetId}/order
get
Get rule set code
Internal-Use OnlyReturns the code for integrating within another program so that program is able to run the rule set./ruleSets/{ruleSetId}/code
post
Get the mapped code for a rule set
Internal-Use OnlyReturns the code to be able to run the rule set based on the provided data and mapping information in the request./ruleSets/{ruleSetId}/mappedCode
post
Get rule set code without score definition
Internal-Use OnlyReturns the code to be able to run the rule set based on mapping to a static input and output data set of SASEP.IN and SASEP.OUT rather than binding to a score definition./ruleSets/{ruleSetId}/mappedCode
post
Get rule set code not bound to a score definition
Internal-Use OnlyReturns the code directly as text without being wrapped in a JSON model. The text can then be used to run the rule set based on mapping to a static input and output data set of SASEP.IN and SASEP.OUT rather than binding to a score definition./ruleSets/{ruleSetId}/mappedCode
post
Get rule set analysis code
Internal-Use OnlyReturns the analysis code to generate rule fired reports based on the scoring definition./ruleSets/{ruleSetId}/analysisCode
post
Get rule set analysis code as text
Internal-Use OnlyReturns the analysis code directly as text in response, not contained within a JSON model, to generate rule fired reports based on the analysis request./ruleSets/{ruleSetId}/analysisCode
get
Get the decision step code for a rule set
Internal-Use OnlyReturns the decision step code for the specified rule set./ruleSets/{ruleSetId}/decisionStepCode
post
Convert a rule action to a target type
Internal-Use OnlyConvert a rule action to a new target type./ruleSets/{ruleSetId}/actionConversion
post
Convert a rule condition to a target type
Internal-Use OnlyConvert a rule condition to a new target type./ruleSets/{ruleSetId}/conditionConversion
post
Retrieve a collection of errors
Internal-Use OnlyTests the validation of the rule content and returns a list of errors./ruleSets/{ruleSetId}/ruleValidations
get
Get legacy variables of a rule set
Internal-Use OnlyRetrieves the legacy variables of the rule set, which can be added back to the rule set./ruleSets/{ruleSetId}/legacyVariables
get
Get all revisions of a rule set
Internal-Use OnlyReturns all the revisions that were created for the rule set./ruleSets/{ruleSetId}/revisions
post
Create a new revision
Internal-Use OnlyCreates a new revision for the rule set. With this request, you supply the content that you want to initialize for a new revision./ruleSets/{ruleSetId}/revisions
post
Create a new revision with rules
Internal-Use OnlyCreates a new revision for the rule set with rules. In this request, you supply the content that you want to initialize for a new revision./ruleSets/{ruleSetId}/revisions
get
Get direct dependent objects
Internal-Use OnlyRetrieves the URIs for the direct dependent objects of the rule set./ruleSets/{ruleSetId}/dependencies
head
Get the headers of a rule set revision
Internal-Use OnlyReturns the headers for the specific rule set revision that was requested./ruleSets/{ruleSetId}/revisions/{revisionId}
get
Get a rule set revision
Internal-Use OnlyReturns the content for the specific rule set revision that was requested./ruleSets/{ruleSetId}/revisions/{revisionId}
delete
Delete a rule set revision
Internal-Use OnlyDeletes the specified locked rule set revision. To preserve editable content for users deletion of unlocked versions is not allowed./ruleSets/{ruleSetId}/revisions/{revisionId}
get
Get a rule set revision
Internal-Use OnlyReturns the content of the decisioning revision summary for the specific rule set revision that was requested./ruleSets/{ruleSetId}/revisions/{revisionId}
get
Get the rule set revision as a CSV file
Internal-Use OnlyExports all content for the specific rule set revisions to a CSV file, which matches the CSV format of /rules endpoint./ruleSets/{ruleSetId}/revisions/{revisionId}
get
Get the rule execution order for the revision
Internal-Use OnlyGets the order of the rules within the provided rule set revision./ruleSets/{ruleSetId}/revisions/{revisionId}/order
get
Get the code of a rule set revision
Internal-Use OnlyReturns the package code for a rule set revision./ruleSets/{ruleSetId}/revisions/{revisionId}/code
post
Get the mapped code of a rule set revision
Internal-Use OnlyReturns the code bound to the data that is specified in the score request for execution./ruleSets/{ruleSetId}/revisions/{revisionId}/mappedCode
post
Get rule set revision code without a score definition
Internal-Use OnlyReturns the code so that you can run the rule set revision. The code is based on the mapping of the static input (SASEP.IN) and output (SASEP.OUT) data sets, rather than binding to a score definition./ruleSets/{ruleSetId}/revisions/{revisionId}/mappedCode
post
Get code for rule set revision not bound to score definition
Internal-Use OnlyReturns the code directly as text without being wrapped in a JSON model. The text can then be used to run the rule set revision based on the mapping of the static input (SASEP.IN) and output (SASEP.OUT) data sets, rather than binding to a score definition./ruleSets/{ruleSetId}/revisions/{revisionId}/mappedCode
post
Get the analysis code of a rule set revision
Internal-Use OnlyReturns the analysis code necessary for collecting the information about the rules that fired./ruleSets/{ruleSetId}/revisions/{revisionId}/analysisCode
post
Get analysis code as text for rule set revision
Internal-Use OnlyReturns the analysis code directly as text in response, not contained within a JSON model, to generate rule fired reports based on the analysis request for the rule set revision./ruleSets/{ruleSetId}/revisions/{revisionId}/analysisCode
get
Get the decision step code for a rule set revision
Internal-Use OnlyReturns the decision step code for the specified rule set revision./ruleSets/{ruleSetId}/revisions/{revisionId}/decisionStepCode
get
Get lookups referenced by a rule set revision
Internal-Use OnlyRetrieves the lookups that are referenced by a revision of a rule set./ruleSets/{ruleSetId}/revisions/{revisionId}/lookups
get
Get resources referenced by a rule set revision
Internal-Use OnlyRetrieves the resources that are referenced by a rule set revision./ruleSets/{ruleSetId}/revisions/{revisionId}/referencedResources
get
Get terms by name in all rule sets
Internal-Use OnlyGet terms by name in all rule sets./ruleSetTerms

Rules

Contains the operations for importing, exporting, and querying rules directly.
get
Get all the rules for a rule set
Internal-Use OnlyReturns the collection of rules for a specified rule set./ruleSets/{ruleSetId}/rules
post
Create a rule
Internal-Use OnlyCreates a rule within the rule set./ruleSets/{ruleSetId}/rules
head
Get the headers for a rule
Internal-Use OnlyReturns the headers for the rule object./ruleSets/{ruleSetId}/rules/{rid}
get
Get rule details
Internal-Use OnlyReturns the details of a rule./ruleSets/{ruleSetId}/rules/{rid}
put
Update a rule
Internal-Use OnlyUpdates the rule with new rule content./ruleSets/{ruleSetId}/rules/{rid}
delete
Delete a rule
Internal-Use OnlyDeletes the rule from the rule set./ruleSets/{ruleSetId}/rules/{rid}
get
Get all rules for a revision
Internal-Use OnlyReturns the rules associated with that rule set revision./ruleSets/{ruleSetId}/revisions/{revisionId}/rules
head
Get the headers of a rule for a revision
Internal-Use OnlyReturns a specific rule header for this rule set revision./ruleSets/{ruleSetId}/revisions/{revisionId}/rules/{rid}
get
Get rule revision details
Internal-Use OnlyReturns the rule's state for the revision provided./ruleSets/{ruleSetId}/revisions/{revisionId}/rules/{rid}
get
Get all rules
Internal-Use OnlyReturns all rules based on a query for all rule sets./rules
get
Export rules to a CSV file
Internal-Use OnlyExports all rules for all rule sets to a CSV file./rules
post
Import rules from a CSV file
Internal-Use OnlyAdds rules to the system via importing large CSV files. Rules are created using the content passed within the CSV file. The passed data should have 1 line for each action and condition./rules

Functions

Contains the operations for creating, reading, and deleting functions.
get
Get a collection of functions in a category
Internal-Use OnlyReturns a collection of the functions in a specific category based on the specified pagination, filtering, and sorting options./functionCategories/{categoryId}/functions
post
Create a function
Internal-Use OnlyCreates a new function in a specific category./functionCategories/{categoryId}/functions
get
Get a collection of functions
Internal-Use OnlyReturns a collection of functions based on the specified pagination, filtering, and sorting options./functions
delete
Delete a function
Internal-Use OnlyDeletes the function with the provided ID./functions/{functionId}
get
Get a user-defined function
Internal-Use OnlyRetrieves the user-defined function with the given ID./functions/{functionId}
put
Update a function
Internal-Use OnlyUpdates the function with the provided content./functions/{functionId}
post
Validate a custom function
Internal-Use OnlyVerifies that the custom function compiles without errors./commons/validations/functions