Schemas

TestCase

inputs

required

dict[var_name, series] for formula derivations; list[series] for rollup derivations. Each series is a list of [iso8601-timestamp, value] pairs.

expected

required

The value run(inputs, row) must return for this case to pass.

row

object

Extra bound SPARQL variables (formula) or {"node": ""} (rollup). Defaults to {}.

TestCaseResult

passed

boolean · required

actual

required

What run() actually returned, or null if it errored.

expected

required

error

string | null

CreateDerivationRequest

name

string · required

fn_source

string · required

Python source defining def run(inputs, row): ... Executed in a restricted sandbox - see this document's security note.

TestCase[] · minItems: 1 · required

kind

string · enum

Enum values:

formula

rollup

Default: formula

select

string

formula only. SPARQL SELECT binding target_var and every name in input_vars/extra_vars.

target_var

string

formula only.

input_vars

string[]

formula only. Bound to fn's inputs dict, each read as a point history series.

extra_vars

string[]

formula only. Bound SPARQL variables passed through to fn's row as raw values, not read as point histories (e.g. a threshold literal).

object

formula only. Per-input_var override of window_seconds, for mixing points with very different update cadences.

root_select

string

rollup only. SPARQL SELECT binding ?root, one row per top-level entity to roll up.

part_relationship

string

rollup only. Parent->child predicate CURIE to walk, e.g. brick:hasPart.

leaf_point_class

string

rollup only. Brick class CURIE identifying which directly-attached points at any tree node count as leaf inputs, e.g. brick:Meter.

window_seconds

number

Default: 3600

interval_seconds

number | null

Overrides the engine's default sweep tick for this derivation only.

applies_to_topic_glob

string | null

formula only. When set, an incoming MQTT message matching this glob triggers an immediate targeted re-evaluation in addition to the periodic sweep.

object

depends_on

string[]

Ids of other derivations that must be evaluated first in the same sweep.

Derivation

id

string · required

name

string · required

fn_source

string · required

Python source defining def run(inputs, row): ... Executed in a restricted sandbox - see this document's security note.

TestCase[] · minItems: 1 · required

kind

string · enum

Enum values:

formula

rollup

Default: formula

select

string

formula only. SPARQL SELECT binding target_var and every name in input_vars/extra_vars.

target_var

string

formula only.

input_vars

string[]

formula only. Bound to fn's inputs dict, each read as a point history series.

extra_vars

string[]

formula only. Bound SPARQL variables passed through to fn's row as raw values, not read as point histories (e.g. a threshold literal).

object

formula only. Per-input_var override of window_seconds, for mixing points with very different update cadences.

root_select

string

rollup only. SPARQL SELECT binding ?root, one row per top-level entity to roll up.

part_relationship

string

rollup only. Parent->child predicate CURIE to walk, e.g. brick:hasPart.

leaf_point_class

string

rollup only. Brick class CURIE identifying which directly-attached points at any tree node count as leaf inputs, e.g. brick:Meter.

window_seconds

number

Default: 3600

interval_seconds

number | null

Overrides the engine's default sweep tick for this derivation only.

applies_to_topic_glob

string | null

formula only. When set, an incoming MQTT message matching this glob triggers an immediate targeted re-evaluation in addition to the periodic sweep.

object

depends_on

string[]

Ids of other derivations that must be evaluated first in the same sweep.

TraceEntry

target

string · required

derivation_id

string

computed_value

would_write_uri

string

would_attach_to

string

would_derive_from

string[]

error

string

TargetHealth

target_uri

string · required

consecutive_failures

integer · required

disabled

boolean · required

last_error

string | null

Error

error

string · required

TestCase

inputs

required

dict[var_name, series] for formula derivations; list[series] for rollup derivations. Each series is a list of [iso8601-timestamp, value] pairs.

expected

required

The value run(inputs, row) must return for this case to pass.

row

object

Extra bound SPARQL variables (formula) or {"node": ""} (rollup). Defaults to {}.

CreateDerivationRequest

name

string · required

fn_source

string · required

Python source defining def run(inputs, row): ... Executed in a restricted sandbox - see this document's security note.

TestCase[] · minItems: 1 · required

kind

string · enum

Enum values:

formula

rollup

Default: formula

select

string

formula only. SPARQL SELECT binding target_var and every name in input_vars/extra_vars.

target_var

string

formula only.

input_vars

string[]

formula only. Bound to fn's inputs dict, each read as a point history series.

extra_vars

string[]

formula only. Bound SPARQL variables passed through to fn's row as raw values, not read as point histories (e.g. a threshold literal).

object

formula only. Per-input_var override of window_seconds, for mixing points with very different update cadences.

root_select

string

rollup only. SPARQL SELECT binding ?root, one row per top-level entity to roll up.

part_relationship

string

rollup only. Parent->child predicate CURIE to walk, e.g. brick:hasPart.

leaf_point_class

string

rollup only. Brick class CURIE identifying which directly-attached points at any tree node count as leaf inputs, e.g. brick:Meter.

window_seconds

number

Default: 3600

interval_seconds

number | null

Overrides the engine's default sweep tick for this derivation only.

applies_to_topic_glob

string | null

formula only. When set, an incoming MQTT message matching this glob triggers an immediate targeted re-evaluation in addition to the periodic sweep.

object

depends_on

string[]

Ids of other derivations that must be evaluated first in the same sweep.

Derivation

id

string · required

name

string · required

fn_source

string · required

Python source defining def run(inputs, row): ... Executed in a restricted sandbox - see this document's security note.

TestCase[] · minItems: 1 · required

kind

string · enum

Enum values:

formula

rollup

Default: formula

select

string

formula only. SPARQL SELECT binding target_var and every name in input_vars/extra_vars.

target_var

string

formula only.

input_vars

string[]

formula only. Bound to fn's inputs dict, each read as a point history series.

extra_vars

string[]

formula only. Bound SPARQL variables passed through to fn's row as raw values, not read as point histories (e.g. a threshold literal).

object

formula only. Per-input_var override of window_seconds, for mixing points with very different update cadences.

root_select

string

rollup only. SPARQL SELECT binding ?root, one row per top-level entity to roll up.

part_relationship

string

rollup only. Parent->child predicate CURIE to walk, e.g. brick:hasPart.

leaf_point_class

string

rollup only. Brick class CURIE identifying which directly-attached points at any tree node count as leaf inputs, e.g. brick:Meter.

window_seconds

number

Default: 3600

interval_seconds

number | null

Overrides the engine's default sweep tick for this derivation only.

applies_to_topic_glob

string | null

formula only. When set, an incoming MQTT message matching this glob triggers an immediate targeted re-evaluation in addition to the periodic sweep.

object

depends_on

string[]

Ids of other derivations that must be evaluated first in the same sweep.