Workbench
GET
3 endpoints
/api/v202609/workbench/bill/{billId}
GetWorkbenchBillV202609
Retrieves a single existing bill by ID, in the bill descriptor format bill processing rule scripts operate on
/api/v202609/workbench/schema
GetWorkbenchSchemaV202609
Retrieves the catalog of tables and columns the Workbench Data Explorer can query
/api/v202609/workbench/script/reference
GetWorkbenchScriptReferenceV202609
Retrieves a reference of the bill object and helper functions a bill processing rule script can use
POST
12 endpoints
/api/v202609/workbench/query
ExecuteWorkbenchQueryV202609
Executes an ad-hoc KQL query from the Workbench Data Explorer and returns its columns and rows
/api/v202609/workbench/query/explain
ExplainWorkbenchQueryV202609
Explains in plain language what a Workbench Data Explorer KQL query does, using the AI query assistant
/api/v202609/workbench/query/fix
FixWorkbenchQueryV202609
Repairs a Workbench Data Explorer KQL query that has errors, using the AI query assistant
/api/v202609/workbench/format
FormatWorkbenchQueryV202609
Formats a KQL query in the standard layout, with each pipe operator on its own line
/api/v202609/workbench/query/generate
GenerateWorkbenchQueryV202609
Writes a KQL query for the Workbench Data Explorer from a plain-language question, using the AI query assistant
/api/v202609/workbench/bill/{billId}/preview
PreviewWorkbenchBillV202609
Previews how an existing bill would look in EnergyCAP after a script, or all of its rules, ran, without saving anything
/api/v202609/workbench/rules/bill/{billId}
PreviewWorkbenchRulesAgainstBillV202609
Dry-runs every bill processing rule that applies to an existing bill, in import order, without saving any changes
/api/v202609/workbench/script/bills
PreviewWorkbenchScriptAgainstBillsV202609
Dry-runs one JavaScript bill processing rule script against several existing bills without saving any changes
/api/v202609/workbench/script/bill/{billId}
PreviewWorkbenchScriptAgainstBillV202609
Dry-runs a JavaScript bill processing rule script against an existing bill without saving any changes
/api/v202609/workbench/validate
ValidateWorkbenchQueryV202609
Checks a Workbench Data Explorer KQL query for errors without running it, with each error's position in the query
/api/v202609/workbench/script/validate
ValidateWorkbenchScriptV202609
Checks a bill processing rule script for syntax errors without running it
/api/v202609/workbench/query/prompt
WriteWorkbenchQueryPromptV202609
Writes the plain-language Watts Reports prompt that makes Watts Reports write a given KQL query, checked by running it