Data
Data export and delete.
نقطتا وصول. أسماء نقاط الوصول وأوصافها مأخوذة من ملف OpenAPI، لذلك تظهر بالإنجليزية.
GET
/v1/data/requestsData Request List
يحتاج إلى مفتاح أو جلسة في لوحة التحكم
الردود
- 200Successful Response
DataRequestOut[]
POST
/v1/data/requestsGDPR-style export or delete of all store data
يحتاج إلى مفتاح أو جلسة في لوحة التحكم
المعاملات
| الاسم | الموضع | النوع | إلزامي | الوصف |
|---|---|---|---|---|
Idempotency-Key | header | string | null | لا | Unique per logical write (8-255 chars). Retries with the same key are safe. · pattern ^[A-Za-z0-9_\-:.]{8,255}$ |
جسم الطلب application/json DataRequestIn
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
kind | "export" | "delete" | نعم | |
confirm_slug | string | null | لا | delete only: must equal the tenant slug. |
الردود
- 202Successful Response
DataRequestOut
أشكال البيانات في هذه الصفحة
DataRequestOut
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
id | string | نعم | |
kind | "export" | "delete" | نعم | |
status | "queued" | "running" | "succeeded" | "failed" | نعم | |
created_at | string (date-time) | نعم | |
completed_at | string (date-time) | null | لا | |
download_url | string | null | لا | export only: a signed BlobStore URL, valid 24 h (ADR 0018). |
job | Job | null | لا |
Job
A row of the shared `jobs` table. Poll GET /v1/jobs/{id} until status is terminal.
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
id | string | نعم | |
kind | "reindex" | "import" | "sync" | "translate_backfill" | "translate_writeback" | "export" | "data_export" | "data_delete" | "embed" | "synonym_mining" | نعم | |
status | "queued" | "running" | "succeeded" | "failed" | "canceled" | نعم | |
progress | number | لا | default 0 · min 0 · max 1 |
created_at | string (date-time) | نعم | |
started_at | string (date-time) | null | لا | |
finished_at | string (date-time) | null | لا | |
result | object | null | لا | |
error | string | null | لا |
DataRequestIn
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
kind | "export" | "delete" | نعم | |
confirm_slug | string | null | لا | delete only: must equal the tenant slug. |