الانتقال إلى المحتوى الرئيسي
POST
Python
تُعيد واجهة Reports API غير المتزامنة الخاصة بـ Didit تشغيل تصدير، أو تضع في قائمة الانتظار عناصر التحقق الفاشلة المحددة. تُرجع إعادة المحاولة الجديدة الاستجابة 201، أما التحديد المطابق لعناصر فاشلة سبق اختيارها فيُرجع التقرير الموجود بالاستجابة 200.
تتطلب إعادة المحاولة الانتقائية هوية المستخدم الأصلي الذي قدّم الطلب. يتلقى مفتاح API أو رمز التطبيق الذي لا يحمل هذه الهوية الاستجابة 403 عند إرسال item_ids، حتى لتطبيقه نفسه. يُعيد مثال مفتاح API المُولَّد تشغيل التصدير كاملاً بجسم طلب فارغ.
اقرأ المعرّفات الفعلية من استرجع التقرير غير المتزامن واتبع إرشادات إعادة محاولة العناصر الفاشلة. أرسل من 1 إلى 1000 معرّف من SESSION_EXPORT بحالة READY أو FAILED، دون نطاق تاريخ بديل. لا يمكن إعادة محاولة الجلسات المحذوفة.

التفويضات

x-api-key
string
header
مطلوب

مفتاح API الخاص بتطبيقك، من Developers -> API keys في Business Console. يمتلك المفتاح الأساسي وصولاً كاملاً. يمكن تحديد نطاق المفتاح المسمى: لا شيء، أو قراءة، أو كتابة لكل مورد، ومحدوداً ببعض مسارات العمل أو بالجلسات المقبولة، وبقائمة من عناوين IP، وبتاريخ انتهاء الصلاحية. يشير 401 إلى أن المفتاح غير صحيح أو ملغى أو منتهي الصلاحية؛ ويشير 403 إلى أنه لم يتم إرسال أي مفتاح، أو أن المفتاح ليس لديه حق الوصول إلى هذا المورد أو الإجراء، أو أن الطلب جاء من عنوان خارج قائمة عناوين IP الخاصة به؛ ويشير 404 في مسار جلسة إلى أن الجلسة خارج مسارات العمل أو الحالات الخاصة بالمفتاح. يتلقى المفتاح الذي لا يمتلك حق الوصول إلى الوسائط عناوين URL للصور ومقاطع الفيديو وملفات PDF كـ null، ويتلقى المفتاح الذي لا يمتلك إذن كتابة للجلسات روابط الجلسة وtoken كـ null. راجع https://docs.didit.me/console/api-keys.

معلمات المسار

organization_id
string<uuid>
مطلوب

معرّف المؤسسة.

application_id
string<uuid>
مطلوب

معرّف التطبيق.

report_uuid
string<uuid>
مطلوب

معرّف UUID للتقرير.

الجسم

application/json
item_ids
string<uuid>[]

اختيار اختياري من 1 إلى 1000 معرّف UUID لجلسة مباشرة فاشلة من هذا التصدير. تُدمج المعرّفات المكررة. يمكن للطالب الأصلي وحده إعادة محاولة مجموعة فرعية. لا يمكن دمجه مع date_from/date_to.

Required array length: 1 - 1000 elements
date_from
string<date>

بداية فترة الاستبدال الاختيارية. أرسل التاريخين بالترتيب الصحيح؛ احذفهما عند إعادة المحاولة لعنصر فاشل.

date_to
string<date>

نهاية فترة الاستبدال الاختيارية، ويجب أن تكون في تاريخ date_from أو بعده.

notify_on_ready
boolean
افتراضي:false

إرسال بريد إلكتروني إلى مقدّم الطلب عند الجاهزية، إذا كان بريده الإلكتروني متاحاً.

الاستجابة

إعادة تشغيل مطابقة لاختيار العناصر الفاشلة نفسه؛ تُعيد تقرير إعادة المحاولة الموجود دون إضافة طلب جديد إلى قائمة الانتظار.

uuid
string<uuid>
مطلوب

معرّف التقرير.

report_type
enum<string>
مطلوب

نوع التصدير أو تقرير الامتثال.

الخيارات المتاحة:
SESSION_EXPORT,
TRANSACTION_EXPORT,
BUSINESS_EXPORT,
VENDOR_USER_EXPORT,
VENDOR_BUSINESS_EXPORT,
CASE_EXPORT,
CASE_SLA_EXPORT,
LIST_ENTRY_EXPORT,
EVENT_EXPORT,
COMPLIANCE_KYC_KYB,
COMPLIANCE_AML_LOG,
COMPLIANCE_TRAVEL_RULE,
COMPLIANCE_SANCTIONS_PEP,
COMPLIANCE_RISK_SUMMARY,
COMPLIANCE_SAR_STR_DRAFT,
COMPLIANCE_CTR,
COMPLIANCE_CASE_SUMMARY
report_type_display
string
مطلوب

عنوان العرض لنوع التقرير.

status
enum<string>
مطلوب

حالة التوليد. قد تتضمن الحالة READY حالات فشل فردية؛ تحقّق من failed_count.

الخيارات المتاحة:
PENDING,
PROCESSING,
READY,
FAILED
status_display
string
مطلوب

عنوان العرض لحالة التوليد.

parameters
object
مطلوب

خيارات التصدير الأصلية؛ تختلف المفاتيح حسب report_type.

requested_by_user_id
string<uuid> | null
مطلوب

هوية الطالب الأصلي، أو null للمتصلين الذين لا يملكون هوية مستخدم.

requested_by_email
string | null
مطلوب

البريد الإلكتروني للطالب، عند توفره.

requested_by_name
string | null
مطلوب

اسم عرض الطالب، عند توفره.

row_count
integer | null
مطلوب

عدد السجلات المصدّرة، أو null قبل إنشاء التقرير.

failed_item_ids
string<uuid>[]
مطلوب

معرّفات UUID للجلسات المباشرة التي فشلت في تصدير التحقق هذا. تُستبعد الجلسات المحذوفة. استخدم هذه المعرّفات لإعادة المحاولة الانتقائية.

failed_count
integer
مطلوب

عدد العناصر في failed_item_ids.

النطاق المطلوب: x >= 0
file_size
integer<int64> | null
مطلوب

إجمالي حجم الملف المُنشأ بالبايت، أو null قبل الإنشاء.

files
object[]
مطلوب

البيانات الوصفية للملف المُولَّد؛ ولا تحتوي على روابط تنزيل.

scheduled_report
string<uuid> | null
مطلوب

معرّف الجدولة، أو null للتقرير غير المجدول.

error_message
string | null
مطلوب

خطأ التوليد، عند توفره.

deletion_pending
boolean
مطلوب

ما إذا كان الحذف المطلوب ما زال قيد التنفيذ.

eta_seconds
integer | null
مطلوب

الوقت المقدّر بالثواني حتى الاكتمال لتقرير قيد الانتظار أو المعالجة؛ تكون القيمة null في غياب السجل أو عند الاكتمال.

started_at
string<date-time> | null
مطلوب

وقت بدء التوليد.

completed_at
string<date-time> | null
مطلوب

وقت اكتمال التوليد.

expires_at
string<date-time>
مطلوب

وقت انتهاء صلاحية التقرير.

created_at
string<date-time>
مطلوب

وقت الإنشاء.

updated_at
string<date-time>
مطلوب

وقت آخر تحديث.

آخر تعديل في ١٤ نوفمبر ٢٠٢٦