diff --git a/docs/src/main/resources/templates/api.html b/docs/src/main/resources/templates/api.html index 10c0568601..fbf1381b17 100644 --- a/docs/src/main/resources/templates/api.html +++ b/docs/src/main/resources/templates/api.html @@ -7,6 +7,7 @@
  • Get the status for a print job
  • Download the report for a print job
  • Cancel a print job
  • +
  • Create a print job and download its report
  • List available fonts @@ -289,6 +290,26 @@

    Response

    Request Sample

    Request URI: DELETE /cancel/15179fee-618d-4356-8114-cfd8f146e273

    +

    + Create a print job and download its report +

    +

    Triggers the creation of a print job, then download the report. Although it seems synchronous from the client perspective, the print job might be run by a different server in cluster mode. Despite this, it is not the recommended manner to use the print server (as too many requests in parallel will grab all the server resources).

    +

    URI

    +

    + POST /:appId/buildreport.:format +

    +

    :appId should be the identifier of one of the available print configurations.

    +

    + :format should be one of the formats supported by the specified print configuration (e.g. + pdf or png). +

    + +

    Response

    +

    Status: 200 OK

    + +

    Request Sample

    +

    Request URI: DELETE /cancel/15179fee-618d-4356-8114-cfd8f146e273

    +

    List Available Fonts