docs: update history api documentation
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
This commit is contained in:
parent
53ad4cb493
commit
083d63568c
|
@ -1612,47 +1612,77 @@ The APIs below are avilable when the `[history]` plugin has been configured.
|
||||||
|
|
||||||
### Get job list
|
### Get job list
|
||||||
- HTTP command:\
|
- HTTP command:\
|
||||||
`GET /server/history/list?limit=50&start=50&since=1&before=5&id=1`
|
`GET /server/history/list?limit=50&start=50&since=1&before=5`
|
||||||
|
|
||||||
- Websocket command:\
|
- Websocket command:\
|
||||||
`{"jsonrpc":"2.0","method":"server.history.list","id":"1","params":{}}`
|
`{"jsonrpc":"2.0","method":"server.history.list","id":"1","params":{}}`
|
||||||
|
|
||||||
All arguments are optional. Arguments are as follows:
|
All arguments are optional. Arguments are as follows:
|
||||||
`before` All jobs before this UNIX timestamp
|
- `before` All jobs before this UNIX timestamp
|
||||||
`id` ID of job to display. This overrides other arguments.
|
- `limit` Number of prints to return
|
||||||
`limit` Number of prints to return
|
- `since` All jobs after this UNIX timestamp
|
||||||
`since` All jobs after this UNIX timestamp
|
- `start` Record number to start from (i.e. 10 would start at the 10th print)
|
||||||
`start` Record number to start from (i.e. 10 would start at the 10th print)
|
|
||||||
|
|
||||||
- Returns an array of jobs that have been printed
|
- Returns an array of jobs that have been printed
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
count: <number of prints>
|
count: <number of prints>,
|
||||||
prints: {
|
jobs: [
|
||||||
<id>: {
|
{
|
||||||
|
"job_id": <unique job id>,
|
||||||
"end_time": <end_time>,
|
"end_time": <end_time>,
|
||||||
"filament_used": <filament_used>
|
"filament_used": <filament_used>,
|
||||||
"filename": <filename>,
|
"filename": <filename>,
|
||||||
"metadata": {}, # Array of file metadata
|
"metadata": {}, // Object containing metadata at time of job
|
||||||
"print_duration": <print_duration>,
|
"print_duration": <print_duration>,
|
||||||
"status": <status>,
|
"status": <status>,
|
||||||
"start_time": <start_time>,
|
"start_time": <start_time>,
|
||||||
"total_duration": <total_duration>
|
"total_duration": <total_duration>
|
||||||
}
|
},
|
||||||
|
...
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Get a single job
|
||||||
|
- HTTP command:\
|
||||||
|
`GET /server/history/job?uid=<id>`
|
||||||
|
|
||||||
|
- Websocket command:\
|
||||||
|
`{"jsonrpc":"2.0","method":"server.history.get_job","id":"1",
|
||||||
|
"params":{"uid": <id>}}`
|
||||||
|
|
||||||
|
- Returns:
|
||||||
|
Data associated with the job ID in the following format:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"job": {
|
||||||
|
"job_id": <unique job id>,
|
||||||
|
"end_time": <end_time>,
|
||||||
|
"filament_used": <filament_used>,
|
||||||
|
"filename": <filename>,
|
||||||
|
"metadata": {}, // Object containing metadata at time of job
|
||||||
|
"print_duration": <print_duration>,
|
||||||
|
"status": <status>,
|
||||||
|
"start_time": <start_time>,
|
||||||
|
"total_duration": <total_duration>
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Delete job
|
### Delete job
|
||||||
- HTTP command:\
|
- HTTP command:\
|
||||||
`DELETE /server/history/delete?all`
|
`DELETE /server/history/job?uid=<id>`
|
||||||
|
|
||||||
|
Note: it is possible to replace the "uid" argument with `all=true`
|
||||||
|
to delete all jobs.
|
||||||
|
|
||||||
- Websocket command:\
|
- Websocket command:\
|
||||||
`{"jsonrpc":"2.0","method":"server.history.delete","id":"1","params":{}}`
|
`{"jsonrpc":"2.0","method":"server.history.delete_job","id":"1",
|
||||||
|
"params":{"uid": <id>}}`
|
||||||
|
|
||||||
One argument from below is required:
|
Note: it is possible to replace the "uid" argument with `"all": true`
|
||||||
`all` Set to true to delete all history
|
to delete all jobs.
|
||||||
`id` Delete specific job
|
|
||||||
|
|
||||||
- Returns an array of deleted ids
|
- Returns an array of deleted ids
|
||||||
```json
|
```json
|
||||||
|
@ -1831,6 +1861,21 @@ response from a [process info](#get-process-info) request. It is possible
|
||||||
for clients to receive this notification multiple times if the system
|
for clients to receive this notification multiple times if the system
|
||||||
repeatedly transitions between an active and inactive throttled condition.
|
repeatedly transitions between an active and inactive throttled condition.
|
||||||
|
|
||||||
|
### History Changed
|
||||||
|
If the `[history]` module is enabled the following notification is sent when
|
||||||
|
a job is added or finished:
|
||||||
|
|
||||||
|
`{jsonrpc: "2.0", method: "notify_history_changed", params: [history_state]}`
|
||||||
|
|
||||||
|
Where `history_state` is an object in the following format:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"action": "added" or "finished",
|
||||||
|
"job": <job object>
|
||||||
|
}
|
||||||
|
```
|
||||||
|
The `job` field matches the object returned when requesting
|
||||||
|
[job data](#get-a-single-job).
|
||||||
# Appendix
|
# Appendix
|
||||||
|
|
||||||
## Websocket setup
|
## Websocket setup
|
||||||
|
|
Loading…
Reference in New Issue