Ticket aktualisieren

Aktualisiert ein Ticket über den Ticket-API-Dienst und liefert es zurück. In der Anfrage ausgelassene Felder behalten den aktuellen Wert des Tickets.

Verfügbarkeit: Nur Vollversion — eine Clock-Instanz antwortet auf diesen Endpunkt mit 404.

PUT wird für diese Operation als Alias von PATCH akzeptiert.

Request

PATCH /api/v1/tickets/{id}

curl --request PATCH \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/tickets/{id}' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {token}' \
     --header 'Content-Type: application/json' \
     --data '{
       "status": 1,
       "project_id": 16,
       "project_task_id": 1,
       "priority": 3,
       "subject": "Fehler in der Benutzeroberfläche beheben",
       "planned_hours": 1.5,
       "creator_username": "max.mustermann",
       "receipt_date": "2024-11-15",
       "processor_username": "frank",
       "start_date": "2024-01-15T00:00:00.000000Z",
       "deadline": "2024-11-20",
       "from_mail": "string",
       "external_ticket_number": "string",
       "notify_of_completion": true,
       "prevent_overbooking": 0,
       "customer_contact_person": "max.mustermann@example.com",
       "customer_reference": "string",
       "keywords": "modi",
       "categories": [
         "string"
       ]
     }'

Pfad-Parameter

Name
id
Type
integer
Description
Die ID des Tickets

Request-Body

Name
status
Type
integer, erforderlich
Description
Der Zielstatus des Tickets.
Einer der Werte: 1, 2, 3, 4, 5, 8
Name
project_id
Type
integer, erforderlich
Description
Die ID des Projekts, auf das dieses Ticket gebucht wird.
Name
project_task_id
Type
integer, erforderlich
Description
Die ID des Vorgangs (PSP-Element), auf den dieses Ticket gebucht wird.
Name
priority
Type
integer, erforderlich
Description
Die Priorität des Tickets, von 1 (höchste) bis 5 (niedrigste).
Name
subject
Type
string, erforderlich
Description
Die Betreffzeile des Tickets.
Name
planned_hours
Type
number, nullable
Description
Die Anzahl der für dieses Ticket geplanten Stunden.
Name
creator_username
Type
string, nullable
Description
Der Benutzername des Mitarbeiters, der das Ticket angelegt hat. Erforderlich, sofern nicht stattdessen ein Ansprechpartner angegeben wird.
Name
receipt_date
Type
string (date-time), nullable
Description
Das Datum, an dem die zugrunde liegende Anfrage eingegangen ist.
Name
processor_username
Type
string, nullable
Description
Der Benutzername des Mitarbeiters, der das Ticket aktuell bearbeitet.
Name
start_date
Type
string (date-time), nullable
Description
Das Datum, an dem die Arbeit am Ticket planmäßig beginnen soll.
Name
deadline
Type
string (date-time), nullable
Description
Das Datum, bis zu dem das Ticket abgeschlossen sein soll.
Name
from_mail
Type
string, nullable
Description
Die Absender-E-Mail-Adresse, falls das Ticket aus einer eingehenden E-Mail erstellt wird — in der Regel automatisch ermittelt, siehe \CreateMailTicketsTask::createTicket.
Name
external_ticket_number
Type
string, nullable
Description
Eine Ticketnummer aus einem externen System, der dieses Ticket entspricht.
Name
notify_of_completion
Type
boolean, nullable
Description
Ob der Ersteller des Tickets per E-Mail benachrichtigt wird, wenn das Ticket als erledigt markiert wird.
Name
prevent_overbooking
Type
integer, nullable
Description
Ob die erfasste Zeit für dieses Ticket die geplanten Stunden überschreiten darf, und für welche Zeitarten.
Einer der Werte: 0, 1, 2, 3, 4
Name
customer_contact_person
Type
string (email), nullable
Description
Die E-Mail-Adresse des Ansprechpartners, der dieses Ticket erstellt. Erforderlich, sofern nicht stattdessen ein Ersteller-Benutzername angegeben wird.
Name
customer_reference
Type
string, nullable
Description
Eine vom Kunden angegebene Freitext-Referenznummer für dieses Ticket.
Name
keywords
Type
string, nullable
Description
Freitext-Schlagwörter, kommagetrennt, zum Suchen und Filtern von Tickets.
Name
categories
Type
Liste von string, nullable
Description
Die IDs der Kategorien, die dem Ticket zugeordnet werden sollen.

Response

{
  "data": {
    "id": 1,
    "subject": "Fehler in der Benutzeroberfläche beheben",
    "priority": 3,
    "status": {
      "id": 1,
      "name": "neu"
    },
    "creator_username": "max.mustermann",
    "processor_username": "frank",
    "date": "2024-07-20T00:00:00.000000Z",
    "receipt_date": "2024-11-15",
    "start_date": "2024-01-15T00:00:00.000000Z",
    "deadline": "2024-11-20",
    "processing_date": "2024-02-28 14:09:38",
    "done_date": "2024-02-28 14:11:38",
    "approved_date": "2024-03-12 08:23:54",
    "rejected_date": "2026-01-31T09:00:00.000000Z",
    "billed_date": "2024-05-31T00:00:00.000000Z",
    "planned_hours": 1.5,
    "prevent_overbooking": 0,
    "history_modified": "2024-03-12 08:23:54",
    "project_id": 16,
    "project_task_id": 1,
    "notify_of_completion": true,
    "customer_contact_person_id": 1,
    "history_creator_username": "max.mustermann",
    "customer_reference": "string",
    "external_ticket_number": "string",
    "from_mail": "string",
    "created": "2024-07-20T11:30:00.000000Z",
    "modified": "2024-07-20T12:30:00.000000Z",
    "keywords": {},
    "categories": [
      {
        "name": "EU",
        "description": {
          "de": "string",
          "en": "string",
          "fr": "string",
          "es": "string",
          "pl": "string"
        },
        "type": {
          "id": "string",
          "name": "Mitarbeiter/in"
        }
      }
    ]
  }
}

Response-Felder

Name
id
Type
integer
Description
Die eindeutige Kennung des Tickets.
Name
subject
Type
string
Description
Die Betreffzeile des Tickets.
Name
priority
Type
integer
Description
Die Priorität des Tickets, eine Ganzzahl von 1 bis 5. ZEP-Instanzen können eigene Bezeichnungen für diese Werte festlegen, daher ist keine feste Bedeutung pro Zahl garantiert.
Name
status
Type
object
Description
Der Bearbeitungsstatus des Tickets (z. B. neu, in Bearbeitung, erledigt).
Name
status.id
Type
integer
Description
Der gespeicherte Wert. Vergleichen Sie gegen diesen, nicht gegen name.
Name
status.name
Type
string
Description
Die lesbare Bezeichnung in der Sprache des Mandanten. Nicht parsen.
Einer der Werte: "neu", "in Bearbeitung", "fertig", "abgelehnt", "bewilligt", "billed"
Name
creator_username
Type
string, nullable
Description
Der Benutzername des Mitarbeiters, der das Ticket angelegt hat.
Name
processor_username
Type
string, nullable
Description
Der Benutzername des Mitarbeiters, der das Ticket aktuell bearbeitet.
Name
date
Type
string (date-time), nullable
Description
Das Datum, an dem das Ticket erstellt wurde.
Name
receipt_date
Type
string (date-time), nullable
Description
Das Datum, an dem die zugrunde liegende Anfrage eingegangen ist (z. B. per E-Mail).
Name
start_date
Type
string (date-time), nullable
Description
Das Datum, an dem die Arbeit am Ticket planmäßig beginnen soll.
Name
deadline
Type
string (date-time), nullable
Description
Das Datum, bis zu dem das Ticket abgeschlossen sein soll.
Name
processing_date
Type
string (date-time), nullable
Description
Das Datum, an dem das Ticket in Bearbeitung genommen wurde.
Name
done_date
Type
string (date-time), nullable
Description
Das Datum, an dem das Ticket als erledigt markiert wurde.
Name
approved_date
Type
string (date-time), nullable
Description
Das Datum, an dem das Ticket genehmigt wurde.
Name
rejected_date
Type
string (date-time), nullable
Description
Das Datum, an dem das Ticket abgelehnt wurde.
Name
billed_date
Type
string (date-time), nullable
Description
Das Datum, an dem das Ticket abgerechnet wurde.
Name
planned_hours
Type
number, nullable
Description
Die Anzahl der für dieses Ticket geplanten Stunden.
Name
prevent_overbooking
Type
integer
Description
Ob die erfasste Zeit für dieses Ticket die geplanten Stunden überschreiten darf, und für welche Zeitarten.
Einer der Werte: 0, 1, 2, 3, 4
Name
history_modified
Type
string (date-time), nullable
Description
Wann der jüngste Verlaufseintrag des Tickets (Kommentar oder Statusänderung) erfasst wurde.
Name
project_id
Type
integer
Description
Die ID des Projekts, zu dem dieses Ticket gehört.
Name
project_task_id
Type
integer
Description
Die ID des Vorgangs (PSP-Element), auf den dieses Ticket gebucht wird.
Name
notify_of_completion
Type
boolean, nullable
Description
Ob der Ersteller des Tickets per E-Mail benachrichtigt wird, wenn das Ticket als erledigt markiert wird.
Name
customer_contact_person_id
Type
integer, nullable
Description
Die ID des Ansprechpartners, von dem oder für den dieses Ticket erstellt wurde.
Name
history_creator_username
Type
string, nullable
Description
Der Benutzername des Mitarbeiters, der den ersten Verlaufseintrag des Tickets angelegt hat.
Name
customer_reference
Type
string, nullable
Description
Eine vom Kunden angegebene Freitext-Referenznummer für dieses Ticket.
Name
external_ticket_number
Type
string, nullable
Description
Eine Ticketnummer aus einem externen System, der dieses Ticket entspricht.
Name
from_mail
Type
string, nullable
Description
Die Absender-E-Mail-Adresse, falls das Ticket aus einer eingehenden E-Mail erstellt wurde.
Name
created
Type
string (date-time), nullable
Description
Wann der Datensatz des Tickets erstellt wurde.
Name
modified
Type
string (date-time), nullable
Description
Wann der Datensatz des Tickets zuletzt geändert wurde.
Name
keywords
Type
object, nullable
Description
Freitext-Schlagwörter, kommagetrennt, zum Suchen und Filtern von Tickets.
Name
categories
Type
Liste von Category
Description
Die diesem Ticket zugeordneten Kategorien. Nur bei GET /tickets/{ticket} enthalten; nicht im Listen-Endpunkt GET /tickets.
Name
categories.name
Type
string
Description
Name der Kategorie, wird überall angezeigt, wo eine Entität damit gekennzeichnet ist.
Name
categories.description
Type
object
Description
Ausführlichere Erläuterung, wofür diese Kategorie verwendet werden soll.
Name
categories.type
Type
object
Description
Art der Entität, der diese Kategorie zugeordnet werden kann, z. B. Mitarbeiter, Projekt oder Kunde.

Aus der OpenAPI-Spezifikation erzeugt — Änderungen gehören in den Quellcode, nicht auf diese Seite.

POST Ticket anlegen DELETE Ticket löschen