diff --git a/docs/src/main/resources/templates/api.html b/docs/src/main/resources/templates/api.html index 10c0568601..f86a808b5e 100644 --- a/docs/src/main/resources/templates/api.html +++ b/docs/src/main/resources/templates/api.html @@ -7,6 +7,7 @@
:appId
should be the identifier of one of the available print configurations.
Request URI: GET /simple/capabilities.json
{
@@ -71,8 +73,7 @@ Response Sample
"enabled": false
}
}
-
+
The smtp section shows "enabled": true
if the reports can be sent by email. To enable this
@@ -118,8 +119,7 @@
Request URI: GET /status/15179fee-618d-4356-8114-cfd8f146e273.json
You should not call this API if you requested the report to be sent by email.
+ +
{
@@ -246,8 +246,7 @@ Response Sample
"waitingTime": 0,
"downloadURL": "/print/report/15179fee-618d-4356-8114-cfd8f146e273"
}
-
+
Request URI: DELETE /cancel/15179fee-618d-4356-8114-cfd8f146e273
+ 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). +
+
+ 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
).
+
Status: 200 OK
Request URI: POST /simple/buildreport.pdf
See Create a print job request sample for the request body.
+