Campaign Rules Endpoints

Die Campaign Rules API bietet Endpoints zum Erstellen, Verwalten und Evaluieren automatisierter Entscheidungsregeln für Zugriffsprüfungs-Campaigns.

Basis-URL

Alle Endpoints sind relativ zu /api/v1/campaign-rules.

---

Regeln auflisten

Ruft alle Campaign-Regeln ab.

GET /api/v1/campaign-rules

Antwort

{
  "rules": [
    {
      "id": "rule-123",
      "name": "Auto-approve standard users",
      "type": "account",
      "decision": "auto_approve",
      "condition": "account.risk_score < 30",
      "status": "active",
      "created_at": "2024-01-15T10:30:00Z"
    }
  ]
}

---

Regel abrufen

Ruft eine bestimmte Campaign-Regel ab.

GET /api/v1/campaign-rules/{id}

Path-Parameter

Parameter	Typ	Beschreibung
id	string	Regel-ID

Antwort

Gibt das vollständige Regelobjekt zurück.

---

Regel erstellen

Erstellt eine neue Campaign-Regel.

POST /api/v1/campaign-rules

::: note Nur Administrator Dieser Endpoint erfordert die Administrator-Rolle. :::

Request Body

{
  "name": "High-risk accounts require review",
  "description": "Flag accounts with elevated risk scores",
  "type": "account",
  "decision": "flag_for_review",
  "condition": "account.risk_score > 70"
}

Regeltypen

Typ	Beschreibung
account	Regeln, die Kontoattribute evaluieren
owner	Regeln, die Eigentümerattribute evaluieren
role	Regeln, die Rollenzuweisungen evaluieren

Entscheidungstypen

Entscheidung	Beschreibung
auto_approve	Übereinstimmende Konten automatisch genehmigen
auto_reject	Übereinstimmende Konten automatisch ablehnen
flag_for_review	Zur manuellen Prüfung markieren
assign_reviewer	Bestimmtem Prüfer zuweisen

Antwort

Gibt das erstellte Regelobjekt zurück.

---

Regel aktualisieren

Aktualisiert eine bestehende Campaign-Regel.

PUT /api/v1/campaign-rules/{id}

::: note Nur Administrator Dieser Endpoint erfordert die Administrator-Rolle. :::

Path-Parameter

Parameter	Typ	Beschreibung
id	string	Regel-ID

Request Body

Nur die zu aktualisierenden Felder einschließen.

Antwort

Gibt das aktualisierte Regelobjekt zurück.

---

Regel löschen

Löscht eine Campaign-Regel.

DELETE /api/v1/campaign-rules/{id}

::: note Nur Administrator Dieser Endpoint erfordert die Administrator-Rolle. :::

Path-Parameter

Parameter	Typ	Beschreibung
id	string	Regel-ID

Antwort

Gibt 204 No Content bei Erfolg zurück.

---

DSL aus natürlicher Sprache generieren

Verwendet AI, um Regel-DSL aus einer Beschreibung in natürlicher Sprache zu generieren.

POST /api/v1/campaign-rules/generate-dsl

Request Body

{
  "description": "Auto-approve accounts in the IT department with low risk scores"
}

Antwort

{
  "dsl": "account.department == 'IT' AND account.risk_score < 30",
  "confidence": 0.95,
  "suggested_name": "IT Department Low Risk Auto-Approve"
}

---

Regel testen

Testet eine Regelbedingung, ohne sie zu erstellen.

POST /api/v1/campaign-rules/test

Request Body

{
  "condition": "account.risk_score > 50 AND account.status == 'active'",
  "rule_type": "account"
}

Antwort

{
  "valid": true,
  "matching_count": 150,
  "sample_matches": [...]
}

---

Regelstatus aktualisieren

Aktualisiert den Aktiv-/Inaktiv-Status einer Regel.

PUT /api/v1/campaign-rules/{id}/status

Path-Parameter

Parameter	Typ	Beschreibung
id	string	Regel-ID

Request Body

{
  "status": "active"
}

Antwort

Gibt den aktualisierten Status zurück.

---

Regeln evaluieren

Evaluiert Regeln gegen bereitgestellte Daten.

POST /api/v1/campaign-rules/evaluate

Request Body

{
  "data": {...}
}

Antwort

Gibt Evaluierungsergebnisse zurück.

---

Regelevaluierungs-Jobs

Evaluierungs-Job abrufen

GET /api/v1/rule-evaluation-jobs/{jobId}

Path-Parameter

Parameter	Typ	Beschreibung
jobId	string	Job-ID

Antwort

{
  "id": "job-123",
  "status": "completed",
  "progress": 100,
  "results": {
    "processed": 500,
    "matched": 150,
    "errors": 0
  }
}

Evaluierungs-Jobs auflisten

GET /api/v1/rule-evaluation-jobs

Query-Parameter

Parameter	Typ	Beschreibung
campaign_id	string	Nach Campaign filtern
limit	number	Anzahl der Ergebnisse

---

Fehlerantworten

Statuscode	Beschreibung
400	Bad Request - Ungültige Regelsyntax
401	Unauthorized - Authentifizierung erforderlich
403	Forbidden - Unzureichende Berechtigungen
404	Not Found - Regel existiert nicht
500	Internal Server Error

---

Verwandte Themen

• Campaigns API - Campaign-Verwaltungs-Endpoints
• Campaign Rules - Benutzerhandbuch
• API Reference - Vollständiger API-Index