Skip to main content
Version: 1.0.0

Administration Configuration API

Admin API for managing Business Rules Engine (BRE) rule definitions.

Rules are authored as decision-graph documents (jdm field) and evaluated on demand via the Rules Evaluation API. Each rule has a human-readable ruleKey, a version counter (auto-incremented on each update), and a lifecycle status.

Rule lifecycle

statusMeaning
DRAFTRule under development — not eligible for evaluation
ACTIVERule is live and can be evaluated
INACTIVERule deactivated (soft-deleted) — excluded from evaluation

The DELETE endpoint sets status to INACTIVE; no data is removed.

Authentication: ADMIN role required (OAuth2 client-credentials).

Error envelope: { errorCode, message, timestamp, traceId } where errorCode follows the pattern {DOMAIN}{CLASSIFICATION}{SEQUENCE}.

Authentication

Client credentials flow - requires ADMIN role

Security Scheme Type: oauth2
OAuth Flow (clientCredentials): Scopes: