Vorgangs-Schemas
14 Endpunkte unter /api/rest/2.0
Task Schemes/Workflows (Vorgangs-Schemata)
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.
| Methode | Pfad | Beschreibung |
|---|---|---|
GET |
/task-schemes |
List all task_schemes |
POST |
/task-schemes |
Create a task_scheme |
POST |
/task-schemes/blueprint |
Import task scheme from blueprint |
GET |
/task-schemes/blueprint/schema |
Get blueprint JSON Schema |
GET |
/task-schemes/{id} |
Get a task_scheme |
PUT |
/task-schemes/{id} |
Update a task_scheme |
PATCH |
/task-schemes/{id} |
Partially update a task_scheme |
DELETE |
/task-schemes/{id} |
Delete a task_scheme |
GET |
/task-schemes/{id}/blueprint |
Export task scheme as blueprint |
POST |
/task-schemes/{id}/blueprint |
Update task scheme from blueprint |
GET |
/task-schemes/{id}/proceedings |
List task scheme proceedings |
GET |
/task-schemes/{id}/states |
List task scheme states |
POST |
/task-schemes/{id}/states |
Create task scheme state |
DELETE |
/task-schemes/{id}/states/{state_id} |
Delete task scheme state |
Felder
Diese Felder liefert die API zu Vorgangs-Schemas. 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.
| Feld | Typ | Beschreibung |
|---|---|---|
name |
string | Scheme name |
abbrev |
string | Abbreviation (3 chars, used in identifiers) |
color |
string | Hex color code (e.g., #FF5733) |
active |
boolean | Whether scheme is active |
sort |
integer | Sort order |
seq_number |
integer | Current sequence number for task identifiers |
ticket_activate |
boolean | Enable ticket/email-to-task feature |
ticket |
boolean | Ticket system enabled |
ticket_mailaccount_id |
integer | Mail account ID for ticket import |
ticket_signature_id |
integer | Email signature ID for ticket replies |
ticket_user_id |
integer | Default assignee user ID for new tickets |
ticket_division_id |
integer | Default assignee division ID for new tickets |
ticket_create_proceeding_id |
integer | Proceeding to execute on ticket creation |
ticket_open_proceeding_id |
integer | Proceeding to execute when ticket is reopened |
ticket_create_customer_if_missing |
boolean | Create customer if not found by email |
ticket_create_customer_proceeding_id |
integer | Proceeding when customer is auto-created |
ticket_textmodul_id |
integer | Text module for ticket replies |
front_create_proceeding_id |
integer | Proceeding for frontend task creation |
manually_create_proceeding_id |
integer | Proceeding for manual task creation |
manually_create_task_subject |
string | Default subject for manually created tasks |
manually_create_task_description |
string | Default description for manually created tasks |
prune_task_files_months |
integer | Auto-delete task files after N months (0=disabled) |
prune_comment_files_months |
integer | Auto-delete comment files after N months (0=disabled) |
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.