Helpdesk

Version 6.1 von Steffi F am 2025/06/13 10:07

Save Ticket

Um ein Ticket anzulegen muss man zusätzlich zur ID auch einen Titel angeben. Im Schema ist der Titel nicht als mandatory markiert, weil man ihn sonst beim Editieren eines Tickets immer mit angeben müsste.

SaveTicket Request

Falls man einen mehrzeiligen Text in die Ticketbeschreibung angeben möchte, kann man dies folgendermaßen machen:

<HtmlDescription>

   Hello

   &lt;br /&gt;

   World23

</HtmlDescription>

 

 
SaveTicket Response
SaveTicket Request V2
SaveTicket Response V2

Beim Speichern eines Tickets werden vom Assignee nur die Felder "ID" und "AssigneeIsGroup" berücksichtigt. Name, Description, Email, UserType und Rollen eines Users oder einer Gruppe können nicht über dieses Command geändert werden.

SaveTicket Response V3
SaveTicket Request V4

Beim Speichern eines Tickets werden vom Assignee nur die Felder "ID" und "AssigneeIsGroup" berücksichtigt. Name, Description, Email, UserType und Rollen eines Users oder einer Gruppe können nicht über dieses Command geändert werden.

Wenn das verwendete Template als Status "Geschlossen" gesetzt hat, wird dies nicht von der API berücksichtigt. In diesem Fall muss die aufrufende Stelle im Anschluss an das SaveTicket_V4 Command noch ein CloseTicket_V1 Command schicken.

SaveTicket Response V4

CloseTicket

Pflichtfelder:

TicketId, Assignee

Für dieses Command gibt es ein paar Felder, die unter bestimmten Voraussetzungen gesetzt sein müssen, da sonst der Request nicht valide ist. 

ResolutionId: Wenn in den ACMP Einstellungen Resolutionen aktiviert sind, dann muss dieses Feld die Id einer Resolution beinhalten.

Comment: Wenn in den ACMP Einstellungen ein Kommentar zum Schließen eines Tickets erzwungen wird, dann muss dieses Feld ein Kommentarobjekt beinhalten bei dem die Felder Id und Text befüllt sein müssen. Die TicketId des Kommentarobjekts wird an dieser Stelle ignoriert.

WorkingTime: Wenn in den ACMP Einstellungen Arbeitszeiten für Tickets aktiviert sind und eine Arbeitszeit zum Schließen eines Tickets erzwungen wird, dann muss dieses Feld ein Arbeitszeitobjekt beinhalten bei dem die Felder Id, TicketId, Executor, StartDate und EndDate befüllt sind. StartDate muss kleiner sein als EndDate.

CloseTicket Request
CloseTicket Response

ReopenTicket

ReopenTicket Request
ReopenTicket Response

MergeTickets

MergeTickets Request
MergeTickets Response

GetTicket

GetTicket Request
GetTicket Response
GetTicket Request V2
GetTicket Response V2
GetTicket Request V3
GetTicket Response V3
GetTicket Request V4
GetTicket Response V4

Bei einem leeren Assignee wird das Feld UserType immernoch befüllt sein und den Wert "AcmpUser" haben. Das liegt daran, dass das der Standardwert für diesen Datentypen ist. Die anderen Felder haben Datentypen, die leer sein können z.B. Set oder String. Das Verhalten des UserType ist ähnlich wie bei dem Feld AssigneeIsGroup, das in so einem Fall den Standardwert eines Booleans "false" beinhaltet.

GetTicket Request V5
GetTicket Response V5

GetTicketFromTemplate

Manche Felder im Response werden niemals gesetzt sein, weil man sie über das Template nicht setzen kann.

Arbeitszeiten und Kosten werden beim Anlegen des Tickets aus der Vorlage geholt, so dass im Response nur die Summen stehen.

GetTicketFromTemplate Request
GetTicketFromTemplate Response

GetTicketAttachments

GetTicketAttachments Request
GetTicketAttachments Response

GetTicketAttachment

GetTicketAttachment Request
GetTicketAttachment Response

SaveTicketAttachments

Bei neuen Attachments sind die Felder Id, DocumentId, Name und FileName Pflichtfelder.

Beim Editieren von Attachments können nur die Felder Description und IsVisibleForWeb editiert werden. Hierbei muss trotzdem die Id und DocumentId angegeben werden, um das zu editierende Attachment zu finden.

SaveTicketAttachments Request
GetTicketAttachments Response

GetTicketComments

GetTicketComments Request
GetTicketComments Response

GetTicketComment

GetTicketComment_V1 Request
GetTicketComment_V1 Response
GetTicketComment_V2 Request
GetTicketComment_V2 Response

SaveTicketComment

Folgende Eigenschaften werden vom ACMP Server ignoriert:

  • Creator
  • CreationDate
  • IsExternal
  • ExternalMail
  • ExternalRecipient
  • ExternalCC
  • Signature
SaveTicketComment_V1 Request
SaveTicketComment_V1 Response
SaveTicketComment_V2 Request
SaveTicketComment_V2 Response

GetCommentListOfTicket

GetCommentListOfTicket Request
GetCommentListOfTicket Response

GetTicketCategoryList

 

© Aagon GmbH 2025
Besuchen Sie unsere Aagon-Community