Skip to main content
Version: Next

GlobalRuleset

createdOnstring<date-time>

Server-assigned creation time.

enabledboolean

Whether the ruleset should be deployed and evaluated.

Example: true
errorstring

Latest compilation or execution error, when present.

idinteger<int64>

Server-assigned numeric ruleset identifier.

Example: 27
langstringrequired

Rules source language. JAVASCRIPT is retained for legacy records but cannot be newly created.

Possible values: [JAVASCRIPT, GROOVY, JSON, FLOW]

lastModifiedstring<date-time>

Server-assigned last modification time.

meta object

Optional execution and presentation metadata.

property name*object

Optional execution and presentation metadata.

namestringrequired

Human-readable ruleset name.

Possible values: >= 3 characters and <= 255 characters

Example: High temperature alert
rulesstring

Rules source encoded according to lang.

statusstring

Transient deployment status.

Possible values: [READY, DEPLOYED, COMPILATION_ERROR, VALIDITY_PERIOD_ERROR, EXECUTION_ERROR, LOOP_ERROR, DISABLED, PAUSED, EXPIRED, REMOVED, EMPTY]

versioninteger<int64>

Optimistic-lock version.

Example: 2
GlobalRuleset
{
"createdOn": "2024-07-29T15:51:28.071Z",
"enabled": true,
"error": "string",
"id": 27,
"lang": "JAVASCRIPT",
"lastModified": "2024-07-29T15:51:28.071Z",
"meta": {},
"name": "High temperature alert",
"rules": "string",
"status": "READY",
"version": 2
}