REST-API

Die clockodo-API ermöglicht die Anbindung von clockodo an andere Systeme. Rechnungs- und Projektmanagement-Anwendungen oder eigene Shell-Skripte sind Beispiele für nützliche Mash-Ups mit clockodo.

api/users: Mitarbeiter verwalten


Objekttyp „user“

Parameter Typ Beschreibung
id integer Die ID des Mitarbeiters
name string Der Name des Mitarbeiter
number string Personalnummer
email string Die E-Mail-Adresse des Mitarbeiters
role string Die Rolle des Mitarbeiters
active boolean Ist der Mitarbeiter aktiviert?
edit_lock date (YYYY-MM-DD) Festgelegte Bearbeitungssperre für den Mitarbeiter null (Keine Bearbeitungssperre)
YYYY-MM-DD (Nicht bearbeitbar bis)
edit_lock_dyn integer Dynamische Bearbeitungssperre für den Mitarbeiter null (Keine Bearbeitungssperre)
1 (Heute bearbeitbar)
2 (Heute und Gestern bearbeitbar)
3 (Heute und 2 Tage rückwirkend bearbeitbar)
5 (Heute und 4 Tage rückwirkend bearbeitbar)
8 (Heute und eine Woche rückwirkend bearbeitbar)
15 (Heute und 2 Wochen rückwirkend bearbeitbar)
31 (Heute und 30 Tage rückwirkend bearbeitbar)
91 (Heute und 90 Tage rückwirkend bearbeitbar)

Mitarbeiter auflisten

Anfrage
GET /api/users
Antwort
{
  "users": 
  {
    [object of type user],
    [object of type user], ...
  }
}

Einen Mitarbeiter abrufen

Anfrage
GET /api/users/[ID]
Antwort
{
  "user": [object of type user]
}

Mitarbeiter anlegen

Anfrage
POST /api/users
Notwendige Parameter name, number, email, role
Optionale Parameter keine
Antwort
{
  "user": [object of type user]
}

Mitarbeiter bearbeiten

Anfrage
PUT /api/users/[ID]
Notwendige Parameter keine
Optionale Parameter name, number, active, role, edit_lock, edit_lock_dyn
Antwort
{
  "user": [object of type user]
}

Mitarbeiter deaktivieren

Anfrage
DELETE /api/users/[ID]
Antwort
{
  "user": [object of type user]
}