انتقل إلى المحتوى
القائمة
كل مجموعات الواجهة

Data

Data export and delete.

نقطتا وصول. أسماء نقاط الوصول وأوصافها مأخوذة من ملف OpenAPI، لذلك تظهر بالإنجليزية.

GET/v1/data/requests

Data Request List

يحتاج إلى مفتاح أو جلسة في لوحة التحكم

الردود

POST/v1/data/requests

GDPR-style export or delete of all store data

يحتاج إلى مفتاح أو جلسة في لوحة التحكم

المعاملات

الاسمالموضعالنوعإلزاميالوصف
Idempotency-Keyheaderstring | 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_slugstring | nullلاdelete only: must equal the tenant slug.

الردود

أشكال البيانات في هذه الصفحة

DataRequestOut

الاسمالنوعإلزاميالوصف
idstringنعم
kind"export" | "delete"نعم
status"queued" | "running" | "succeeded" | "failed"نعم
created_atstring (date-time)نعم
completed_atstring (date-time) | nullلا
download_urlstring | nullلاexport only: a signed BlobStore URL, valid 24 h (ADR 0018).
jobJob | nullلا

Job

A row of the shared `jobs` table. Poll GET /v1/jobs/{id} until status is terminal.

الاسمالنوعإلزاميالوصف
idstringنعم
kind"reindex" | "import" | "sync" | "translate_backfill" | "translate_writeback" | "export" | "data_export" | "data_delete" | "embed" | "synonym_mining"نعم
status"queued" | "running" | "succeeded" | "failed" | "canceled"نعم
progressnumberلاdefault 0 · min 0 · max 1
created_atstring (date-time)نعم
started_atstring (date-time) | nullلا
finished_atstring (date-time) | nullلا
resultobject | nullلا
errorstring | nullلا

DataRequestIn

الاسمالنوعإلزاميالوصف
kind"export" | "delete"نعم
confirm_slugstring | nullلاdelete only: must equal the tenant slug.