Rules

Server

Configure what counts as a fault.

List every configured rule

GET

http://localhost:8080/fault

/rules

List every configured rule › Responses

200

Every rule, as a JSON array.

Rule[]

Rule

id

string · required

Server-generated (a hex string, distinct from name) - this is the value a webhook's filter.rule_id must match, not name.

name

string · required

mode

string · enum · required

Enum values:

cur

his

type

string · enum · required

Enum values:

range

stuck

stale

object · required

Exactly one of topic_glob or brick_class - topic_glob for the original per-topic-string targeting, brick_class to target every point already classified into that Brick class (see mapping.classify_point) regardless of which topic/building/naming scheme it came from. fault_detector.py resolves a brick_class roster via SPARQL against the same Oxigraph graph mapping.py writes to, not against the topic string at all.

min

number

range only.

max

number

range only.

stuck_seconds

number

stuck only.

max_age_seconds

number

stale only.

severity

string

Free-form (e.g. info/warning/critical) - not validated or enumerated server-side, the alarm console UI just displays whatever string was given. Defaults to warning if omitted. Copied onto each fault this rule opens at open time (see Fault.severity) - editing a rule's severity later doesn't relabel faults it already raised.

Default: warning

Create a fault-detection rule

POST

http://localhost:8080/fault

/rules

mode is "cur" (evaluated in real time against live MQTT readings) or "his" (evaluated periodically against point_history). type is "range" (Cur-only), or "stuck"/ "stale" (His-only). Extra fields depend on type: range needs min/max; stuck needs stuck_seconds; stale needs max_age_seconds.

Create a fault-detection rule › Request Body

CreateRuleRequest

name

string · required

mode

string · enum · required

Enum values:

cur

his

type

string · enum · required

Enum values:

range

stuck

stale

object · required

min

number

range only.

max

number

range only.

stuck_seconds

number

stuck only.

max_age_seconds

number

stale only.

severity

string

Default: warning

Create a fault-detection rule › Responses

Created.

Rule

id

string · required

Server-generated (a hex string, distinct from name) - this is the value a webhook's filter.rule_id must match, not name.

name

string · required

mode

string · enum · required

Enum values:

cur

his

type

string · enum · required

Enum values:

range

stuck

stale

object · required

min

number

range only.

max

number

range only.

stuck_seconds

number

stuck only.

max_age_seconds

number

stale only.

severity

string

Default: warning

POST/rules

curl http://localhost:8080/fault/rules \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "zone-temp-out-of-range",
  "mode": "cur",
  "type": "range",
  "applies_to": {
    "topic_glob": "fbf/mock-ahu-1/*"
  },
  "min": 60,
  "max": 80
}'

Example Request Body

{
  "name": "zone-temp-out-of-range",
  "mode": "cur",
  "type": "range",
  "applies_to": {
    "topic_glob": "fbf/mock-ahu-1/*"
  },
  "min": 60,
  "max": 80
}

json

application/json

Example Responses

{
  "id": "e38a2a2a84404bb4ae50f1fa88535eda",
  "name": "zone-temp-out-of-range",
  "mode": "cur",
  "type": "range",
  "applies_to": {
    "topic_glob": "fbf/mock-ahu-1/*",
    "brick_class": "Zone_Air_Temperature_Sensor"
  },
  "min": 0,
  "max": 0,
  "stuck_seconds": 0,
  "max_age_seconds": 0,
  "severity": "warning"
}

json

application/json

Delete a rule

DELETE

http://localhost:8080/fault

/rules/{id}

Delete a rule › path Parameters

id

string · required

Delete a rule › Responses

Deleted. No response body.

No data returned

Webhooks

List every configured rule

GET

http://localhost:8080/fault

/rules

List every configured rule › Responses

200

Every rule, as a JSON array.

Rule[]

Rule

id

string · required

Server-generated (a hex string, distinct from name) - this is the value a webhook's filter.rule_id must match, not name.

name

string · required

mode

string · enum · required

Enum values:

cur

his

type

string · enum · required

Enum values:

range

stuck

stale

object · required

min

number

range only.

max

number

range only.

stuck_seconds

number

stuck only.

max_age_seconds

number

stale only.

severity

string

Default: warning

Create a fault-detection rule

POST

http://localhost:8080/fault

/rules

Create a fault-detection rule › Request Body

CreateRuleRequest

name

string · required

mode

string · enum · required

Enum values:

cur

his

type

string · enum · required

Enum values:

range

stuck

stale

object · required

min

number

range only.

max

number

range only.

stuck_seconds

number

stuck only.

max_age_seconds

number

stale only.

severity

string

Default: warning

Create a fault-detection rule › Responses

Created.

Rule

id

string · required

Server-generated (a hex string, distinct from name) - this is the value a webhook's filter.rule_id must match, not name.

name

string · required

mode

string · enum · required

Enum values:

cur

his

type

string · enum · required

Enum values:

range

stuck

stale

object · required

min

number

range only.

max

number

range only.

stuck_seconds

number

stuck only.

max_age_seconds

number

stale only.

severity

string

Default: warning