Create a calc rule
const url = 'https://example.com/api/v1/calc-rules';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"description":"example","enabled":true,"inputs":[{"alias":"example","key":"example"}],"label":"example","name":"example","output_key":"example","owner_kind":"component","reduce":{"expr":"example"},"selector":{"component_types":["example"],"components":["example"],"system_types":["example"],"systems":["example"]}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/v1/calc-rules \ --header 'Content-Type: application/json' \ --data '{ "description": "example", "enabled": true, "inputs": [ { "alias": "example", "key": "example" } ], "label": "example", "name": "example", "output_key": "example", "owner_kind": "component", "reduce": { "expr": "example" }, "selector": { "component_types": [ "example" ], "components": [ "example" ], "system_types": [ "example" ], "systems": [ "example" ] } }'Authors a rule that derives its output key on each owner (each component its selector picks, or each system) from its aliased inputs, reduced by an expression over the aliases, each bound as the list of its current values (one per instance on a component, every member’s on a system, with members records beside it). Every input key must be registered (by name or uuid; the rule holds it by uuid) and health may not be one; each alias is an identifier of at most 64, not a keyword, a builtin or list function’s name, or a site binding (component, has, members, system, value), and unique; the reduce must compile and yield the output key’s type (a 422 placed at body.reduce.expr with its line and column, and the name when it is one no alias binds); the output must be a registered key that is not health and that no collection writes (a native probe’s key, or one a driver declares among its emits); an enabled rule may not close a cycle in the graph from every enabled rule’s input keys to its output key (a 422 naming the chain of keys), nor write a key another enabled rule writes (a 422 naming that rule). A list or get carries calc_error when a stored reduce no longer compiles. A name already taken is a 409. Returns the rule with its uuid. Audited. Gated by rule:create, with an all-scope grant.
Request Body required
Section titled “Request Body required ”object
A URL to the JSON Schema for this object.
What the rule derives and why
Defaults to true
The keys the rule reads, each by a unique alias its reduce uses; health may not be one
object
The name the reduce’s expression binds the input by: an identifier of at most 64, not a keyword, a builtin or list function’s name, or one of the calc site’s own bindings (component, has, members, system, value); unique in the rule
The property or metric the input reads, by name or uuid; the rule holds it by uuid, so a rename changes nothing
A human label
The rule’s name (lowercase letters, digits, hyphens)
The property or metric the rule writes: its type pins the reduce’s result. Not a reserved key (a native probe key, health), not a key a driver’s emits or a command type write, and not one another enabled rule writes
What the rule derives a value on: each component its selector picks, or each system its selector picks (read from the system’s role-bound members). Fixed at create
An expression over the inputs by alias
object
An expression over the inputs by alias, each bound as the list of its current values (one per instance on a component, every member’s on a system), yielding the output key’s type: max(tcp), avg(temp), any(call) || max(people) > 0
The owners the rule derives for: a component rule’s component_types and components, or a system rule’s system_types and systems; absent is every owner of its kind
object
A component rule: derive on components whose type falls within one of these component types
A component rule: derive on these components (by name or id on write; ids on read)
A system rule: derive on systems whose type falls within one of these system types (subtypes included)
A system rule: derive on these systems (by name or id on write; ids on read)
Responses
Section titled “ Responses ”Created
object
A URL to the JSON Schema for this object.
Why the stored reduce does not compile against the registries as they are now (an input key deleted or retyped, or an expression a newer diagnostic refuses); absent when it compiles. While present the rule cannot be enabled
object
The registered diagnostic that gave it, when one did (documented on the expressions page)
The 1-based column of the fault, when it has a line
The field at fault: an input’s key (inputs[0].key), reduce.expr or output_key
The 1-based line of the fault, when the reduce’s expression is what failed
Why it does not compile, or what it warns of
The warnings the stored reduce compiles with (a likely mistake, such as an input it never names), each with its code; notes only, never a fault: the rule computes all the same
object
The registered diagnostic that gave it, when one did (documented on the expressions page)
The 1-based column of the fault, when it has a line
The field at fault: an input’s key (inputs[0].key), reduce.expr or output_key
The 1-based line of the fault, when the reduce’s expression is what failed
Why it does not compile, or what it warns of
When the rule was created
What the rule derives and why
Whether the rule runs; an enabled rule is part of the key graph
The rule’s uuid, the stable form of name
The keys the rule reads, each by the alias its reduce uses
object
The name the reduce’s expression binds the input by
The key’s name now
The key’s uuid, which the rule holds it by
Which registry the key is in
A human label
The rule’s name, the address an operator types; renameable
Shipped with the platform and read-only
The property or metric the rule writes
Which lane the output key is on, derived from the registries
What the rule derives a value on: each component its selector picks, or each system its selector picks (read from the system’s role-bound members)
How many owners the caller may read hold a value the rule computed (on the list; 0 on a single read)
How many owners the caller may read the rule last failed on (on the list)
How many owners the caller may read are marked for the next tick (on the list)
How many owners the caller may read the rule last wrote nothing for: an input missing, a system with no members (on the list)
How the inputs reduce into the output: an expression over their aliases
object
An expression over the inputs by alias, each bound as the list of its current values (one per instance on a component, every member’s on a system), yielding the output key’s type: max(tcp), avg(temp), any(call) || max(people) > 0
The owners the rule derives for: a component rule’s components or a system rule’s systems; empty is every owner of its kind
object
A component rule: derive on components whose type falls within one of these component types
A component rule: derive on these components (by name or id on write; ids on read)
A system rule: derive on systems whose type falls within one of these system types (subtypes included)
A system rule: derive on these systems (by name or id on write; ids on read)
When the rule was last written
Bumps on every update
Example
{ "$schema": "/api/v1/schemas/CalcRuleBody.json", "inputs": [ { "lane": "property" } ], "output_lane": "property", "owner_kind": "component"}default
Section titled “default ”Error
object
A URL to the JSON Schema for this object.
A human-readable explanation specific to this occurrence of the problem.
Optional list of individual error details
object
Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’
Error message text
The value at the given location
A URI reference that identifies the specific occurrence of the problem.
HTTP status code
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
A URI reference to human-readable documentation for the error.
Example
{ "$schema": "/api/v1/schemas/ErrorModel.json", "detail": "Property foo is required but is missing.", "instance": "https://example.com/error-log/abc123", "status": 400, "title": "Bad Request", "type": "about:blank"}