Skip to content

Commit 3b4bdef

Browse files
johanohlyjohanohly
committed
Manually merge in #10 
1 parent db27cf5 commit 3b4bdef

File tree

1 file changed

+37
-28
lines changed

1 file changed

+37
-28
lines changed

‎source/includes/_jobs.md

+37-28
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,13 @@ curl https://api.simplyprint.io/{id}/jobs/GetPaginatedPrintJobs \
1515
{
1616
"page": 1,
1717
"page_size": 10,
18-
"printer_ids": [385],
19-
"status": ["cancelled", "finished"],
18+
"printer_ids": [
19+
385
20+
],
21+
"status": [
22+
"cancelled",
23+
"finished"
24+
],
2025
"start_date": "2023-02-28"
2126
}
2227
```
@@ -38,6 +43,8 @@ curl https://api.simplyprint.io/{id}/jobs/GetPaginatedPrintJobs \
3843
"startDate": "2023-02-28T21:05:50+00:00",
3944
"endDate": "2023-02-28T21:06:07+00:00",
4045
"user": 5933,
46+
"autoprint": false,
47+
"outsideSystem": false,
4148
"printer": 385,
4249
"filament": "{\"e0\": {\"usage\": 60}}",
4350
"filUsage": 60,
@@ -102,7 +109,7 @@ Get paginated data about ongoing or finished print jobs.
102109
`POST /{id}/jobs/GetPaginatedPrintJobs`
103110

104111
| Parameter | Type | Required | Description |
105-
| --------------------- | --------- | -------- | ---------------------------------------------------------------------------------------- |
112+
|-----------------------|-----------|----------|------------------------------------------------------------------------------------------|
106113
| `page` | integer | yes | The page number to get. |
107114
| `page_size` | integer | yes | The number of items per page. (Between 1 and 100) |
108115
| `printer_types[]` | integer[] | no | Array of printer type ids to filter on. |
@@ -114,28 +121,30 @@ Get paginated data about ongoing or finished print jobs.
114121

115122
### Response
116123

117-
| Parameter | Type | Description |
118-
| --------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------ |
119-
| `status` | boolean | True if the request was successful. |
120-
| `message` | string | Error message if `status` is false. |
121-
| `data` | array | The jobs. |
122-
| `data[].id` | integer | The job id. |
123-
| `data[].uid` | string | The job uid. |
124-
| `data[].status` | string | The job status. One of `ongoing`, `cancelled`, `failed`, `done`. Note that `done` is the same as `finished` |
125-
| `data[].cancelReasonType` | string | The job cancel reason type. |
126-
| `data[].rating` | integer | The job rating. |
127-
| `data[].filename` | string | The job filename. |
128-
| `data[].startDate` | string | The job start date. |
129-
| `data[].endDate` | string/null | The job end date. Is null if the job is ongoing. |
130-
| `data[].user` | integer | The user id of the user who started the job. |
131-
| `data[].printer` | integer | The printer id that was used to print the job. |
132-
| `data[].filament` | string | The filament usage. JSON encoded string with usage per extruder. |
133-
| `data[].filUsage` | integer | The filament usage in mm. |
134-
| `data[].filUsageGram` | integer | The filament usage in grams. |
135-
| `data[].currentPercentage` | integer | The current percentage of the job. |
136-
| `data[].cost` | object/null | Potential calculated cost of job. |
137-
| `data[].queueItem` | object/null | The queue item that was used to start the job. Please note that this is only shown if you have access to view the Print Queue. |
138-
| `data[].queueItem.id` | integer | The id of the queue item that was used to start the job. |
139-
| `data[].queueItem.user` | integer | The user id of the user who created the queue item. |
140-
| `data[].queueItem.queueNum` | integer | The queue number of the queue item. |
141-
| `page_amount` | integer | The total number of pages for the given parameters. |
124+
| Parameter | Type | Description |
125+
|-----------------------------|--------------|--------------------------------------------------------------------------------------------------------------------------------|
126+
| `status` | boolean | True if the request was successful. |
127+
| `message` | string | Error message if `status` is false. |
128+
| `data` | array | The jobs. |
129+
| `data[].id` | integer | The job id. |
130+
| `data[].uid` | string | The job uid. |
131+
| `data[].status` | string | The job status. One of `ongoing`, `cancelled`, `failed`, `done`. Note that `done` is the same as `finished` |
132+
| `data[].cancelReasonType` | string | The job cancel reason type. |
133+
| `data[].rating` | integer | The job rating. |
134+
| `data[].filename` | string | The job filename. |
135+
| `data[].startDate` | string | The job start date. |
136+
| `data[].endDate` | string/null | The job end date. Is null if the job is ongoing. |
137+
| `data[].user` | integer/null | The user id of the user who started the job. |
138+
| `data[].autoprint` | boolean | If the job was started automatically using the Auto-print feature |
139+
| `data[].outsideSystem` | boolean | If the job was started outside SimplyPrint, via SD card, OctoPrint, Mailsail, Fluidd or else how |
140+
| `data[].printer` | integer | The printer id that was used to print the job. |
141+
| `data[].filament` | string | The filament usage. JSON encoded string with usage per extruder. |
142+
| `data[].filUsage` | integer | The filament usage in mm. |
143+
| `data[].filUsageGram` | integer | The filament usage in grams. |
144+
| `data[].currentPercentage` | integer | The current percentage of the job. |
145+
| `data[].cost` | object/null | Potential calculated cost of job. |
146+
| `data[].queueItem` | object/null | The queue item that was used to start the job. Please note that this is only shown if you have access to view the Print Queue. |
147+
| `data[].queueItem.id` | integer | The id of the queue item that was used to start the job. |
148+
| `data[].queueItem.user` | integer | The user id of the user who created the queue item. |
149+
| `data[].queueItem.queueNum` | integer | The queue number of the queue item. |
150+
| `page_amount` | integer | The total number of pages for the given parameters. |

0 commit comments

Comments
 (0)