Helpdesk

Last modified by Steffi F on 2025/06/27 11:11

Save Ticket

In order to create a ticket, you must enter both a title and an ID.

Hinweis  Note:  

In the schema, the title is not marked as mandatory, as otherwise it would always have to be specified when editing a ticket.

SaveTicket Request

If you want to include multiple lines of text in the ticket description, you can do so as follows:

<HtmlDescription>

   Hello

   &lt;br /&gt;

   World23

</HtmlDescription>
 
SaveTicket Response
SaveTicket Request V2
SaveTicket Response V2

When saving a ticket, only the fields “ID” and “AssigneeIsGroup” are taken into account by the assignee.
The name, description, email, user type, and roles of a user or group cannot be changed using this command.

SaveTicket Response V3
SaveTicket Request V4

When saving a ticket, only the “ID” and “AssigneeIsGroup” fields are taken into account by the assignee.

The name, description, email, user type, and roles of a user or group cannot be changed using this command.

If the template used has the status “Closed”, this is not taken into account by the API. In this case, the calling entity must send a CloseTicket_V1 command after the SaveTicket_V4 command.

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. Das 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 immer noch 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 der Standardwert eines Booleans "false" beinhaltet.

GetTicket Request V5
GetTicket Response V5

GetTicketFromTemplate

Manche Felder im Response werden niemals gesetzt sein, weil sie über das Template nicht gesetzt werden können.

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

GetTicketCategory Request
GetTicketCategory Response

GetTicketResolutionList

GetTicketResolutionList Request
GetTicketResolutionList Response

GetTicketListByQuery

GetTicketListByQuery Request
GetTicketListByQuery Response
GetTicketListByQuery Request V2
GetTicketListByQuery Response V2

GetTicketList

GetTicketList Request
GetTicketList Response

GetTicketListOfAsset

GetTicketListOfAsset Request
GetTicketListOfAsset Response

GetLinkedTicketsOfTicket

GetLinkedTicketsOfTicket Request
GetLinkedTicketsOfTicket Response

GetHelpdeskSettings

GetHelpdeskSettings Request
GetHelpdeskSettings Response
GetHelpdeskSettings Request
GetHelpdeskSettings Response

GetAssigneeList

GetAssigneeList Request
GetAssigneeList Response

SaveReminderOfTicket

SaveReminderOfTicket Request
SaveReminderOfTicket Response

DeleteReminderOfTicket

DeleteReminderOfTicket Request
DeleteReminderOfTicket Response

SaveTicketWorkingTime

SaveTicketWorkingTime Request
SaveTicketWorkingTime Response

GetTicketWorkingTimeList

GetTicketWorkingTimeList Request
GetTicketWorkingTimeList Response

DeleteTicketWorkingTimeList

DeleteTicketWorkingTimeList Request
DeleteTicketWorkingTimeList Response

SaveTicketCosts

  • Beim Hinzufügen eines Kosten-Eintrages sind folgende Felder Pflichtfelder: Id, TicketId, UnitPrice und Amount
  • Beim Ändern eines Kosten-Eintrages ist nur "Id" Pflichtfeld
  • UnitPrice muss größer als 0.00 und kleiner gleich 999999.99 sein.
  • Amount muss größer als 0 und kleiner gleich 999999 sein.
  • Category darf nicht länger als 100 Zeichen sein.
  • Description darf nicht länger als 400 Zeichen sein.
  • Die CreatorID ist immer die ID des aufrufenden Benutzers, demnach hier nicht aufgelistet.
SaveTicketCosts Request
SaveTicketCosts Response

GetTicketCost

GetTicketCost Request
GetTicketCost Response

GetTicketCostList

GetTicketCostList Request
GetTicketCostList Response

DeleteTicketCosts

DeleteTicketCosts Request
DeleteTicketCosts Response

DeleteTicketComment

DeleteTicketComment Request
DeleteTicketComment Response

LinkAssetsToTicket

LinkAssetsToTicket Request
LinkAssetsToTicket Response

LinkClientsToTicket

LinkClientsToTicket Request
LinkClientsToTicket Response

LinkTicketsToTicket

LinkTicketsToTicket Request
LinkTicketsToTicket Response

GetEmailMonitorList

GetEmailMonitorList Request
GetEmailMonitorList Response

DeleteEmailMonitorList

DeleteEmailMonitorList Request
DeleteEmailMonitorList Response

GetTicketTemplateList

GetTicketTemplateList Request
GetTicketTemplateList Response

DeleteTicketAttachments

DeleteTicketAttachments Request
DeleteTicketAttachments Response

 

© Aagon GmbH 2025
Besuchen Sie unsere Aagon-Community