واجهة برمجة تطبيقات REST لتصدير لوحة المعلومات

تسجيل الدخول إلى API

نقطة النهاية (GET):

/session/login

المعاملات:

المعامل

الوصف

username

اسم المستخدم لمستخدم SKOOR

password

كلمة المرور لنفس المستخدم

مثال:

https://<SKOOR host>/skoor-webservice/session/login?username=<username>&password=<password>

تسجيل الخروج من API

يرجى تسجيل الخروج دائمًا من API بعد تنفيذ الإجراءات المطلوبة

نقطة النهاية (GET):

/session/logout

المعاملات:

المعامل

الوصف

sessionId

معرّف جلسة SKOOR من طلب تسجيل الدخول للجلسة

مثال:

https://<SKOOR host>/skoor-webservice/session/logout?sessionId=<sessionId>

معاملات التصدير

المعامل

الوصف

dataQueries

تصدير استعلامات البيانات ذات الصلة

files

تصدير الملفات ذات الصلة (مثل الصور)

theme

تصدير السمات ذات الصلة (مثل CSS والألوان)

translations

تصدير إعدادات الترجمة ذات الصلة

sessionId

معرّف جلسة 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>

العثور على معرّف مجموعة لوحات المعلومات

للعثور على معرّف المجموعة، قم بإجراء تصدير يدوي من قائمة المجموعات المطلوبة وحدد خانة الاختيار Plain JSON في مربع حوار التصدير:

image-20240409-100807.png

ثم ابحث عن المفتاح id في سلسلة JSON:

image-20240409-100930.png

تصدير لوحة معلومات واحدة

نقطة النهاية (GET):

/dashboards/{dashboardId}/export

مثال:

https://<SKOOR host>/skoor-webservice/dashboards/10842/export?dataQueries=true&files=true&theme=true&translations=true&sessionId=<sessionId>

العثور على معرّف لوحة المعلومات

كما هو موضح في تصدير مجموعة لوحات المعلومات، يمكن العثور على معرّف لوحة المعلومات في مربع حوار التصدير اليدوي. ابحث عن كائن ذي type dashboard وsubType dashboard للحصول على المفتاح id الصحيح:

image-20240409-101759.png