Vorschau: Diese Dokumentation beschreibt die WorkLogx Public API V1. Die Bereitstellung von V1 in der Produktionsumgebung ist noch nicht abgeschlossen.

Fehler

Fehler auf /v1/-Endpunkten werden als application/problem+json geliefert.

HTTP/1.1 401 Unauthorized
Content-Type: application/problem+json
X-Request-Id: 88bce6bf-cb2d-4a51-ad72-ba7d155043eb

{
  "type": "https://api.worklogx.com/problems/invalid-api-key",
  "title": "Authentication failed",
  "status": 401,
  "code": "invalid_api_key",
  "requestId": "88bce6bf-cb2d-4a51-ad72-ba7d155043eb"
}

#Felder

Feld	Beschreibung
`type`	URI des Problemtyps
`title`	Kurze englische Beschreibung. Nicht maschinell auswerten.
`status`	HTTP-Statuscode
`code`	Stabiler, maschinenlesbarer Fehlercode. Diesen im Code verwenden.
`requestId`	ID der Anfrage, auch als Header `X-Request-Id`. Bei Support-Anfragen angeben.
`requiredScope`	Nur bei `insufficient_scope`: der fehlende Scope
`errors`	Nur bei `validation_failed`: Liste von `{ "field", "code" }`

Felder ohne Wert werden weggelassen.

#Fehlercodes

Status	`code`	Bedeutung
400	`validation_failed`	Request-Body ungültig, siehe `errors`
400	`idempotency_key_required`	`POST` ohne `Idempotency-Key`
400	`invalid_limit`	`limit` liegt nicht zwischen 1 und 100
400	`invalid_cursor`	`cursor` ist kein gültiger Cursor
400	`invalid_date_range`	`dateFrom` liegt nach `dateTo`
400	`invalid_status`	Unbekannter `status`-Filter bei Abwesenheiten
400	`invalid_request`	Die Anfrage konnte nicht verarbeitet werden
400	`conflict`	Die Änderung steht im Konflikt mit dem aktuellen Stand des Datensatzes
400	`invalid_api_client`	Der API Client kann diese Anlege-Anfrage nicht ausführen
401	`invalid_api_key`	Key fehlt, ungültig, widerrufen, abgelaufen oder aus der falschen Umgebung
403	`insufficient_scope`	Dem API Client fehlt der benötigte Scope
403	`api_client_disabled`	Der API Client ist deaktiviert
403	`public_api_unavailable`	Die Public API ist für die Organisation nicht freigeschaltet
404	`employee_not_found`, `customer_not_found`, `project_not_found`, `task_not_found`, `form_not_found`, `submission_not_found`, `absence_not_found`, `worklog_not_found`	Der Datensatz existiert in Ihrer Organisation nicht
409	`idempotency_key_reused`	`Idempotency-Key` mit anderem Request-Body wiederverwendet
409	`absence_not_mutable`	Die Abwesenheit kann in ihrem aktuellen Status nicht geändert werden
429	`rate_limit_exceeded`	Zu viele Anfragen, siehe Rate Limits
500	`internal_error`	Unerwarteter Fehler. Später erneut versuchen und bei Wiederholung die `requestId` melden.

IDs anderer Organisationen verhalten sich wie unbekannte IDs und ergeben 404.

#Validierungsfehler

{
  "type": "https://api.worklogx.com/problems/validation",
  "title": "Validation failed",
  "status": 400,
  "code": "validation_failed",
  "requestId": "3d6f0b8a-1c2e-4f5a-9b7d-6e8c0a1f2b34",
  "errors": [
    { "field": "name", "code": "required" }
  ]
}

Feldfehlercodes sind unter anderem required, invalid, too_long, duplicate, invalid_range, overlap, mismatch und immutable.

Bekannte Abweichungen zwischen Backend, Spezifikation und Vertrag stehen unter Offene Backend-Findings. Sie sind nicht Teil des API-Vertrags.

#Wiederholen

429: die im Header Retry-After genannten Sekunden warten, dann erneut senden.
500: mit Backoff wiederholen. Bei POST denselben Idempotency-Key verwenden.
Andere 4xx: Anfrage korrigieren. Eine unveränderte Wiederholung liefert denselben Fehler.