Skip to main content

API - Rule Execution

The Rule Execution API allows triggering the execution of scheduled rules for a specific date, typically after a batch upload is completed. It is also possible to force the execution of specific rules regardless of their schedule.

Important

When using the endpoint to run rules outside of their schedules, execution_date needs to be a past date.

If you need a business rule to run again in the same day, set the force flag to true.

Execution Modes​

Executes the periodic (cron-based) rules that are due on the provided execution_date.

  • Only execution_date provided All live rules scheduled for that date will be executed.
  • execution_date + rule_ids provided

Only the specified live rules scheduled for that date will be executed.

info
  • Rule Scheduling: Rule execution is determined by the scheduled day configured within the business rule manager. For example, if the execution endpoint is called on November 22nd, it will process all live rules scheduled to run on November 22nd, irrespective of the time of day.
  • Multiple Daily Runs: To execute the same rule more than once within a single day, the rule execution must be triggered again for that specific rule.
  • The force flag cannot override a rule's schedule. If a rule is not scheduled for the specified date, it will not execute regardless of the force setting.

Response Details​

The response includes two lists:

  • accepted_rules: Rules that will be executed for the given execution_date.
  • rejected_rules: Rules that will not be executed. Each rejection includes a reason - review these carefully.

Execution Timing​

Rule execution does not occur immediately if transaction or entity ingestion processes are still in progress. Once ingestion is complete, the rules will automatically execute based on the submitted request.

Loading ...