API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen
Entity · escalation_rules

Escalation Rule Schema

Schema-ID
escalation_rule
Collection
escalation_rules
Permissions
  • Lesenescalation_rule_view
  • Anlegenescalation_rule_manage
  • Ändernescalation_rule_manage
  • Löschenescalation_rule_manage

Felder

Escalation Rule Schema

escalation_rules4 Permissions

Schema-agnostic escalation rule. Targets any entity (callback, opportunity, complaint, …) with a deadline field, evaluates guards on a cron, and queues alerts/actions when guards match.

namestringerforderlich

Display name (e.g. "Rückruf-Eskalation Stufe 1")

1–200 Zeichen
descriptionstringoptional
nullable
appliesTostringerforderlich

Entity schema ID this rule applies to (e.g. "callback", "opportunity")

min 1 Zeichen
deadlineFieldstringoptional

Optional name of a date/date-time field on the target entity used by deadline_overdue / deadline_in guards

nullable
sortOrderintegeroptional
≥ 0Default: 0
guardsobject[]erforderlich

AND-combined guard predicates. All must match for actions to fire.

Default: []
typestringerforderlich

Guard condition type

Werte
deadline_overduedeadline_inno_progress_afterstatus_isstatus_inpriority_ispriority_infield_equalsfield_missing
paramsobjectoptional

Guard-specific parameters, e.g. { beforeMinutes: 30 }, { status: "OPEN" }, { closedStatuses: ["COMPLETED","CANCELLED"] }

actionsobject[]erforderlich

Actions to execute when all guards match

Default: []
typestringerforderlich
Werte
notifyreassignescalate_priorityset_fieldadd_comment
channelsstring[]optional
recipientsobject[]optional
refstringerforderlich

UUID of a user/team or a placeholder like {{entity.assignedToId}}, {{entity.createdBy}}

Pattern
labelstringoptional
nullable
kindstringoptional
Werte
userteamplaceholder
paramsobjectoptional
escalationPolicyIduuidoptional

Optional escalation policy that drives the multi-level alert flow. If null, only direct rule-level actions fire.

nullable
prioritystringoptional

Priority used when creating alerts. If null, the entity's own priority field is used (or NORMAL).

Werte
LOWNORMALHIGHCRITICAL
nullable
isDefaultbooleanerforderlich

Whether this is a default rule for the appliesTo schema

isActivebooleanerforderlich

Standard-Endpoints

Diese Resource folgt dem generischen CRUD-Vertrag der Plattform. Lesen Sie die Konventionen für Pagination, Idempotenz, Optimistic Locking und Audit. Die wichtigsten Endpoints:

  • GET /api/v1/escalation_rules — Liste, paginiert + filterbar
  • GET /api/v1/escalation_rules/<id> — Einzelne Entity
  • POST /api/v1/escalation_rules — Anlegen
  • PATCH /api/v1/escalation_rules/<id> — Teil-Update
  • DELETE /api/v1/escalation_rules/<id> — Soft-Delete
  • GET /api/v1/escalation_rules/<id>/timeline — Audit + Aktivitäten

Suche