Helpdesk

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

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

Mandatory fields:

TicketId, Assignee

There are a few fields for this command that must be set under certain conditions, otherwise the request is not valid.

ResolutionId: If resolutions are enabled in the ACMP settings, this field must contain the ID of a resolution.

Comment: If a comment is required when closing a ticket in the ACMP settings, this field must contain a comment object with the ID and Text fields filled in. The Ticket ID of the comment object is ignored here.

WorkingTime: If working times for tickets are enabled in the ACMP settings and a working time is enforced for closing a ticket, then this field must contain a working time object in which the fields ID, TicketID, Executor, StartDate, and EndDate are filled. The StartDate must be earlier than 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

If the Assignee is clear, the UserType field will still be filled and have the value “AcmpUser”.

This is because this is the default value for this data type. The other fields have data types that can be empty, e.g. Set or String.

The behavior of UserType is similar to that of the AssigneeIsGroup field, which in such a case contains the default value of a Boolean “false”.

GetTicket Request V5
GetTicket Response V5

GetTicketFromTemplate

Some fields in the response will never be set because they cannot be set via the template.

Working times and costs are taken from the template when the ticket is created, so that only the totals are shown in the response.

GetTicketFromTemplate Request
GetTicketFromTemplate Response

GetTicketAttachments

GetTicketAttachments Request
GetTicketAttachments Response

GetTicketAttachment

GetTicketAttachment Request
GetTicketAttachment Response

SaveTicketAttachments

For new attachments, the fields ID, DocumentId, Name, and FileName are mandatory.

When editing attachments, only the fields Description and IsVisibleForWeb can be edited. However, the ID and DocumentId must still be specified in order to find the attachment to be edited.

SaveTicketAttachments Request
GetTicketAttachments Response

GetTicketComments

GetTicketComments Request
GetTicketComments Response

GetTicketComment

GetTicketComment_V1 Request
GetTicketComment_V1 Response
GetTicketComment_V2 Request
GetTicketComment_V2 Response

SaveTicketComment

The following properties are ignored by the ACMP Server:

  • 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

  • When adding a cost entry, the following fields are mandatory: Id, TicketId, UnitPrice, and Amount
  • When changing a cost entry, only “Id” is a mandatory field
  • UnitPrice must be greater than 0.00 and less than or equal to 999999.99.
  • Amount must be greater than 0 and less than or equal to 999999.
  • Category must not be longer than 100 characters.
  • Description must not be longer than 400 characters.
  • The CreatorID is always the ID of the calling user, so it is not listed here.
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 neue Aagon-Community