Autor Thema: Dokumentation der REST-API  (Gelesen 134 mal)

leeb_phil

  • Newbie
  • Beiträge: 2
Dokumentation der REST-API
« am: 07.01.2020 19:42:50 »
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

  • Global Moderator
  • Beiträge: 350
Re: Dokumentation der REST-API
« Antwort #1 am: 17.01.2020 16:19:32 »
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

  • Newbie
  • Beiträge: 2
Re: Dokumentation der REST-API
« Antwort #2 am: 29.01.2020 22:22:11 »
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

  • Global Moderator
  • Beiträge: 350
Re: Dokumentation der REST-API
« Antwort #3 am: Heute um 11:37:28 »
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

Tags: