Zurück zur API-Übersicht

Vorgänge

14 Endpunkte unter /api/rest/2.0

Tasks/Tickets (Vorgänge)

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 /tasks List all tasks
POST /tasks Create a task
GET /tasks/{id} Get a task
PUT /tasks/{id} Update a task
PATCH /tasks/{id} Partially update a task
DELETE /tasks/{id} Delete a task
GET /tasks/{id}/comments List task comments
POST /tasks/{id}/comments Create task comment
GET /tasks/{id}/comments/{comment_id} Get task comment
PATCH /tasks/{id}/comments/{comment_id} Update task comment
DELETE /tasks/{id}/comments/{comment_id} Delete task comment
POST /tasks/{id}/comments/{comment_id}/recover Recover deleted comment
GET /tasks/{id}/proceedings List task proceedings
POST /tasks/{id}/proceedings/{proceeding_id}/execute Execute task proceeding

Felder

Diese Felder liefert die API zu Vorgänge. 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
identifier string Unique task identifier (e.g., T-001)
task string Task title
description string Task description (detailed text)
scheme_id integer Task scheme/workflow ID
taskproject_id integer Task project ID (grouping)
timeproject_id integer Time tracking project ID
customer_id integer Main customer ID
person_id integer Main contact person ID
state_id integer Current state/status ID
prio string Priority level
access string Access level
assignee_user_id integer Assigned user ID
assignee_division_id integer Assigned division/team ID
reporter_user_id integer Reporter user ID
watcher_ids string Watcher IDs (comma-separated, e.g., "u1,u2,d3")
stack integer Stack position for ordering
remind_at date Reminder date
due_at date Due date
state_changed_at datetime Last state change timestamp
assignee_changed_at datetime Last assignee change timestamp
last_active_at datetime Last activity timestamp
estimated_hours number Estimated hours
ticket_nr string External ticket number
notification boolean Notification flag
created_by integer User ID who created this task
created_at datetime Creation timestamp
updated_by integer User ID who last updated this task
updated_at datetime Last update timestamp

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