Skip to content

Commit d7d4247

Browse files
committed
Formatting
1 parent 6e513cc commit d7d4247

File tree

1 file changed

+114
-0
lines changed

1 file changed

+114
-0
lines changed

source/includes/_queue.md

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,120 @@ priority. The result will have skipped all items that do not meet the specified
204204
| `queue.matches[].printed` | integer | The amount of completed prints of this item (from print queue). Only present if `match` is true. |
205205
| `queue.matches[].left` | integer | The amount of prints left (from print queue). Only present if `match` is true. |
206206

207+
## Get queue item
208+
209+
```shell
210+
curl https://api.simplyprint.io/{id}/queue/GetItem?id=1234 \
211+
-H 'accept: application/json' \
212+
-H 'X-API-KEY: {API_KEY}'
213+
```
214+
215+
> Success response
216+
217+
```json
218+
{
219+
"status": true,
220+
"message": null,
221+
"queue": {
222+
"id": 51293,
223+
"index": 1,
224+
"filename": "benchy.gcode",
225+
"note": null,
226+
"model": false,
227+
"printable": true,
228+
"type": "printable",
229+
"zipPrintable": false,
230+
"zipNoModel": false,
231+
"left": 1,
232+
"printed": 0,
233+
"filesystem_id": "c00489ef361771ac098b5a60e6740757",
234+
"group": 123,
235+
"for": {
236+
"printers": [
237+
1234
238+
],
239+
"models": [
240+
1234
241+
],
242+
"groups": [
243+
1234
244+
]
245+
},
246+
"analysis": {
247+
"slicer": "Simplify3D",
248+
"filament": [
249+
60
250+
],
251+
"estimate": 240,
252+
"movement": {
253+
"mRelative": 0,
254+
"eRelative": 0
255+
},
256+
"temps": {
257+
"tool": {
258+
"T0": 210
259+
},
260+
"bed": 50,
261+
"pset": 1
262+
},
263+
"modelSize": {
264+
"x": 151,
265+
"y": 16,
266+
"z": 5
267+
},
268+
"printArea": {
269+
"maxX": 156.05,
270+
"minX": 5,
271+
"maxY": 157.86,
272+
"minY": 142.14,
273+
"maxZ": 5,
274+
"minZ": 0.2
275+
},
276+
"minDeltaRadius": 313.91,
277+
"v": 5
278+
},
279+
"tags": {
280+
"nozzle": 0.6,
281+
"material": [
282+
{
283+
"ext": 0,
284+
"type": 123,
285+
"color": "Green",
286+
"hex": "#4CAF50"
287+
}
288+
],
289+
"custom": [
290+
1,
291+
2,
292+
3
293+
]
294+
}
295+
}
296+
}
297+
```
298+
299+
<aside class="notice">
300+
This endpoint requires the <b>Pro</b> plan.
301+
</aside>
302+
303+
This endpoint returns the queue item with the specified id.
304+
305+
### Request
306+
307+
`GET /{id}/queue/GetItem
308+
309+
| Parameter | Type | Required | Description |
310+
|-----------|---------|----------|---------------------------------------|
311+
| `id` | integer | yes | The queue item id to get details for. |
312+
313+
### Response
314+
315+
| Parameter | Type | Description |
316+
|-----------|---------|--------------------------------------------------------|
317+
| `status` | boolean | True if the request was successful. |
318+
| `message` | string | Success message or error message if `status` is false. |
319+
| `item` | object | The queue item object. |
320+
207321
## Get queue items
208322

209323
```shell

0 commit comments

Comments
 (0)