REST Resource: courses.aliases

المورد: الاسم المستعار للدورة التدريبية

المعرّف البديل للدورة التدريبية.

يحدد الاسم المستعار دورة تدريبية فريدة. ويجب أن يكون فريدًا ضمن أحد النطاقات التالية:

  • النطاق: يظهر الاسم المستعار على مستوى النطاق لجميع المستخدمين ضمن نطاق منشئ الاسم المستعار ولا يمكن إنشاؤه إلا بواسطة مشرف النطاق. غالبًا ما يتم استخدام اسم مستعار على مستوى النطاق عندما يكون للدورة التدريبية معرّف خارج Classroom.

  • المشروع: يكون الاسم المستعار على نطاق المشروع مرئيًا لأي طلب من تطبيق باستخدام رقم تعريف مشروع وحدة تحكم مطوّر البرامج الذي أنشأ الاسم المستعار ويمكن إنشاؤه بواسطة أي مشروع. غالبًا ما يتم استخدام اسم مستعار على نطاق المشروع عندما يكون للتطبيق معرّفات بديلة. ويمكن أيضًا استخدام قيمة عشوائية لتجنُّب الدورات التدريبية المكرَّرة في حال تعذُّر النقل، لأن إعادة محاولة تقديم الطلب ستعرض ALREADY_EXISTS في حال نجاح طلب سابق.

تمثيل JSON
{
  "alias": string
}
الحقول
alias

string

سلسلة الاسم المستعار. يشير تنسيق السلسلة إلى نطاق الاسم المستعار المطلوب.

  • تشير السمة d:<name> إلى اسم مستعار على نطاق النطاق. مثال: d:math_101
  • تشير القيمة p:<name> إلى اسم مستعار على نطاق المشروع. مثال: p:abc123

يبلغ الحد الأقصى لطول هذا الحقل 256 حرفًا.

الطُرق

create

لإنشاء اسم مستعار لدورة تدريبية.

delete

لحذف اسم مستعار لدورة تدريبية.

list

لعرض قائمة الأسماء المستعارة لدورة تدريبية.