الانتقال إلى المحتوى الرئيسي
GET
cURL

التفويضات

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.

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

questionnaire_uuid
string<uuid>
مطلوب

معرف UUID لكل إصدار من الاستبيان (قيمة uuid التي يرجعها endpoint القائمة، ويُرجع أيضاً كـ questionnaire_id في endpoint التفاصيل).

الاستجابة

تفاصيل الاستبيان الكاملة بما في ذلك graph القياسي، وعرض sections المشتق، والبيانات الوصفية للإصدار، وحقل is_editable.

تفاصيل الاستبيان الكاملة المرجعة من endpoint الخاصة بـ GET وPOST (إنشاء) وPATCH (تحديث).

questionnaire_id
string<uuid>

المعرّف الفريد للاستبيان. استخدم هذا المعرّف عند الإشارة إلى الاستبيان من سير العمل أو في طلبات التحديث/الحذف اللاحقة.

title
string
description
string | null
languages
string[]
default_language
string
is_active
boolean
is_simple_questionnaire
boolean
graph
object

هيكل المخطط مع start_node وخريطة العقد.

sections
object[]

محتوى الاستبيان مجمّعاً في أقسام (مستمد من المخطط).

questionnaire_group_id
string<uuid>

معرّف ثابت يجمع جميع إصدارات الاستبيان نفسه.

version
integer
status
enum<string>
الخيارات المتاحة:
draft,
published
published_at
string<date-time> | null
is_editable
boolean

تكون القيمة True عندما يكون من الممكن تعديل الاستبيان مباشرة في مكانه (إصدارات المسودة).

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