Rule
Inspect rule engines and query or manage global, realm, and asset rulesets
Retrieve global rulesets
Returns global rulesets filtered by repeated language parameters. fullyPopulate controls whether rule source and other large fields are loaded; super-user access is required.
Create a global ruleset
Creates and deploys a global ruleset and returns its numeric ID. Super-user access is required; legacy JavaScript rulesets cannot be created.
Create an asset ruleset
Creates and deploys a ruleset for an accessible asset and returns its numeric ID. The assetId is taken from the request body.
Retrieve rulesets for an asset
Returns asset rulesets filtered by language. Callers without full access receive public rulesets only; a nonexistent asset produces an empty array.
Delete an asset ruleset
Permanently removes and undeploys one ruleset from an accessible asset.
Retrieve an asset ruleset
Returns one fully populated asset ruleset when the caller can access its realm and owning asset.
Update an asset ruleset
Replaces and redeploys one asset ruleset. The ID must match and an existing ruleset cannot be reassigned to another asset.
Retrieve geofences for an asset
Extracts geofence definitions relevant to the asset. Anonymous access requires a public-readable asset; authenticated restricted users require an asset link.
Retrieve information about an asset rules engine
Returns runtime status and error counts for an accessible asset engine. Returns null when the asset or its engine does not exist.
Retrieve information about the global rules engine
Returns runtime status and compilation/execution error counts for the global engine, or null when that engine is not running. Super-user access is required.
Retrieve information about a realm rules engine
Returns runtime status and error counts for an accessible realm engine, or null when that engine is not running. Restricted users cannot inspect realm engines.
Create a realm ruleset
Creates and deploys a ruleset in its body realm and returns its numeric ID. Restricted users cannot create realm rulesets; legacy JavaScript is not accepted.
Retrieve rulesets for a realm
Returns realm rulesets filtered by language. Anonymous, restricted, or callers without read-rules permission receive public rulesets only; fullyPopulate controls loading of rule source.
Delete a realm ruleset
Permanently removes and undeploys one ruleset from an accessible realm.
Retrieve a realm ruleset
Returns one fully populated realm ruleset when its realm is accessible to the caller.
Update a realm ruleset
Replaces and redeploys one realm ruleset. Path and body IDs and the existing realm must match; legacy JavaScript cannot be updated.
Delete a global ruleset
Permanently removes and undeploys one global ruleset. Super-user access is required.
Retrieve a global ruleset
Returns one fully populated global ruleset including transient deployment status and errors. Super-user access is required.
Update a global ruleset
Replaces and redeploys the identified global ruleset. Path and body IDs must match; legacy JavaScript rulesets cannot be updated.