Rules Management API

Number of APIs: 6

Rules management can be used for configuring, reading, deleting and updating rules. It was mainly designed for the OI Rules wizard, but allows other applications to directly manage rules by calling the respective endpoints. A rule is always defined for several assets of one asset type and includes a list of evaluations. An evaluation is an expression which evaluates to true or false. If all evaluations evaluate to true for the properties of one asset, all active actions included in the rule are being triggered if the rule itself is active. An evaluation includes a property (which reflects an aspect variable), a condition and comparative values. They can also include additional instructions called hysteresis and debouncing in order to define handling spikes or other timeseries anomalies.

1. rules-{ruleId} - Delete a single rule DELETE {{baseUrl}}/rules/:ruleId

2. rules-{ruleId} - Get rule by ID GET {{baseUrl}}/rules/:ruleId

3. rules-{ruleId} - Update existing rule PUT {{baseUrl}}/rules/:ruleId

4. rules-{ruleId} - Patch existing rule PATCH {{baseUrl}}/rules/:ruleId

5. rules - Get a list of rules GET {{baseUrl}}/rules?filter=<string>&size=<integer>&page=<integer>

6. rules - Add a new rule POST {{baseUrl}}/rules