Skip to content

Commit acc4401

Browse files
johanohlyjohanohly
committed
Document queue groups
1 parent 8a12c2d commit acc4401

File tree

1 file changed

+207
-0
lines changed

1 file changed

+207
-0
lines changed

Diff for: ‎source/includes/_queue.md

+207
Original file line numberDiff line numberDiff line change
@@ -688,3 +688,210 @@ This endpoint empties the queue.
688688
|-----------|---------|--------------------------------------------------------|
689689
| `status` | boolean | True if the request was successful. |
690690
| `message` | string | Success message or error message if `status` is false. |
691+
692+
## Revive item
693+
694+
```shell
695+
curl https://api.simplyprint.io/{id}/queue/ReviveItem?job=1234 \
696+
-H 'accept: application/json' \
697+
-H 'X-API-KEY: {API_KEY}' \
698+
```
699+
700+
> Success response
701+
702+
```json
703+
{
704+
"status": true,
705+
"message": null
706+
}
707+
```
708+
709+
`POST /{id}/queue/ReviveItem`
710+
711+
### Request Parameters
712+
713+
| Parameter | Type | Description |
714+
|-----------|---------|------------------------------|
715+
| `job` | integer | The ID of the job to revive. |
716+
717+
### Response
718+
719+
| Parameter | Type | Description |
720+
|-----------|---------|---------------------------------------|
721+
| `status` | boolean | `true` if the request was successful. |
722+
| `message` | string | Error message if `status` is `false`. |
723+
724+
## Get groups
725+
726+
```shell
727+
curl https://api.simplyprint.io/{id}/queue/groups/Get \
728+
-H 'accept: application/json' \
729+
-H 'X-API-KEY: {API_KEY}'
730+
```
731+
732+
> Success response
733+
734+
```json
735+
{
736+
"status": true,
737+
"message": null,
738+
"list": [
739+
{
740+
"id": 1,
741+
"name": "Queue Group 1",
742+
"virtual": false,
743+
"extensions": [
744+
"gcode",
745+
"bgcode"
746+
],
747+
"sort_order": 1
748+
}
749+
]
750+
}
751+
```
752+
753+
`GET /{id}/queue/groups/Get`
754+
755+
### Response
756+
757+
| Parameter | Type | Description |
758+
|---------------------|---------|----------------------------------------------------------------------------------|
759+
| `status` | boolean | `true` if the request was successful. |
760+
| `message` | string | Error message if `status` is `false`. |
761+
| `list` | array | Array of print queue groups. |
762+
| `list[].id` | integer | Unique identifier for the group. |
763+
| `list[].name` | string | Name of the group. |
764+
| `list[].virtual` | boolean | Whether the group is a virtual queue group. |
765+
| `list[].extensions` | array | An array of file extensions that are allowed in the group. (without punctuation) |
766+
| `list[].sort_order` | integer | The sort order of the group. |
767+
| `list[].for` | object | For which printers, models and groups this queue item is for. |
768+
769+
## Save group
770+
771+
```shell
772+
curl https://api.simplyprint.io/{id}/queue/groups/Save \
773+
-X POST \
774+
-H 'accept: application/json' \
775+
-H 'X-API-KEY: {API_KEY}' \
776+
-d '{
777+
"id": 123,
778+
"name": "New Queue Group",
779+
"accepted_extensions": ["gcode", "bgcode"],
780+
"virtual_only": false,
781+
"for_printers": "1,2,3",
782+
"for_models": "4,5,6",
783+
"for_groups": "7,8,9"
784+
}'
785+
```
786+
787+
> Success response
788+
789+
```json
790+
{
791+
"status": true,
792+
"message": null
793+
}
794+
```
795+
796+
`POST /{id}/queue/groups/Save`
797+
798+
### Request Body
799+
800+
| Parameter | Type | Description |
801+
|-----------------------|---------|--------------------------------------------------------------------|
802+
| `id` | integer | The ID of the group to update (optional for creating a new group). |
803+
| `name` | string | The name of the queue group. |
804+
| `accepted_extensions` | array | List of accepted file extensions. |
805+
| `virtual_only` | boolean | Whether the group is virtual only. |
806+
| `for_printers` | string | Comma-separated list of printer IDs. |
807+
| `for_models` | string | Comma-separated list of printer model IDs. |
808+
| `for_groups` | string | Comma-separated list of printer group IDs. |
809+
810+
### Response
811+
812+
| Parameter | Type | Description |
813+
|-----------|---------|---------------------------------------|
814+
| `status` | boolean | `true` if the request was successful. |
815+
| `message` | string | Error message if `status` is `false`. |
816+
817+
## Delete group
818+
819+
```shell
820+
curl https://api.simplyprint.io/{id}/queue/groups/Delete?id=123 \
821+
-X POST \
822+
-H 'accept: application/json' \
823+
-H 'X-API-KEY: {API_KEY}' \
824+
```
825+
826+
> Success response
827+
828+
```json
829+
{
830+
"status": true,
831+
"message": null
832+
}
833+
```
834+
835+
`POST /{id}/queue/groups/Delete`
836+
837+
### Request Parameters
838+
839+
| Parameter | Type | Description |
840+
|-----------|---------|--------------------------------|
841+
| `id` | integer | The ID of the group to delete. |
842+
843+
### Request Body
844+
845+
| Parameter | Type | Description |
846+
|-----------|---------|--------------------------------------------------------------------|
847+
| `move_to` | integer | The ID of the group to move items to. Defaults to any other group. |
848+
849+
### Response
850+
851+
| Parameter | Type | Description |
852+
|-----------|---------|---------------------------------------|
853+
| `status` | boolean | `true` if the request was successful. |
854+
| `message` | string | Error message if `status` is `false`. |
855+
856+
## Set group order
857+
858+
```shell
859+
curl https://api.simplyprint.io/{id}/queue/groups/SetOrder?queue_group=123 \
860+
-X POST \
861+
-H 'accept: application/json' \
862+
-H 'X-API-KEY: {API_KEY}' \
863+
-d '{
864+
"from": 1,
865+
"to": 2
866+
}'
867+
```
868+
869+
> Success response
870+
871+
```json
872+
{
873+
"status": true,
874+
"message": null
875+
}
876+
```
877+
878+
`POST /{id}/queue/groups/SetOrder`
879+
880+
### Request Parameters
881+
882+
| Parameter | Type | Description |
883+
|---------------|---------|----------------------------|
884+
| `queue_group` | integer | The ID of the queue group. |
885+
886+
### Request Body
887+
888+
| Parameter | Type | Description |
889+
|-----------|---------|-------------------------------------|
890+
| `to` | integer | The new sorting order of the group. |
891+
892+
### Response
893+
894+
| Parameter | Type | Description |
895+
|-----------|---------|---------------------------------------|
896+
| `status` | boolean | `true` if the request was successful. |
897+
| `message` | string | Error message if `status` is `false`. |

0 commit comments

Comments
 (0)