Documentation for the synchronous print request.

mapfish · Sep 2, 2024 · 0a297d5 · 0a297d5
1 parent 4ed4a58
commit 0a297d5
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/docs/src/main/resources/templates/api.html b/docs/src/main/resources/templates/api.html
@@ -7,6 +7,7 @@
     <li><a href="#status">Get the status for a print job</a></li>
     <li><a href="#download">Download the report for a print job</a></li>
     <li><a href="#cancel">Cancel a print job</a></li>
+    <li><a href="#buildreport">Create a print job and download its report</a></li>
     <li>
       <a href="#listFonts">List available fonts</a>
       <!-- <li>Create and get report -->
@@ -289,6 +290,26 @@ <h4>Response</h4>
   <h4>Request Sample</h4>
   <p>Request URI: <code>DELETE /cancel/15179fee-618d-4356-8114-cfd8f146e273</code></p>
 
+  <h3 id="buildreport">
+    Create a print job and download its report<a class="headerlink" href="#buildreport" title="Permalink to this headline">¶</a>
+  </h3>
+  <p>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).</p>
+  <h4>URI</h4>
+  <p>
+    <code>POST /:appId/buildreport.:format</code>
+  </p>
+  <p><code>:appId</code> should be the identifier of one of the available print configurations.</p>
+  <p>
+    <code>:format</code> should be one of the formats supported by the specified print configuration (e.g.
+    <code>pdf</code> or <code>png</code>).
+  </p>
+
+  <h4>Response</h4>
+  <p>Status: <code>200 OK</code></p>
+
+  <h4>Request Sample</h4>
+  <p>Request URI: <code>DELETE /cancel/15179fee-618d-4356-8114-cfd8f146e273</code></p>
+
   <h3 id="listFonts">
     List Available Fonts <a class="headerlink" href="#listFonts" title="Permalink to this headline">¶</a>
   </h3>