واجهة برمجة البيانات الوصفية
توفر واجهة برمجة البيانات الوصفية حاليًا قائمة بيانات تعريف الاستبيانات المستخدمة من تكاملات التقارير. تتطلب نطاق ReportsRead على مفتاح API. ويجب أيضًا أن تفعّل خطة المؤسسة الفعالة الوصول إلى API التقارير، وأن تحتفظ بالعميل ضمن التكاملات الخارجية، وأن تنجح فحوص المؤسسة النشطة والاشتراك.
النطاق المطلوب
ReportsRead
نقاط النهاية المتاحة
قائمة الاستبيانات
تعيد مصفوفة واحدة غير مقسمة بالصفحات تضم جميع استبيانات مؤسسة المفتاح غير المحذوفة، مرتبة حسب الاسم. تشمل النشطة وغير النشطة.
GET /api/integrations/metadata/surveys
حقول الاستجابة (لكل استبيان):
| الحقل | النوع | الوصف |
|---|---|---|
id |
integer | المعرف الفريد |
code |
string أو null | رمز الاستبيان عند وجوده |
name |
string أو null | اسم الاستبيان عند وجوده |
description |
string أو null | وصف الاستبيان عند وجوده |
isActive |
boolean | ما إذا كان الاستبيان نشطًا |
لا تقبل نقطة النهاية معاملات page أوpageSize أوstatus أو معرّف استبيان. ولا يعرض العقد الحالي نقطة نهاية لتعريف الاستبيان الكامل.
مثال الاستجابة:
[
{
"id": 45,
"code": "CSAT-2026",
"name": "رضا العملاء",
"description": "ملاحظات ربع سنوية",
"isActive": true
}
]
حدود العقد
هذه النقطة كتالوج لاستبيانات المؤسسة فقط. ولا تعيد الأقسام أو الأسئلة أو الخيارات أو قواعد التشغيل أو تعريفًا كاملًا للاستبيان. ولا يشمل العقد الحالي مسار بيانات وصفية/تعريف لكل استبيان.
عزل المؤسسات
جميع استجابات واجهة برمجة البيانات الوصفية مقيدة بالمؤسسة المرتبطة بمفتاح API.
ملاحظات
- لا تتضمن البيانات الوصفية صفوف الاستجابات. للحصول على ملخصات الاستجابات التجميعية، استخدم نقطة نهاية التقارير مع
ReportsRead. - لا تعد بيانات التعريف تعريف تشغيل للاستبيان ولا تتضمن صفوف الاستجابات.