Zurück zur API-Übersicht

Zeiterfassung Projekte

8 Endpunkte unter /api/rest/2.0

Time project management - projects for time tracking

Endpunkte

Alle Pfade sind relativ zur Basis /api/rest/2.0 Ihrer ameax-Installation. Die Antworten folgen dem JSON:API-Format mit data, links und meta.

MethodePfadBeschreibung
GET /time-projects List all time-projects
POST /time-projects Create a time-project
GET /time-projects/{id} Get a time-project
PUT /time-projects/{id} Update a time-project
DELETE /time-projects/{id} Delete a time-project
GET /time-projects/{id}/entries/export Export time entries
POST /time-projects/{id}/entries/import Import time entries
GET /time-projects/{id}/entries/schema Get the time entry JSON Schema

Felder

Diese Felder liefert die API zu Zeiterfassung Projekte. Dazu kommen die Zusatzfelder Ihrer eigenen Installation — sie werden nach denselben Regeln geprüft wie in der Oberfläche und erscheinen in der Spezifikation Ihres Mandanten.

FeldTypBeschreibung
customer_id integer Associated customer ID
parent_id integer Parent time project ID (for hierarchical projects)
business_id integer Business unit ID
type_id integer Project type ID
name string Project name
description string Project description
state string Project state/status
report_emails string Email addresses for reports (comma-separated)
active boolean Whether project is active
default_project boolean Whether this is the default project for the customer
priority integer Priority (1-10)
target_hours integer Target hours (in minutes)
actual_hours integer Actual hours (in minutes)
included_hours integer Included hours (in minutes)
included_hours_valid_until date Included hours validity date
end_date date Project end date
report boolean Enable reporting
sort integer Sort order
layer integer Hierarchy layer
created_at date-time Creation timestamp
created_by integer User ID who created the project
updated_at date-time Last update timestamp
updated_by integer User ID who last updated the project

Zugriff

Jede Anfrage braucht ein API-Token im Kopf Authorization: Bearer <token>, wahlweise als Basic-Auth mit dem Benutzernamen api und dem Token als Passwort.

Das Token hängt an einem Benutzer und erbt dessen Rechte: Was dieser Benutzer in der Oberfläche nicht sehen darf, liefert die API auch nicht. Zusätzlich lassen sich je Token ein Ablaufdatum und eine IP-Beschränkung hinterlegen. Mehr dazu auf der API-Übersicht.

Anbindung besprechen.

Sie wollen ein System anbinden und wissen nicht, ob die Schnittstelle abdeckt, was Sie brauchen? Wir schauen es uns gemeinsam an — kostenlos und ohne Verpflichtung.

Kostenfreie Beratung: +49 9454 94905420