Start Rule Trace
openl_start_traceStart an asynchronous trace execution for a business rule table by providing parameters or test ranges. Use with openl_get_trace_nodes to retrieve results after completion.
Instructions
Start trace execution for a table. Trace is asynchronous (returns 202 Accepted). For regular rules: provide inputJson with { params: {...}, runtimeContext?: {...} }. For test tables: use testRanges (e.g. '1-3,5'). After starting, call openl_get_trace_nodes once — while the trace is still running it subscribes to the studio's trace-status websocket and waits for completion server-side (no manual polling/retrying on 409 needed).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tableId | Yes | Table ID to trace (e.g., 'calculatePremium_1234'). Get from openl_list_tables(). | |
| inputJson | No | For regular rules: JSON input. Use object with params (required) and runtimeContext (optional). E.g. { params: { age: 25 }, runtimeContext: { lob: 'Auto' } }. | |
| projectId | Yes | Project ID returned by backend. Use the exact 'projectId' value from openl_list_projects() response without modification or reformatting. | |
| fromModule | No | Module name for opened module execution. Usually omit. | |
| testRanges | No | For test tables: comma-separated ranges (e.g., '1-3,5'). Omit for regular rule/table execution. | |
| response_format | No | Response format: 'json' for structured data, 'markdown' for human-readable (default), 'markdown_concise' for brief summary (1-2 paragraphs), 'markdown_detailed' for full details with context | markdown |