Queue an export
POST
/api/v1/exports
prm_exports_create
Creates the job and returns immediately; a separate worker produces the file. The caller's authority scope is stamped onto the job server-side, so an export contains exactly what that manager's list view would show and nothing more.
Exporting a table needs the permission to read it as well as the permission to export. The route's own gate is not enough, so a role with export rights but no subscriber-read right gets a 403 on target_table users. That is the check that stops an export from being a way around a list permission.
نظرة سريعة
- المصادقة
- رمز موظّف أو جلسة
- تتطلب صلاحية
-
prm_exports_createCreate / delete export jobs - حد المعدل
t_heavy- مفتاح عدم التكرار
request_id
المعاملات
| المعامل | الوصف |
|---|---|
target_tableمطلوب
body · string
|
A dataset key from the datasets endpoint. |
format
body · enum
|
csv or xlsx. Defaults to xlsx. |
params
body · object
|
Dataset-specific filters, in the same shape that dataset's list endpoint accepts. |
request_id
body · string
|
Optional idempotency key. Blank stays blank and means no deduplication at all — supply your own if a retry must not queue a second job. |
الأخطاء
| الرمز | متى تُرجَع |
|---|---|
ERR_VALIDATION400
|
an unknown target_table, or a format that is neither csv nor xlsx |
ERR_FORBIDDEN403
|
the caller may create exports but lacks the permission to VIEW that table |