التوثيقواجهة برمجة تطبيقات REST API لتصدير لوحة التحكم
تسجيل الدخول إلى واجهة برمجة التطبيقات
نقطة النهاية (GET):
/session/login
المعلمات:
المعلمة | الوصف |
|---|---|
| اسم المستخدم لمستخدم SKOOR |
| كلمة مرور نفس المستخدم |
مثال:
https://<SKOOR host>/skoor-webservice/session/login?username=<username>&password=<password>
تسجيل الخروج من واجهة برمجة التطبيقات
يرجى دائمًا تسجيل الخروج من واجهة برمجة التطبيقات بعد تنفيذ الإجراءات المطلوبة
نقطة النهاية (GET):
/session/logout
المعلمات:
المعلمة | الوصف |
|---|---|
| معرف جلسة SKOOR من طلب تسجيل الدخول إلى الجلسة |
مثال:
https://<SKOOR host>/skoor-webservice/session/logout?sessionId=<sessionId>
معلمات التصدير
المعلمة | الوصف |
|---|---|
| تصدير استعلامات البيانات ذات الصلة |
| تصدير الملفات ذات الصلة (مثل الصور) |
| تصدير السمات ذات الصلة (مثل CSS والألوان) |
| تصدير تكوينات الترجمة ذات الصلة |
| معرف جلسة SKOOR من طلب تسجيل الدخول إلى الجلسة |
تصدير جميع لوحات المعلومات
نقطة النهاية (GET):
/dashboards/groups/root/export
المعلمات:
مثال:
https://<SKOOR host>/skoor-webservice/dashboards/groups/root/export?dataQueries=true&files=true&theme=true&translations=true&sessionId=<sessionId>
تصدير مجموعة لوحات المعلومات
نقطة النهاية (GET):
/dashboards/groups/{groupId}/export
مثال:
https://<SKOOR host>/skoor-webservice/dashboards/groups/719/export?dataQueries=true&files=true&theme=true&translations=true&sessionId=<sessionId>
البحث عن معرف مجموعة لوحة المعلومات
للعثور على معرّف المجموعة، قم بمعالجة التصدير يدويًا من قائمة المجموعات المطلوبة وحدد خانة الاختيار JSON عادي في مربع حوار التصدير:
ثم ابحث عن مفتاح المعرف في سلسلة JSON:
تصدير لوحة تحكم واحدة
نقطة النهاية (GET):
/dashboards/{dashboardId}/export
مثال:
https://<SKOOR host>/skoor-webservice/dashboards/10842/export?dataQueries=true&files=true&theme=true&translations=true&sessionId=<sessionId>
البحث عن معرف لوحة المعلومات
كما هو موضح لصادرات مجموعة لوحات المتابعة، يمكن العثور على معرّف لوحة المتابعة في مربع حوار التصدير اليدوي. ابحث عن كائن من نوع لوحة المعلومات والنوع الفرعي للوحة المعلومات للحصول على مفتاح المعرف الصحيح:
