Die technische Dokumentation der API können Sie in Ihrem JobRouter über die URL
http://example.org/jobrouter/api/rest/v2
aufrufen. Bei den einzelnen Ressourcen wird die Struktur der Anfragen und Antworten, sowie möglicher Fehlermeldungen aufgeführt.
Die Ressourcen sind thematisch gruppiert beschrieben. Beim Klick auf einen Ressourcennamen im Navigationsbereich wird die Beschreibung und enthaltene Routen mit den verfügbaren HTTP-Methoden angezeigt (z. B. GET /application/workitems/:processName/:version/:inboxId). Beim Klick auf eine Route werden Aufrufparameter und jeweils ein Beispiel für Anfrage und Antwort sowie mögliche Fehlerantworten aufgelistet. Platzhalter in den Routen werden mit einem Doppelpunkt markiert (z. B. :processName).
Für den Aufruf einer Route muss die JobRouter-URL, ergänzt um den REST-API-Pfad, vorangestellt werden.
Beispiel: Aufruf der Route zum Ermitteln von Prozesseingangsbox-Schritten
http://example.org/jobrouter/api/rest/v2/application/workitems/urlaub_beantragen/1/42
