Jobs Endpoints

Die Jobs API bietet Endpoints zur Überwachung von Hintergrundaufgaben wie Datensynchronisierung, Rollengenerierung und Richtlinienanalyse.

Basis-URL

Alle Endpoints sind relativ zu /api/v1/jobs.

---

Jobs auflisten

Ruft eine Liste von Hintergrund-Jobs mit optionaler Filterung ab.

GET /api/v1/jobs

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

Query-Parameter

Parameter	Typ	Beschreibung
job_type	string	Nach Job-Typ filtern
status	string	Nach Status filtern (pending, running, completed, failed, cancelled)
start_date	string	Jobs filtern, die nach diesem Datum gestartet wurden (ISO 8601)
end_date	string	Jobs filtern, die vor diesem Datum gestartet wurden (ISO 8601)
first	number	Anzahl der zurückzugebenden Elemente
after	string	Cursor für Paginierung

Antwort

{
  "jobs": [
    {
      "id": "job-123",
      "job_type": "full_sync",
      "status": "completed",
      "progress": 100,
      "start_time": "2024-02-01T10:00:00Z",
      "end_time": "2024-02-01T10:15:00Z",
      "duration_ms": 900000,
      "records_created": 150,
      "records_updated": 45,
      "records_deleted": 10
    }
  ],
  "pageInfo": {
    "hasNextPage": true,
    "endCursor": "cursor-token"
  }
}

---

Job abrufen

Ruft Details für einen bestimmten Job ab.

GET /api/v1/jobs/{id}

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

Path-Parameter

Parameter	Typ	Beschreibung
id	string	Job-ID

Antwort

Gibt das vollständige Job-Objekt mit allen Details zurück.

---

Job-Fortschritt abrufen

Ruft Echtzeit-Fortschritt für einen laufenden Job ab.

GET /api/v1/jobs/{id}/progress

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

Path-Parameter

Parameter	Typ	Beschreibung
id	string	Job-ID

Antwort

{
  "id": "job-123",
  "status": "running",
  "progress": 65,
  "current_step": "Processing accounts",
  "records_processed": 650,
  "total_records": 1000,
  "elapsed_ms": 45000
}

---

Job abbrechen

Bricht einen laufenden Job ab.

DELETE /api/v1/jobs/{id}

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

Path-Parameter

Parameter	Typ	Beschreibung
id	string	Job-ID

Antwort

Gibt 204 No Content bei Erfolg zurück.

Teilweise Ergebnisse

Das Abbrechen eines Jobs während der Verarbeitung kann zu unvollständigen Daten führen. Bereits verarbeitete Datensätze bleiben im System.

---

Laufende Jobs abrufen

Ruft alle aktuell laufenden Jobs ab.

GET /api/v1/jobs/running

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

Antwort

{
  "jobs": [
    {
      "id": "job-123",
      "job_type": "account_sync",
      "status": "running",
      "progress": 45,
      "start_time": "2024-02-01T10:00:00Z"
    }
  ]
}

---

Job-Typen

Job-Typ	Beschreibung
full_sync	Vollständige Synchronisierung aller Entitätstypen
incremental_sync	Nur Änderungen seit letzter Synchronisierung
account_sync	Nur Konten synchronisieren
owner_sync	Nur Eigentümer synchronisieren
group_sync	Nur Gruppen synchronisieren
application_sync	Nur Anwendungen synchronisieren
role_generation	Rollen aus Eigentümerattributen generieren
policy_analysis	Rollen gegen Richtlinien analysieren
manager_resolution	Manager-Hierarchien auflösen
enrichment	Datenanreicherungsoperationen

---

Job-Status

Status	Beschreibung
pending	Job in Warteschlange, wartet auf Start
running	Job wird aktuell ausgeführt
completed	Job erfolgreich abgeschlossen
failed	Job ist auf einen Fehler gestoßen
cancelled	Job wurde vom Benutzer gestoppt

---

Fehlerantworten

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

---

Verwandte Themen

• Sync API - Datensynchronisierungs-Endpoints
• Job History - Benutzerhandbuch
• API Reference - Vollständiger API-Index