Poll one export job
GET
/api/v1/exports/{id}
prm_exports_index
The job's current state and progress. Poll this until status reports the job is finished, then download.
processed and total drive a progress bar; row_count is the final emitted count and stays 0 until the job finishes. A job that is not yours answers 404 rather than 403, so job ids are not enumerable across resellers.
At a glance
- Authentication
- Staff token or session
- Requires permission
-
prm_exports_indexView export jobs
Parameters
| Parameter | Description |
|---|---|
idrequired
path · integer
|
Job id. |
Errors
| Code | When it is returned |
|---|---|
ERR_NOT_FOUND404
|
no such job, or one belonging to another manager's subtree |