Skip to content

Commit 84b48cf

Browse files
cjavadcjavad
committed
Fix SetOrder docs
1 parent 013fcdd commit 84b48cf

File tree

1 file changed

+44
-45
lines changed

1 file changed

+44
-45
lines changed

‎source/includes/_queue.md‎

Lines changed: 44 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ can [edit the print job](#update-queue-item) after it has been added to the queu
4343
`POST /{id}/queue/AddItem`
4444

4545
| Parameter | Type | Required | Description |
46-
|-----------------|---------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
46+
| --------------- | ------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
4747
| `filesystem` | string | no | The [filesystem](#files) id of the file to add to the queue. |
4848
| `amount` | integer | no | The amount of prints to add to the queue.<br>**Default: 1** |
4949
| `group` | integer | no | If you have Queue Groups - ID of the group the item should be added to.<br>**Default: 0 - required if you have Queue Groups** |
@@ -57,7 +57,7 @@ can [edit the print job](#update-queue-item) after it has been added to the queu
5757
### Response
5858

5959
| Parameter | Type | Description |
60-
|--------------|---------|--------------------------------------------------------|
60+
| ------------ | ------- | ------------------------------------------------------ |
6161
| `status` | boolean | True if the request was successful. |
6262
| `message` | string | Success message or error message if `status` is false. |
6363
| `created_id` | integer | The id of the created queue item |
@@ -159,13 +159,13 @@ priority. The result will have skipped all items that do not meet the specified
159159
#### Request parameters
160160

161161
| Parameter | Type | Required | Description |
162-
|-----------|-----------|----------|----------------------------------------------------------------|
162+
| --------- | --------- | -------- | -------------------------------------------------------------- |
163163
| p | integer[] | yes | Comma separated list of printer ids to get the next items for. |
164164

165165
#### Request body
166166

167167
| Parameter | Type | Required | Description |
168-
|--------------------------|---------|----------|--------------------------------------------------------------------------------------------------------------|
168+
| ------------------------ | ------- | -------- | ------------------------------------------------------------------------------------------------------------ |
169169
| `settings` | object | no | Conditions that must be met for the next item. |
170170
| `settings.filament` | boolean | no | Must have enough filament.<br>**Default: true** |
171171
| `settings.filamentTemps` | boolean | no | Printer's filament temperature must match filament temperature of file.<br>**Default: true** |
@@ -177,7 +177,7 @@ priority. The result will have skipped all items that do not meet the specified
177177
### Response
178178

179179
| Parameter | Type | Description |
180-
|---------------------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------|
180+
| ------------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------- |
181181
| `status` | boolean | True if the request was successful. |
182182
| `message` | string | Success message or error message if `status` is false. |
183183
| `queue` | object | The queue object. |
@@ -291,7 +291,7 @@ curl https://api.simplyprint.io/{id}/queue/GetItem?id=1234 \
291291
</aside>
292292

293293
| Required permissions |
294-
|----------------------|
294+
| -------------------- |
295295
| `print_queue` |
296296

297297
This endpoint returns the queue item with the specified id.
@@ -301,13 +301,13 @@ This endpoint returns the queue item with the specified id.
301301
`GET /{id}/queue/GetItem
302302

303303
| Parameter | Type | Required | Description |
304-
|-----------|---------|----------|---------------------------------------|
304+
| --------- | ------- | -------- | ------------------------------------- |
305305
| `id` | integer | yes | The queue item id to get details for. |
306306

307307
### Response
308308

309309
| Parameter | Type | Description |
310-
|-----------|---------|--------------------------------------------------------|
310+
| --------- | ------- | ------------------------------------------------------ |
311311
| `status` | boolean | True if the request was successful. |
312312
| `message` | string | Success message or error message if `status` is false. |
313313
| `item` | object | The queue item object. |
@@ -435,7 +435,7 @@ curl https://api.simplyprint.io/{id}/queue/GetItems?pid=1234 \
435435
</aside>
436436

437437
| Required permissions |
438-
|----------------------|
438+
| -------------------- |
439439
| `print_queue` |
440440

441441
This endpoint returns the queue for the specified or all printers.
@@ -445,14 +445,14 @@ This endpoint returns the queue for the specified or all printers.
445445
`GET /{id}/queue/GetItems`
446446

447447
| Parameter | Type | Required | Description |
448-
|-----------|---------|----------|-----------------------------------------------------------------------------------------------------|
448+
| --------- | ------- | -------- | --------------------------------------------------------------------------------------------------- |
449449
| `p` | integer | no | The printer id to get the queue for. If not specified, the queue for all printers will be returned. |
450450
| `groups` | boolean | no | Attaches a list of print queue groups to the response. Note: this argument does not take a value. |
451451

452452
### Response
453453

454454
| Parameter | Type | Description |
455-
|-----------------------------------------|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
455+
| --------------------------------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
456456
| `status` | boolean | True if the request was successful. |
457457
| `message` | string | Success message or error message if `status` is false. |
458458
| `queue` | object | The queue object. |
@@ -534,7 +534,7 @@ curl https://api.simplyprint.io/{id}/queue/UpdateItem?job=1234 \
534534
</aside>
535535

536536
| Required permissions |
537-
|----------------------|
537+
| -------------------- |
538538
| `print_queue` |
539539

540540
This endpoint updates the queue item with the specified id.
@@ -546,13 +546,13 @@ This endpoint updates the queue item with the specified id.
546546
#### Query parameters
547547

548548
| Parameter | Type | Required | Description |
549-
|-----------|---------|----------|------------------------------|
549+
| --------- | ------- | -------- | ---------------------------- |
550550
| `job` | integer | yes | The queue item id to update. |
551551

552552
#### Request body
553553

554554
| Parameter | Type | Required | Description |
555-
|----------------|---------|----------|------------------------------------------------------------|
555+
| -------------- | ------- | -------- | ---------------------------------------------------------- |
556556
| `for_groups` | array | no | An array of group ids to assign the queue item to. |
557557
| `for_models` | array | no | An array of printer model ids to assign the queue item to. |
558558
| `for_printers` | array | no | An array of printer ids to assign the queue item to. |
@@ -562,7 +562,7 @@ This endpoint updates the queue item with the specified id.
562562
### Response
563563

564564
| Parameter | Type | Description |
565-
|-----------|---------|--------------------------------------------------------|
565+
| --------- | ------- | ------------------------------------------------------ |
566566
| `status` | boolean | True if the request was successful. |
567567
| `message` | string | Success message or error message if `status` is false. |
568568

@@ -589,7 +589,7 @@ curl https://api.simplyprint.io/{id}/queue/DeleteItem?job=1234 \
589589
</aside>
590590

591591
| Required permissions |
592-
|----------------------|
592+
| -------------------- |
593593
| `print_queue` |
594594

595595
This endpoint deletes the queue item with the specified id.
@@ -599,20 +599,20 @@ This endpoint deletes the queue item with the specified id.
599599
`POST /{id}/queue/DeleteItem`
600600

601601
| Parameter | Type | Required | Description |
602-
|-----------|---------|----------|------------------------------|
602+
| --------- | ------- | -------- | ---------------------------- |
603603
| `job` | integer | yes | The queue item id to delete. |
604604

605605
### Response
606606

607607
| Parameter | Type | Description |
608-
|-----------|---------|--------------------------------------------------------|
608+
| --------- | ------- | ------------------------------------------------------ |
609609
| `status` | boolean | True if the request was successful. |
610610
| `message` | string | Success message or error message if `status` is false. |
611611

612612
## Change queue order
613613

614614
```shell
615-
curl https://api.simplyprint.io/{id}/queue/SetOrder?job=1234&from=0&to=1 \
615+
curl https://api.simplyprint.io/{id}/queue/SetOrder?queue_item=1234&to=1 \
616616
-H 'accept: application/json' \
617617
-H 'X-API-KEY: {API_KEY}'
618618
```
@@ -631,7 +631,7 @@ curl https://api.simplyprint.io/{id}/queue/SetOrder?job=1234&from=0&to=1 \
631631
</aside>
632632

633633
| Required permissions |
634-
|----------------------|
634+
| -------------------- |
635635
| `print_queue` |
636636
| `reorder_queue` |
637637
| `queue_see_others` |
@@ -642,16 +642,15 @@ This endpoint changes the order of the queue items by moving the queue item with
642642

643643
`GET /{id}/queue/SetOrder`
644644

645-
| Parameter | Type | Required | Description |
646-
|-----------|---------|----------|-----------------------------------------|
647-
| `job` | integer | yes | The queue item id to move. |
648-
| `from` | integer | yes | The current position of the queue item. |
649-
| `to` | integer | yes | The new position of the queue item. |
645+
| Parameter | Type | Required | Description |
646+
| ------------ | ------- | -------- | ----------------------------------- |
647+
| `queue_item` | integer | yes | The queue item id to move. |
648+
| `to` | integer | yes | The new position of the queue item. |
650649

651650
### Response
652651

653652
| Parameter | Type | Description |
654-
|-----------|---------|---------------------------------------------------------|
653+
| --------- | ------- | ------------------------------------------------------- |
655654
| `success` | boolean | True if the request was successful. |
656655
| `message` | string | Success message or error message if `success` is false. |
657656

@@ -677,7 +676,7 @@ curl https://api.simplyprint.io/{id}/queue/EmptyQueue \
677676
</aside>
678677

679678
| Required Permissions |
680-
|--------------------------|
679+
| ------------------------ |
681680
| `print_queue` |
682681
| `print_queue_remove_all` |
683682

@@ -688,13 +687,13 @@ This endpoint empties the queue.
688687
`GET /{id}/queue/EmptyQueue`
689688

690689
| Parameter | Type | Required | Description |
691-
|-----------|---------|----------|---------------------------------------------------------------------------------|
690+
| --------- | ------- | -------- | ------------------------------------------------------------------------------- |
692691
| `group` | integer | no | ID of Queue Group to empty.<br>**Default: 0 - required if you have Queue Groups |
693692

694693
### Response
695694

696695
| Parameter | Type | Description |
697-
|-----------|---------|--------------------------------------------------------|
696+
| --------- | ------- | ------------------------------------------------------ |
698697
| `status` | boolean | True if the request was successful. |
699698
| `message` | string | Success message or error message if `status` is false. |
700699

@@ -705,7 +704,7 @@ This endpoint empties the queue.
705704
</aside>
706705

707706
| Required permissions |
708-
|---------------------------|
707+
| ------------------------- |
709708
| `print_queue` |
710709
| `queue_revive_done_items` |
711710

@@ -729,13 +728,13 @@ curl https://api.simplyprint.io/{id}/queue/ReviveItem?job=1234 \
729728
### Request Parameters
730729

731730
| Parameter | Type | Description |
732-
|-----------|---------|------------------------------|
731+
| --------- | ------- | ---------------------------- |
733732
| `job` | integer | The ID of the job to revive. |
734733

735734
### Response
736735

737736
| Parameter | Type | Description |
738-
|-----------|---------|---------------------------------------|
737+
| --------- | ------- | ------------------------------------- |
739738
| `status` | boolean | `true` if the request was successful. |
740739
| `message` | string | Error message if `status` is `false`. |
741740

@@ -746,7 +745,7 @@ curl https://api.simplyprint.io/{id}/queue/ReviveItem?job=1234 \
746745
</aside>
747746

748747
| Required permissions |
749-
|----------------------|
748+
| -------------------- |
750749
| `print_queue` |
751750

752751
```shell
@@ -781,7 +780,7 @@ curl https://api.simplyprint.io/{id}/queue/groups/Get \
781780
### Response
782781

783782
| Parameter | Type | Description |
784-
|---------------------|---------|----------------------------------------------------------------------------------|
783+
| ------------------- | ------- | -------------------------------------------------------------------------------- |
785784
| `status` | boolean | `true` if the request was successful. |
786785
| `message` | string | Error message if `status` is `false`. |
787786
| `list` | array | Array of print queue groups. |
@@ -799,7 +798,7 @@ curl https://api.simplyprint.io/{id}/queue/groups/Get \
799798
</aside>
800799

801800
| Required permissions |
802-
|----------------------|
801+
| -------------------- |
803802
| `print_queue` |
804803
| `queue_groups` |
805804

@@ -833,7 +832,7 @@ curl https://api.simplyprint.io/{id}/queue/groups/Save \
833832
### Request Body
834833

835834
| Parameter | Type | Description |
836-
|-----------------------|---------|--------------------------------------------------------------------|
835+
| --------------------- | ------- | ------------------------------------------------------------------ |
837836
| `id` | integer | The ID of the group to update (optional for creating a new group). |
838837
| `name` | string | The name of the queue group. |
839838
| `accepted_extensions` | array | List of accepted file extensions. |
@@ -845,7 +844,7 @@ curl https://api.simplyprint.io/{id}/queue/groups/Save \
845844
### Response
846845

847846
| Parameter | Type | Description |
848-
|-----------|---------|---------------------------------------|
847+
| --------- | ------- | ------------------------------------- |
849848
| `status` | boolean | `true` if the request was successful. |
850849
| `message` | string | Error message if `status` is `false`. |
851850

@@ -856,7 +855,7 @@ curl https://api.simplyprint.io/{id}/queue/groups/Save \
856855
</aside>
857856

858857
| Required permissions |
859-
|----------------------|
858+
| -------------------- |
860859
| `print_queue` |
861860
| `queue_groups` |
862861

@@ -881,19 +880,19 @@ curl https://api.simplyprint.io/{id}/queue/groups/Delete?id=123 \
881880
### Request Parameters
882881

883882
| Parameter | Type | Description |
884-
|-----------|---------|--------------------------------|
883+
| --------- | ------- | ------------------------------ |
885884
| `id` | integer | The ID of the group to delete. |
886885

887886
### Request Body
888887

889888
| Parameter | Type | Description |
890-
|-----------|---------|--------------------------------------------------------------------|
889+
| --------- | ------- | ------------------------------------------------------------------ |
891890
| `move_to` | integer | The ID of the group to move items to. Defaults to any other group. |
892891

893892
### Response
894893

895894
| Parameter | Type | Description |
896-
|-----------|---------|---------------------------------------|
895+
| --------- | ------- | ------------------------------------- |
897896
| `status` | boolean | `true` if the request was successful. |
898897
| `message` | string | Error message if `status` is `false`. |
899898

@@ -904,7 +903,7 @@ curl https://api.simplyprint.io/{id}/queue/groups/Delete?id=123 \
904903
</aside>
905904

906905
| Required permissions |
907-
|----------------------|
906+
| -------------------- |
908907
| `queue_groups` |
909908
| `reorder_queue` |
910909

@@ -933,18 +932,18 @@ curl https://api.simplyprint.io/{id}/queue/groups/SetOrder?queue_group=123 \
933932
### Request Parameters
934933

935934
| Parameter | Type | Description |
936-
|---------------|---------|----------------------------|
935+
| ------------- | ------- | -------------------------- |
937936
| `queue_group` | integer | The ID of the queue group. |
938937

939938
### Request Body
940939

941940
| Parameter | Type | Description |
942-
|-----------|---------|-------------------------------------|
941+
| --------- | ------- | ----------------------------------- |
943942
| `to` | integer | The new sorting order of the group. |
944943

945944
### Response
946945

947946
| Parameter | Type | Description |
948-
|-----------|---------|---------------------------------------|
947+
| --------- | ------- | ------------------------------------- |
949948
| `status` | boolean | `true` if the request was successful. |
950949
| `message` | string | Error message if `status` is `false`. |

0 commit comments

Comments
 (0)