Skip to content

Commit bab1ff7

Browse files
committed
deploy: d782285
1 parent efb085d commit bab1ff7

File tree

1 file changed

+79
-1
lines changed

1 file changed

+79
-1
lines changed

index.html

Lines changed: 79 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2765,7 +2765,9 @@ <h1 id='queue'>Queue</h1><h2 id='add-item-to-queue'>Add item to queue</h2><div c
27652765
<p>Request body</p>
27662766
</blockquote>
27672767
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
2768-
</span><span class="nl">"filesystem"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1a077dd6296417fe75555bf806b68089"</span><span class="w">
2768+
</span><span class="nl">"filesystem"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1a077dd6296417fe75555bf806b68089"</span><span class="p">,</span><span class="w">
2769+
</span><span class="nl">"amount"</span><span class="p">:</span><span class="w"> </span><span class="mi">5</span><span class="p">,</span><span class="w">
2770+
</span><span class="nl">"group"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="w">
27692771
</span><span class="p">}</span><span class="w">
27702772
</span></code></pre></div>
27712773
<blockquote>
@@ -2807,6 +2809,12 @@ <h3 id='request'>Request</h3>
28072809
<td>no</td>
28082810
<td>The amount of prints to add to the queue.<br><strong>Default: 1</strong></td>
28092811
</tr>
2812+
<tr>
2813+
<td><code>group</code></td>
2814+
<td>integer</td>
2815+
<td>no</td>
2816+
<td>If you have Queue Groups - ID of the group the item should be added to.<br><strong>Default: 0 - required if you have Queue Groups</strong></td>
2817+
</tr>
28102818
</tbody></table>
28112819
<h3 id='response'>Response</h3>
28122820
<table><thead>
@@ -3081,10 +3089,13 @@ <h2 id='get-queue-items'>Get queue items</h2><div class="highlight"><pre class="
30813089
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">51293</span><span class="p">,</span><span class="w">
30823090
</span><span class="nl">"index"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w">
30833091
</span><span class="nl">"filename"</span><span class="p">:</span><span class="w"> </span><span class="s2">"benchy.gcode"</span><span class="p">,</span><span class="w">
3092+
</span><span class="nl">"note"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
30843093
</span><span class="nl">"model"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
3094+
</span><span class="nl">"printable"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
30853095
</span><span class="nl">"left"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w">
30863096
</span><span class="nl">"printed"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
30873097
</span><span class="nl">"filesystem_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"c00489ef361771ac098b5a60e6740757"</span><span class="p">,</span><span class="w">
3098+
</span><span class="nl">"group"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
30883099
</span><span class="nl">"for"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
30893100
</span><span class="nl">"printers"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
30903101
</span><span class="mi">1234</span><span class="w">
@@ -3220,11 +3231,21 @@ <h3 id='response-3'>Response</h3>
32203231
<td>The queue item filename.</td>
32213232
</tr>
32223233
<tr>
3234+
<td><code>queue.items[].note</code></td>
3235+
<td>string</td>
3236+
<td>nullable</td>
3237+
</tr>
3238+
<tr>
32233239
<td><code>queue.items[].model</code></td>
32243240
<td>boolean</td>
32253241
<td>True if the queue item is a model.</td>
32263242
</tr>
32273243
<tr>
3244+
<td><code>queue.items[].printable</code></td>
3245+
<td>boolean</td>
3246+
<td>True if the queue is printable.</td>
3247+
</tr>
3248+
<tr>
32283249
<td><code>queue.items[].left</code></td>
32293250
<td>integer</td>
32303251
<td>The amount of prints left to print.</td>
@@ -3240,6 +3261,11 @@ <h3 id='response-3'>Response</h3>
32403261
<td>File id if print is from SimplyPrint filesystem.</td>
32413262
</tr>
32423263
<tr>
3264+
<td><code>queue.items[].group</code></td>
3265+
<td>integer</td>
3266+
<td>Possible ID of Queue Group.</td>
3267+
</tr>
3268+
<tr>
32433269
<td><code>queue.items[].for</code></td>
32443270
<td>object</td>
32453271
<td>For which printers, models and groups this queue item is for.</td>
@@ -3334,6 +3360,36 @@ <h3 id='response-3'>Response</h3>
33343360
<td>object</td>
33353361
<td>nullable</td>
33363362
</tr>
3363+
<tr>
3364+
<td><code>queue.done_items</code></td>
3365+
<td>array</td>
3366+
<td>If <code>groups</code> GET is set, an array of done queue items, or ones where the last remaining item is being printed <strong>includes all the same fields as queue items, with a few extra;</strong>.</td>
3367+
</tr>
3368+
<tr>
3369+
<td><code>queue.done_items[]....</code></td>
3370+
<td></td>
3371+
<td><em>Fields inherited from regular queue items</em>.</td>
3372+
</tr>
3373+
<tr>
3374+
<td><code>queue.done_items[].size</code></td>
3375+
<td>integer</td>
3376+
<td>Byte-size used by this item - 0 if the file is from the filesystem.</td>
3377+
</tr>
3378+
<tr>
3379+
<td><code>queue.done_items[].ongoing</code></td>
3380+
<td>boolean</td>
3381+
<td>If the item is currently ongoing.</td>
3382+
</tr>
3383+
<tr>
3384+
<td><code>queue.done_items[].done</code></td>
3385+
<td>UTC date</td>
3386+
<td>nullable</td>
3387+
</tr>
3388+
<tr>
3389+
<td><code>queue.done_items[].expires</code></td>
3390+
<td>UTC date</td>
3391+
<td>nullable</td>
3392+
</tr>
33373393
</tbody></table>
33383394
<h2 id='update-queue-item'>Update queue item</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://api.simplyprint.io/<span class="o">{</span><span class="nb">id</span><span class="o">}</span>/queue/UpdateItem?job<span class="o">=</span>1234 <span class="se">\</span>
33393395
<span class="nt">-X</span> POST <span class="se">\</span>
@@ -3419,6 +3475,12 @@ <h4 id='request-body-2'>Request body</h4>
34193475
<td>no</td>
34203476
<td>The new amount to set.</td>
34213477
</tr>
3478+
<tr>
3479+
<td><code>amount</code></td>
3480+
<td>integer</td>
3481+
<td>no</td>
3482+
<td>Set amount of &quot;printed&quot;.</td>
3483+
</tr>
34223484
</tbody></table>
34233485
<h3 id='response-4'>Response</h3>
34243486
<table><thead>
@@ -3588,6 +3650,22 @@ <h2 id='empty-queue'>Empty queue</h2><div class="highlight"><pre class="highligh
35883650
<p>This endpoint empties the queue.</p>
35893651
<h3 id='request-7'>Request</h3>
35903652
<p><code>GET /{id}/queue/EmptyQueue</code></p>
3653+
3654+
<table><thead>
3655+
<tr>
3656+
<th>Parameter</th>
3657+
<th>Type</th>
3658+
<th>Required</th>
3659+
<th>Description</th>
3660+
</tr>
3661+
</thead><tbody>
3662+
<tr>
3663+
<td><code>group</code></td>
3664+
<td>integer</td>
3665+
<td>no</td>
3666+
<td>ID of Queue Group to empty.<br>**Default: 0 - required if you have Queue Groups</td>
3667+
</tr>
3668+
</tbody></table>
35913669
<h3 id='response-7'>Response</h3>
35923670
<table><thead>
35933671
<tr>

0 commit comments

Comments
 (0)