Dokumentation der REST-API

[leeb_phil]

Guten Abend zusammen,


da ich für meine Bachelorarbeit die Schnittstelle zum automatischen generieren und abfragen von Tickets brauche, wollte ich fragen, ob mir jemand einen Hinweis geben könnte wo die REST-API dokumentiert ist bzw. inwieweit die neuste Version KIX mit der dokumentierten REST-API von OTRS übereinstimmt.


Ich hoffe ihr könnt mir einen guten Hinweis geben.


Viele Grüße


Phil

[Richard Leis]

Hallo Phil,

eine eigene vollständige Dokumentation unserer REST-API gibt es momentan noch nicht. Wir arbeiten noch an der Erstellung aller Dokumentationen und werden diese nach und nach auf unserer Website veröffentlichen.

Die von Dir genannte Dokumentation kannst Du aber bedenkenlos verwenden. Es gibt dort keine Unterschiede zu KIX.

Viele Grüße

Richard

[leeb_phil]

Guten Abend Richard,


danke für den wertvollen Hinweis.


Was für mich noch ganz interessant ist (bin leider noch nicht fündig geworden in den Manuals), wenn ich über die "selbstkonfigurierte" REST-API eine Route '/FAQ' habe welche auf die Methode "FAQ::PublicFAQSearch" mapped, ob es theoretisch reichen würde nen einfachen String, z.B. Keywords, zu übermitteln oder ob ein JSON-Objekt nötig ist. Falls ein JSON-Objekt nötig ist, wäre es wichtig zu wissen, wie das Objekt aufgebaut ist. Gibt es da eventuell eine ausführlichere Doku als die bisherige von OTRS?


Link zur Doku PublicFAQSearch: [size=78%]https://doc.otrs.com/doc/api/otrs/stable/Perl/Kernel/GenericInterface/Operation/FAQ/PublicFAQSearch.pm.html[/size]


Viele Grüße
Phil

[Richard Leis]

Hallo Phil,

ich habe gerade in einer Testumgebung mit ""Keyword": "Problem"" nach entsprechenden FAQ-Artikeln suchen können.
Ausführlichere Dokumentationen gibt es wie gesagt momentan noch nicht.

Aber in der Doku-Seite, die Du genannt hast, werden Dir alle Parameter angezeigt, die Du abfragen kannst.
Die Suche nach einem Keyword ist dort auch enthalten.

Viele Grüße

Richard

[leeb_phil]

Guten Morgen Richard,


vielen Dank für deine Antwort und die Infos. Eine weitere kleine Frage hat sich mir eröffnet, da die native REST-Schnittstelle im Bezug auf die FAQs nur "public"-FAQs suchen lässt, wollte ich fragen ob es
1. möglich ist die Schnittstelle zu erweitern und die Methoden für die Agenten-Suche zu nutzen
2. falls (1.) möglich, ob es hierfür schon vorgefertigte Lösungen gibt


Vielen Dank schon im voraus.


VG,
Phil

[Richard Leis]

Hallo Phil,

das GenericInterace liefert leider nur Module für die Suche in Public FAQs aus.
Für die Suche nach anderen FAQs müsste also der Code entsprechend angepasst werden.

Ich kann das gern als Feature Request mitnehmen.

Viele Grüße

Richard

[Erstes_Ticket]

Hallo,
für unser Ticketsystem beschäftigen wir uns auch mit den REST-Schnittstellen für FAQ. leeb_phil, kannst du die Bachelorabrbeit zur Verfügung stellen? Das wäre cool :-)
Zweite Frage: Wir haben für KIX 17 unter /Kernenl/Genericinterface/Operation/FAQ/ eigene Perl-Scripte geschrieben, so dass wir über modifizierte REST-Schnittstellen für FAQ verfügen. Die Schnittstellen möchten wir noch erweitern und müssen die Scripte natürlich immer wieder debuggen. Welche Hilfen bieten sich dafür bei KIX unter Ubuntu an? Die Fehlermeldungen unter /var/log/apache2/error.log kennen wir schon. Gibt es ein Tool zum Debugging von Perl-Skripten, die ins Ticket-System aufgenommen werden sollen? Unser häufigstes Problem ist, dass nach der Bearbeitung die Perl-Module nicht geladen werden, wenn ein Fehler enthalten ist und wir keine genauen Informationen erhalten, wo im Skript ein Fehler aufgetreten ist.
Viele Grüße :-)

[Richard Leis]

Hallo Erstes_Ticket,

Eine mitgelieferte Möglichkeit zum debuggen des Codes von Skripten bietet KIX nicht.
Wenn unsere Kollegen für Kunden neue Operationen entwickeln, arbeiten sie immer mit Dumpern, die im Code eingebaut werden, um die Dateien zu debuggen. Wenn man hier entsprechende Ausgaben einbaut, kann man Fehler immer ganz gut bestimmen.

Syntaxfehler in den Dateien kannst Du herausfinden, indem Du ein "perl -w" mit der Datei ausführst.

Für Probleme mit den Requests bietet das Webservice-Management im Admin-Bereich auch die Möglichkeit, die Requests zu debuggen.
Dafür muss das Loglevel des Webservice auf Debug gestellt werden. Anschließend kann man für jeden abgesetzten Request die gesendeten und empfangenen Daten auswerten.
Hierfür kannst Du mal in die bestehenden Operationen reinschauen, wie dort die Debugger-Ausgaben eingearbeitet sind.

Viele Grüße
Richard