The technical documentation for the API can be opened via the following URL.
http://example.org/jobrouter/api/rest/v2
The structure of requests and responses as well as possible error messages are displayed in the individual resources.
The resources are described in thematic groups. By clicking on the resource name in the navigation area the description and the contained routes are displayed together with the available HTTP methods (e.g. GET /application/workitems/:processName/:version/:inboxId). When clicking on a route, the call parameters and one example for a request and a response together with possible error responses for each of them is listed. Placeholders in the routes are marked with a colon (e.g. :processName).
For the call of a route the JobRouter URL, supplemented with the REST API path, must be prefixed.
Example: Calling of the route for determination of process inbox steps
http://example.org/jobrouter/api/rest/v2/application/workitems/request_holidays/1/42
