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/clock: Kontrolle der Stoppuhr


Aktuell laufenden Eintrag abrufen

Anfrage
GET /api/clock
Antwort
{
  "running": [object of type entry]
}

Vgl. Sie hier die Beschreibung zum Objekttyp "entry" [object of type entry]


Uhrstatus abrufen

Anfrage
GET /api/clock/update
Antwort
{
  "running": [object of type entry],
  "services": {
    [object of type service],
    ...
  },
  "projects": 
  {
    "id": [integer],
    "name": [string],
    "access": 
    {
      "add": [boolean],
      "edit": [boolean]
    },
    "projects": 
    {
      {
        "id": [integer],
        "name": [string],
        "access": 
        {
          "add": [boolean],
          "edit": [boolean]
        }
      }, 
      ...
    }
  }, ...
  "billable": 
  {
    [customer_id-projects_id]:
    {
      "billable_default": [boolean]
    }, 
    ...
  }
}

Vgl. Sie hier die Beschreibung zum Objekttyp "entry" [object of type entry]

Vgl. Sie hier die Beschreibung zum Objekttyp "service" [object of type service]


Suche nach Beschreibungstexten

Liefert Zeiteintrag-Beschreibungstexte, die zu der Anfrage passen.

Anfrage
GET /api/clock/searchtexts
Notwendige Parameter keine
Optionale Parameter term, customers_id, projects_id, services_id, billable, time_since, time_until
Antwort
{
  "texts": {
    [string], 
    ... 
  }
}

Uhr starten

Anfrage
POST /api/clock
Notwendige Parameter customers_id, services_id, billable
Optionale Parameter projects_id, text, users_id
Antwort
{
  "running": [object of type entry]
}

Vgl. Sie hier die Beschreibung zum Objekttyp "entry" [object of type entry].


Uhr stoppen

Anfrage
DELETE /api/clock/[ID des zu stoppenden Zeiteintrags]
Notwendige Parameter keine
Optionale Parameter duration, away
Antwort
{
  "stopped": [object of type entry],
  "running": [object of type entry]
}

Vgl. Sie hier die Beschreibung zum Objekttyp "entry" [object of type entry].


Dauer ändern

Anfrage
PUT /api/clock/[ID des Zeiteintrags für den die Dauer geändert werden soll]
Notwendige Parameter duration_before, duration
Optionale Parameter offset_before
Antwort
{
  "updated": [object of type entry],
  "running": [object of type entry]
}

Vgl. Sie hier die Beschreibung zum Objekttyp "entry" [object of type entry].