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/projects: Projekte verwalten


Objekttyp „project“

Parameter Typ Beschreibung
id integer Die ID des Projekts
customers_id integer Die ID des zugehörigen Kunden
name string Der Name des Projekts
active boolean Ist das Projekt aktiviert?
billable_default boolean Abrechenbarkeit (1 oder 0)
note string Notiz zu dem Projekt
budget_money float Projektbudget
budget_is_hours boolean Ist das Budget ein Stundenbudget?
budget_is_not_strict boolean Ist das Budget ein Soll-Budget?

Projekte auflisten

Bitte nutzen Sie hierzu /api/customers. Dort werden Kunden und Projekte verschachtelt ausgegeben.


Projekt abrufen

Anfrage
GET /api/projects/[ID]
Antwort
{
  "project": [object of type project]
}

Projekt anlegen

Anfrage
POST /api/projects
Notwendige Parameter name, customers_id
Optionale Parameter active, billable_default, budget_money, budget_is_hours, budget_is_not_strict, note
Antwort
{
  "project": [object of type project]
}

Projekt bearbeiten

Anfrage
PUT /api/projects/[ID]
Notwendige Parameter keine
Optionale Parameter name, active, billable_default, budget_money, budget_is_hours, budget_ist_not_strict, note, hourly_rate, customers_id
Antwort
{
  "project": [object of type project]
}

Projekt deaktivieren

Anfrage
DELETE /api/projects/[ID]
Antwort
{
  "project": [object of type project]
}