طريقة "POST /openapi/v1/report"

أنشئ بيانات تقرير عن المستخدمين المسجلين على البوابة الذين يكملون التدريب على برامج ASAP.‏

يتم وصف حجم البيانات التي تم تمريرها في نص الطلب.

طلب

الرأس:

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

النص:

• lng – سلسلة نصية – رمز اللغة للغة المستخدمة في التقرير. تتوافر إحدى لغات الترجمة بتنسيق ISO 639-1. مطلوب. ويشار إليها بأحرف صغيرة.

التعيين بين لغة التقرير وقيمة lng:

• email – مصفوفة – عنوان البريد الإلكتروني للمستخدم. يُستخدم للحصول على بيانات عن مستخدم معين. اختياري.

  المتطلبات على العناوين المشار إليها: 1) يجب الإشارة إليها بأحرف صغيرة، 2) يجب أن تحتوي على الرمزين "@" و ".".

الرد

ملف JSON يحتوي على مصفوفة من البيانات عن كل مستخدم:

• id – سلسلة نصية – المعرّف المعين للموظف على منصة ASAP.‏
• email – سلسلة نصية – عنوان البريد الإلكتروني المستخدم لتسجيل المستخدم.
• shortName – سلسلة نصية – الاسم المختصر المسجل للمستخدم.
• fullName – سلسلة نصية – الاسم الكامل المسجل للمستخدم.
• group – سلسلة نصية – مجموعة التدريب الحالية للمستخدم.
• educationTime – سلسلة نصية – طول التدريب بالثواني.
• mainEducationProgress – سلسلة نصية – فئة الأداء في الدورة الرئيسية.
• expressEducationProgress – سلسلة نصية – فئة الأداء في الدورة السريعة.
• educationStatus – سلسلة نصية – حالة التدريب الحالية.
• mainEducationProgressPercent – نص حر – تقدم التدريب في الدورة الرئيسية، معبرًا عنه كنسبة مئوية بتنسيق xx.xx.‏
• expressEducationProgressPercent – نص حر – تقدم التدريب في الدورة التدريبية السريعة، معبرًا عنه كنسبة مئوية بتنسيق xx.xx.‏
• mainEducationEndPlan – تاريخ – التاريخ المخطط لإكمال الدورة الرئيسية.
• expressEducationEndPlan – تاريخ – التاريخ المخطط لإكمال الدورة السريعة.
• realMainEducationEnd – تاريخ – تاريخ إكمال الدورة الرئيسية.
• realExpressEducationEnd – تاريخ – تاريخ إكمال الدورة السريعة.
• educationMainCourses – مصفوفة – الدورات التدريبية وحالة التدريب في الدورة الرئيسية.

  تنسيق الرد:

  [

  {

  code,‏

  level,‏

  status,‏

  startedAt,‏

  finishedAt

  }

  ]

  حيث:

  • code هو اسم الدورة، الذي يعتمد على لغة الترجمة.
  • level هو مستوى التدريب. تكون القيم التالية ممكنة:
    • 1 – "مبتدئ".
    • 2 – "أساسي".
    • 3 – "متوسط".
    • 4 – "متقدم".
  • status هي حالة التدريب في الدورة. تكون القيم التالية ممكنة:
    • 0 – "تم التعيين". الدورة متاحة للموظف لإكمالها كجزء من مساره التدريبي الفردي الحالي. وستكون الدورة متاحة بعد اكتمال الوحدة الحالية أو بدء التدريب.
    • 1 – "مكتملة". حصل الموظف على شهادة إتمام.
    • 2 – "قيد التنفيذ". يعمل الموظف خلال الدورة كجزء من مساره التدريبي الفردي الحالي.
  • startedAt – التاريخ والوقت الذي بدأ فيه الموظف وحدة التدريب، معبرًا عنه بتنسيق ISO 8601: YYYY-MM-DDThh:mm:ss. يعتمد تنسيق التاريخ (YYYY-MM-DD) على لغة الإدخال.
  • finishedAt – تاريخ ووقت إكمال الوحدة (التي تم استلام الشهادة بشأنها)، بتنسيق ISO 8601: YYYY-MM-DDThh:mm:ss. يعتمد تنسيق التاريخ (YYYY-MM-DD) على لغة الإدخال. إذا كانت البيانات مفقودة، يتم إرجاع قيمة فارغة.

  في حالة عدم وجود بيانات، يتم تكوين مصفوفة فارغة.

• educationExpressCourses – مصفوفة – الدورات التدريبية وحالة التدريب في الدورة السريعة.

  تنسيق الرد:

  [

  {

  code,‏

  level,‏

  status,‏

  startedAt,‏

  finishedAt

  }

  ]

  حيث:

  • code هو اسم الدورة، الذي يعتمد على لغة الترجمة.
  • level هو مستوى التدريب.
  • status هي حالة التدريب في الدورة. تكون القيم التالية ممكنة:
    • 0 – "تم التعيين". الدورة متاحة للموظف لإكمالها كجزء من مساره التدريبي الفردي الحالي.
    • 1 – "مكتملة".

    يجري تنفيذ فحص لتحديد ما إذا كان الاختبار ممكنًا للتدريب الحالي. وفي حالة تمكين الاختبار واجتياز الاختبار الخاص بالوحدة، أو إذا تم تمكين الاختبار وكانت هناك ملاحظة حول اكتساب مهارة، فإن "الحالة" تساوي 1. وبخلاف ذلك، تساوي "الحالة" 0.

  • startedAt – التاريخ والوقت الذي بدأ فيه الموظف وحدة التدريب، معبرًا عنه بتنسيق ISO 8601: YYYY-MM-DDThh:mm:ss. يعتمد تنسيق التاريخ (YYYY-MM-DD) على لغة الإدخال.
  • finishedAt – تاريخ ووقت إكمال الوحدة (التي تم استلام الشهادة بشأنها)، بتنسيق ISO 8601: YYYY-MM-DDThh:mm:ss. يعتمد تنسيق التاريخ (YYYY-MM-DD) على لغة الإدخال. إذا كانت البيانات مفقودة، يتم إرجاع قيمة فارغة.

  في حالة عدم وجود بيانات، يتم تكوين مصفوفة فارغة.

• dateLastActive – تاريخ – تاريخ أحدث نشاط بتنسيق يعتمد على لغة ترجمة الإدخال.
• certificatesReceived – int – العدد الإجمالي للشهادات التي حصل عليها المستخدم أثناء التدريب.

  إذا لم يبدأ المستخدم التدريب أو لم يتلق أي شهادات، فسيتم إرجاع "0".

• phishingAttacks – مصفوفة – معلومات عن هجوم التصيد أثناء التدريب على منصة ASAP.‏

  تنسيق الرد:

  [

  {

  code: '''',

  level: '''', 

  startedAt: '''', 

  phishingAttackLetter: '''', 

  phishingAttackResult: '''',

  followPhishingLinkAt: ''" || null

  }

  ]

  حيث:

  • code هو الاسم المعتمد على اللغة لوحدة التدريب التي تتضمن إرسال بريد إلكتروني للتصيد الاحتيالي.
  • level هو مستوى التدريب. تكون القيم التالية ممكنة:
    • 1 – "مبتدئ".
    • 2 – "أساسي".
    • 3 – "متوسط".
    • 4 – "متقدم".

    ويتم إرجاع قيمة فارغة لرسائل البريد الإلكتروني للتصيد الاحتيالي المرسلة كجزء من حملة التصيد الاحتيالي.

  • startedAt – التاريخ والوقت الذي بدأ فيه الموظف وحدة التدريب، معبرًا عنه بتنسيق ISO 8601: YYYY-MM-DDThh:mm:ss. يعتمد تنسيق التاريخ (YYYY-MM-DD) على لغة الإدخال.
  • phishingAttackLetter هو عنوان البريد الإلكتروني للتصيد الاحتيالي. عند إرسال رسائل بريد إلكتروني للتصيد الاحتيالي باستخدام قالب، يتم استخدام العنوان الذي أدخله المسؤول. ويعتمد العنوان على لغة ترجمة الإدخال.
  • phishingAttackLetter هي نتيجة هجوم التصيد الاحتيالي. تكون القيم التالية ممكنة:
    • 0 – تم إرسال بريد إلكتروني للتصيد الاحتيالي. ويتم حاليًا انتظار رد من المستخدم.
    • 1 - تجنب المستخدم هجوم التصيد الاحتيالي.
    • 2 - وقع المستخدم ضحية للتصيد الاحتيالي.
  • followPhishingLinkAt هو التاريخ والوقت اللذان تم اتباع رابط التصيد الاحتيالي فيهما. ويتم إنشاؤه فقط من أجل "phishingAttackResult": 2. وفي حالات أخرى، يتم إرجاع قيمة فارغة.  

  في حالة عدم وجود بيانات، يتم تكوين مصفوفة فارغة.

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

• 200 – success – نجحت العملية.
• 401 – common-unauthorized – حدث خطأ في المصادقة. 
• 404 – user not found – تم إرسال عنوان بريد إلكتروني غير صالح. 
• 400 bad request – يوجد خطأ في الطلب.
• 500 – internal-server-error – حدث خطأ داخلي في الخادم.