الانتقال إلى المحتوى الرئيسي
POST
cURL
استخدم هذا endpoint لإنشاء استبيانات بسيطة عبر واجهة API. أرسل مصفوفة form_elements بالترتيب الذي يجب أن يجيب به المستخدمون عن الأسئلة. يبني Didit رسم الاستبيان الداخلي نيابةً عنك. لا تدعم الواجهة إلا الاستبيانات الخطية البسيطة. لا ترسل graph أو branches أو next أو القواعد الشرطية.

الحقول المطلوبة

  • title هو اسم الاستبيان الداخلي.
  • يجب أن تتضمن languages القيمة en.
  • يجب أن تحتوي form_elements على سؤال واحد على الأقل.
  • يحتاج كل عنصر في النموذج إلى element_type وlabel مترجمة.
يمكنك أيضاً إضافة description مترجمة اختيارية إلى أي عنصر في النموذج لتكون نصًا مساعدًا له. تُقبل هذه الخاصية في كل أنواع العناصر ما عدا separator، وتُعاد كقيمة description للعنصر في تقرير الاستبيان.

أنواع العناصر

استخدم قيماً بأحرف صغيرة مثل short_text أو multiple_choice أو email أو file_upload أو date_picker. كما تُقبل قيم التعداد بأحرف كبيرة مثل SHORT_TEXT. بالنسبة إلى dropdown وsingle_choice وmultiple_choice، أضف options. إذا حذفت value لأحد الخيارات، يولّد Didit قيمة له من التسمية.

التحقق من صحة الحقول

أضف كائن validation اختيارياً إلى عنصر short_text أو long_text أو number لفرض تنسيق معين على إجابة المستخدم. ويفيد ذلك في المعرّفات ذات التنسيقات الصارمة، مثل الأرقام الضريبية وأرقام الهوية الوطنية وأرقام البطاقات. يعمل التحقق أثناء ملء المستخدم للحقل (لا يستطيع المستخدم المتابعة حتى يجتاز الحقل التحقق)، وتعيد واجهة API فرضه عند الإرسال.
تتضمن الاستجابة questionnaire_id. احفظه، لأنك ستستخدمه كقيمة questionnaire_uuid عند إضافة الاستبيان إلى سير العمل.

التفويضات

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.

الجسم

application/json

أنشئ استبياناً خطياً بسيطاً. تحوّل API عناصر form_elements إلى المخطط الداخلي للاستبيان.

title
string
مطلوب

اسم داخلي للاستبيان.

languages
string[]
مطلوب

اللغات المضمنة في كل تسمية. يجب أن تتضمن en.

مثال:
form_elements
object[]
مطلوب

الأسئلة بالترتيب الدقيق الذي يجب أن يراها المستخدمون به. التفريع والحقول المشروطة غير مدعومة.

Minimum array length: 1
description
string | null
default_language
string

اللغة الافتراضية. يجب تضمينها في languages.

مثال:

"en"

is_active
boolean
افتراضي:true
status
enum<string>

احذف هذا الحقل لإنشاء استبيان منشور وجاهز لمهام سير العمل.

الخيارات المتاحة:
draft,
published

الاستجابة

تم إنشاء الاستبيان. تتضمن الاستجابة questionnaire_id — قم بتخزينه للإشارة إلى هذا الاستبيان من سير العمل أو استدعاءات التحديث/الحذف المستقبلية.

تفاصيل الاستبيان الكاملة المرجعة من 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 عندما يكون من الممكن تعديل الاستبيان مباشرة في مكانه (إصدارات المسودة).

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