طريقة "GET /openapi/v1/groups"

19 أبريل 2024

ID 242751

الحصول على قائمة المجموعات المتاحة لهذه الشركة.

طلب

الرأس:

  • المصادقة – الرمز المميز لواجهة برمجة التطبيقات الخاصة بالشركة.

الرد

  • totalرقم – عدد المجموعات المتوفرة في الشركة.
  • resultمصفوفة – مصفوفة من الكائنات مع بيانات عن المجموعات المتاحة.
    • idسلسلة نصية – معرّف المجموعة.
    • nameسلسلة نصية – اسم المجموعة.
    • isStartedقيمة منطقية – تشير إلى ما إذا كان التدريب قد بدأ في المجموعة.

مثال على رد:

{

    total: 1,

    result: [{

        id: '627d5c63f0672a10fbac23bb',

        name: 'Low risk',

        isStarted: true

    }]

}

الأخطاء المحتملة:

  • 401 - common-unauthorized - حدث خطأ في المصادقة.
  • 404groups-not-found – لم يتم العثور على مجموعة مرتبطة بهذا الرمز المميز للشركة.
  • 429too-many-requests – كان هناك الكثير من الطلبات.
  • 500internal-server-error – حدث خطأ داخلي في الخادم.

هل وجدت هذه المقالة مفيدة؟
ما الذي يمكننا تحسينه؟
شكرًا لك على ملاحظاتك! تساعدُنا على التحسن.
شكرًا لك على ملاحظاتك! تساعدُنا على التحسن.