الكائنات
Error
استجابة الخطأ القياسية. الحقل detail سلسلة نصية، أو كائن فيه code (مثل choose_org، وorg_suspended، ورموز الدعوات)، أو قائمة أخطاء صحة البيانات (422). والحقل error وصف منظَّم: رمز من كتالوج الأخطاء، ورسالة بالإنجليزية، وتفاصيل منظَّمة، ومعرّف الطلب.
الحقول
رسالة الخطأ، أو كائن فيه رمز، أو قائمة أخطاء صحة البيانات.
errorErrorInfo
يُستخدم في
- GET
/v1/healthالحصول على حالة الخدمة وإصدارها - GET
/v1/usersعرض قائمة مستخدمي المؤسسة - POST
/v1/usersإنشاء مستخدم - PATCH
/v1/users/{user_id}تعديل مستخدم - GET
/v1/api-keysعرض قائمة مفاتيح API للمؤسسة - POST
/v1/api-keysإنشاء مفتاح API - DELETE
/v1/api-keys/{key_id}إبطال مفتاح API - PATCH
/v1/api-keys/{key_id}تعديل مفتاح API - POST
/v1/api-keys/{key_id}/rollإعادة إصدار مفتاح API - POST
/v1/api-keys/{key_id}/revoke-previousإبطال القيمة السابقة لمفتاح API - GET
/v1/auditعرض قائمة إدخالات سجل التدقيق - GET
/v1/audit/actionsعرض إجراءات سجل التدقيق مع أعدادها - GET
/v1/audit/export.csvتصدير سجل التدقيق بصيغة CSV - GET
/v1/orgالحصول على بيانات المؤسسة - GET
/v1/categoriesعرض قائمة فئات المستندات - POST
/v1/categoriesإنشاء فئة - DELETE
/v1/categories/{key}حذف فئة مخصصة - PATCH
/v1/categories/{key}تعديل فئة - GET
/v1/collectionsعرض قائمة المجموعات المتاحة للمستخدم - POST
/v1/collectionsإنشاء مجموعة - DELETE
/v1/collections/{name}حذف مجموعة - PATCH
/v1/collections/{name}تعديل مجموعة - POST
/v1/collections/{name}/reindexإعادة فهرسة مجموعة - GET
/v1/collections/{name}/statsالحصول على نظرة عامة على المجموعة: الإحصاءات، والفئات، والبطاقات الأخيرة، والصلاحيات - GET
/v1/cardsعرض قائمة البطاقات - POST
/v1/cardsرفع ملف بوصفه بطاقة - GET
/v1/jobsعرض قائمة مهام الفهرسة - GET
/v1/jobs/summaryالحصول على ملخص قائمة الانتظار - GET
/v1/jobs/streamبث تغييرات مهام المعالجة (SSE) - GET
/v1/jobs/{job_id}الحصول على مهمة معالجة - DELETE
/v1/jobs/{job_id}إلغاء مهمة معالجة في قائمة الانتظار - GET
/v1/cards/countعدّ البطاقات - GET
/v1/cards/export.xlsxتصدير قائمة البطاقات إلى XLSX - POST
/v1/cards/bulkتنفيذ إجراء جماعي على البطاقات - GET
/v1/cards/{card_id}الحصول على بطاقة مع إصداراتها وتعليقاتها وجداولها وأحداثها - DELETE
/v1/cards/{card_id}حذف بطاقة - PATCH
/v1/cards/{card_id}تعديل بطاقة - GET
/v1/cards-by-external-id/{external_id}الحصول على بطاقة بالمعرّف الخارجي - PUT
/v1/cards-by-external-id/{external_id}إنشاء بطاقة أو استبدالها بالمعرّف الخارجي - GET
/v1/cards/{card_id}/contentالحصول على نص البطاقة مقسَّمًا حسب الأقسام - PUT
/v1/cards/{card_id}/contentاستبدال محتوى بطاقة - GET
/v1/cards/{card_id}/tables/{table_id}/rowsعرض صفوف جدول حقائق - GET
/v1/cards/{card_id}/versions/{a}/diff/{b}مقارنة إصدارين من بطاقة - GET
/v1/cards/{card_id}/usageعرض الأسئلة التي استخدمت إجاباتها البطاقة - POST
/v1/cards/{card_id}/usageتسجيل حدث استخدام بطاقة - POST
/v1/cards/{card_id}/reindexإعادة فهرسة بطاقة - DELETE
/v1/cards/{card_id}/comments/{comment_id}حذف تعليق - GET
/v1/cards/{card_id}/fileتنزيل الملف الأصلي لبطاقة - GET
/v1/cards/{card_id}/exportتصدير بطاقة إلى مستند - POST
/v1/cards/{card_id}/verifyتأكيد أن البطاقة محدَّثة - POST
/v1/cards/{card_id}/commentsإضافة تعليق - GET
/v1/conversationsعرض قائمة المحادثات - GET
/v1/conversations/{conv_id}الحصول على محادثة مع مداخلاتها - POST
/v1/searchالبحث في المجموعات - POST
/v1/askالحصول على إجابة المساعد دون تدفق - POST
/v1/chatبث إجابة المساعد (SSE) - POST
/v1/questions/{question_id}/feedbackتقييم إجابة - GET
/v1/questions/export.csvتصدير سجل الأسئلة إلى CSV - GET
/v1/questions/{question_id}الحصول على سؤال محفوظ مع إجابته - GET
/v1/questions/{question_id}/followupsالحصول على أسئلة المتابعة المقترحة - GET
/v1/questionsعرض سجل الأسئلة - GET
/v1/questions/{question_id}/exportتصدير إجابة إلى مستند - GET
/v1/questions/{question_id}/datasets/{dataset_id}/exportتصدير مجموعة بيانات من إجابة - GET
/v1/questions/{question_id}/answer-tables/{index}/exportتصدير جدول من نص الإجابة - POST
/v1/questions/{question_id}/refreshتحديث مجموعات بيانات إجابة (إجابة حية) - POST
/v1/questions/{question_id}/save-cardحفظ إجابة بوصفها بطاقة - POST
/v1/cards/textإنشاء بطاقة نصية (Markdown) - GET
/v1/filesعرض قائمة ملفات التصدير - GET
/v1/files/authorsعرض مؤلفي الملفات (لعامل تصفية المشرف) - GET
/v1/files/{file_id}الحصول على تفاصيل ملف - DELETE
/v1/files/{file_id}حذف ملف - GET
/v1/files/{file_id}/downloadتنزيل ملف - GET
/v1/files/{file_id}/previewمعاينة ملف - POST
/v1/files/{file_id}/extendتمديد مدة الاحتفاظ بملف - POST
/v1/files/{file_id}/regenerateإعادة إنشاء ملف من معاملاته المحفوظة - GET
/v1/tasksعرض مهام مستخدم أو فريق - POST
/v1/sourcesإنشاء مصدر - GET
/v1/sources/{source_id}الحصول على مصدر - DELETE
/v1/sources/{source_id}حذف مصدر - PATCH
/v1/sources/{source_id}تعديل مصدر - PATCH
/v1/sources/{source_id}/settingsتعديل إعدادات المصدر - GET
/v1/cards/{card_id}/similarعرض البطاقات المشابهة - GET
/v1/insights/gapsعرض ثغرات المعرفة (تجمّعات الأسئلة التي لم تُجب) - GET
/v1/permissionsعرض سجل الصلاحيات - POST
/v1/uploadsبدء رفع متعدد الأجزاء - GET
/v1/uploads/{upload_id}الحصول على عملية رفع - DELETE
/v1/uploads/{upload_id}إلغاء عملية رفع - PUT
/v1/uploads/{upload_id}/parts/{n}إرسال جزء من عملية رفع - POST
/v1/uploads/{upload_id}/completeإكمال عملية رفع - GET
/v1/meالحصول على الجهة المستدعية لواجهة API - GET
/v1/me/permissionsالحصول على صلاحيات المستخدم الحالي على المؤسسة - GET
/v1/rolesعرض الأدوار (المدمجة والمخصصة) - POST
/v1/rolesإنشاء دور مخصص - DELETE
/v1/roles/{role_id}حذف دور مخصص - PATCH
/v1/roles/{role_id}تعديل دور مخصص - GET
/v1/groupsعرض مجموعات المستخدمين في المؤسسة - POST
/v1/groupsإنشاء مجموعة مستخدمين - GET
/v1/groups/{group_id}الحصول على مجموعة مستخدمين مع أعضائها - DELETE
/v1/groups/{group_id}حذف مجموعة مستخدمين - PATCH
/v1/groups/{group_id}إعادة تسمية مجموعة مستخدمين - PUT
/v1/groups/{group_id}/members/{user_id}إضافة عضو إلى مجموعة مستخدمين - DELETE
/v1/groups/{group_id}/members/{user_id}إزالة عضو من مجموعة مستخدمين - GET
/v1/org/permissionsالحصول على الصلاحيات على المؤسسة (من هم المشرفون) - PUT
/v1/org/permissionsإسناد أدوار على المؤسسة - DELETE
/v1/org/permissionsسحب أدوار على المؤسسة - GET
/v1/collections/{name}/permissionsالحصول على الصلاحيات على مجموعة (المباشرة والموروثة) - PUT
/v1/collections/{name}/permissionsإسناد أدوار على مجموعة - DELETE
/v1/collections/{name}/permissionsسحب أدوار على مجموعة - GET
/v1/cards/{card_id}/permissionsالحصول على الصلاحيات على بطاقة (المباشرة والموروثة) - PUT
/v1/cards/{card_id}/permissionsإسناد أدوار على بطاقة - DELETE
/v1/cards/{card_id}/permissionsسحب أدوار على بطاقة - GET
/v1/sources/{source_id}/permissionsالحصول على الصلاحيات على مصدر (المباشرة والموروثة) - PUT
/v1/sources/{source_id}/permissionsإسناد أدوار على مصدر - DELETE
/v1/sources/{source_id}/permissionsسحب أدوار على مصدر - POST
/v1/users/{user_id}/offboardإخراج مستخدم من المؤسسة - GET
/v1/collections/{name}/foldersالحصول على شجرة مجلدات مجموعة - POST
/v1/collections/{name}/foldersإنشاء مجلد - GET
/v1/foldersالحصول على أشجار مجلدات كل المجموعات - GET
/v1/folders/{folder_id}الحصول على مجلد - DELETE
/v1/folders/{folder_id}حذف مجلد ورفع محتواه إلى المستوى الأعلى - PATCH
/v1/folders/{folder_id}إعادة تسمية مجلد أو نقله أو تغيير ترتيبه - GET
/v1/folders/{folder_id}/cardsعرض بطاقات مجلد - GET
/v1/folders/{folder_id}/permissionsالحصول على الصلاحيات على مجلد (المباشرة والموروثة) - PUT
/v1/folders/{folder_id}/permissionsإسناد أدوار على مجلد - DELETE
/v1/folders/{folder_id}/permissionsسحب أدوار على مجلد - GET
/v1/catalog/servicesعرض الخدمات في الدليل - GET
/v1/catalog/services/{service_id}الحصول على خدمة من الدليل - GET
/v1/catalog/services/{service_id}/iconالحصول على أيقونة خدمة - GET
/v1/catalog/categoriesعرض فئات الدليل - GET
/v1/catalog/spend-taxonomyالحصول على تصنيف النفقات والإيرادات - POST
/v1/catalog/resolveمطابقة الأسماء مع خدمات الدليل - GET
/v1/draftsعرض المسودات - POST
/v1/draftsإنشاء مسودة - GET
/v1/drafts/{draft_id}الحصول على مسودة - PATCH
/v1/drafts/{draft_id}تعديل مسودة - POST
/v1/drafts/{draft_id}/request-publishطلب النشر - POST
/v1/drafts/{draft_id}/approveاعتماد النشر - GET
/v1/tagsعرض وسوم بطاقات المؤسسة - POST
/v1/cards/archiveرفع أرشيف مستندات - GET
/v1/archives/{job_id}الحصول على مهمة استخراج أرشيف - GET
/v1/cards/{card_id}/verificationالحصول على قسم التوثيق لبطاقة - POST
/v1/cards/{card_id}/verification/verifyتوثيق بطاقة - POST
/v1/cards/{card_id}/verification/unverifyسحب الثقة أو تذكير الموثِّق - PUT
/v1/cards/{card_id}/verification/verifiersتحديد موثِّقي بطاقة - PUT
/v1/cards/{card_id}/verification/intervalتغيير نوع التوثيق وموعد المراجعة - GET
/v1/verification/queueالحصول على قائمة انتظار التوثيق - GET
/v1/collections/{name}/trustالحصول على مؤشر الثقة لمجموعة - GET
/v1/org/trustالحصول على مؤشر الثقة للمؤسسة - GET
/v1/announcementsعرض الإعلانات - POST
/v1/announcementsإرسال إعلان للقراءة الإلزامية - GET
/v1/announcements/{announcement_id}الحصول على إعلان - GET
/v1/announcements/{announcement_id}/statsالحصول على تقرير الإعلان - POST
/v1/announcements/{announcement_id}/remindتذكير من لم يقرأ - GET
/v1/cards/{card_id}/threadsعرض سلاسل تعليقات بطاقة - POST
/v1/cards/{card_id}/threadsإضافة تعليق أو رد في سلسلة - DELETE
/v1/cards/{card_id}/threads/{comment_id}حذف تعليق مع ردوده - PATCH
/v1/cards/{card_id}/threads/{comment_id}تعديل النص أو إغلاق سلسلة أو إعادة فتحها - GET
/v1/openapi-public.jsonالحصول على مواصفة OpenAPI العامة - GET
/v1/webhooksعرض خطافات الويب للمؤسسة - POST
/v1/webhooksإنشاء خطاف ويب - GET
/v1/webhooks/catalogعرض أنواع الأحداث - GET
/v1/webhooks/{webhook_id}الحصول على خطاف ويب - DELETE
/v1/webhooks/{webhook_id}حذف خطاف ويب - PATCH
/v1/webhooks/{webhook_id}تعديل خطاف ويب - POST
/v1/webhooks/{webhook_id}/testإرسال حدث تجريبي - POST
/v1/webhooks/{webhook_id}/rotate-secretتدوير سر التوقيع - POST
/v1/webhooks/{webhook_id}/revoke-previous-secretإبطال السر السابق - POST
/v1/webhooks/{webhook_id}/resumeاستئناف خطاف ويب - POST
/v1/webhooks/{webhook_id}/redeliverإعادة تسليم التسليمات لفترة - GET
/v1/webhooks/{webhook_id}/attemptsعرض محاولات التسليم - GET
/v1/webhooks/{webhook_id}/deliveriesعرض تسليمات خطاف الويب - GET
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}الحصول على تسليم مع النصوص والمحاولات - POST
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}/redeliverإعادة تسليم حدث - GET
/v1/webhook-eventsعرض الأحداث - GET
/v1/webhook-events/{event_id}الحصول على حدث - GET
/v1/api-usageالحصول على استخدام API - GET
/v1/api-logsعرض طلبات API - GET
/v1/api-logs/{request_id}الحصول على طلب API - GET
/v1/appsعرض تطبيقات OAuth - POST
/v1/appsإنشاء تطبيق OAuth - GET
/v1/apps/{app_id}الحصول على تطبيق OAuth - DELETE
/v1/apps/{app_id}حذف تطبيق OAuth - PATCH
/v1/apps/{app_id}تعديل تطبيق OAuth - POST
/v1/apps/{app_id}/rotate-secretتدوير سر العميل - GET
/v1/app-authorizationsعرض تخويلات التطبيقات - DELETE
/v1/app-authorizations/{authorization_id}إبطال تخويل موظف - GET
/v1/analytics/healthالحصول على لوحة معلومات صحة المعرفة - GET
/v1/analytics/usageالحصول على لوحة معلومات الاستخدام - GET
/v1/analytics/contributionالحصول على لوحة المساهمات - GET
/v1/analytics/cards/{card_id}الحصول على مقاييس بطاقة - GET
/v1/audit/verifyالتحقق من سلامة سجل التدقيق للمؤسسة - POST
/v1/users/importاستيراد المستخدمين من CSV - GET
/v1/quality/gaps/followupsعرض ثغرات المعرفة قيد العمل - POST
/v1/quality/gaps/followupsأخذ ثغرة معرفية للعمل عليها - PATCH
/v1/quality/gaps/followups/{followup_id}تعديل ثغرة معرفية قيد العمل - GET
/v1/access-requestsعرض طلبات الوصول الخاصة أو الواردة - GET
/v1/access-requests/{request_id}الحصول على طلب وصول لصاحب القرار - POST
/v1/access-requests/{request_id}/grantمنح الوصول بناءً على طلب - POST
/v1/access-requests/{request_id}/denyرفض الوصول - POST
/v1/finance/reportالحصول على تقرير مالي موجز - POST
/v1/finance/report/exportتصدير التقرير المالي الموجز - POST
/v1/finance/invoicesعرض الفواتير - POST
/v1/finance/invoices/exportتصدير قائمة الفواتير - POST
/v1/finance/paymentsعرض المدفوعات - POST
/v1/finance/payments/exportتصدير قائمة المدفوعات - GET
/v1/sources/{source_id}/push-keysعرض مفاتيح API لمصدر مخصص - POST
/v1/sources/{source_id}/push-keysإنشاء مفتاح API لمصدر مخصص - DELETE
/v1/sources/{source_id}/push-keys/{key_id}إبطال مفتاح API لمصدر مخصص - GET
/v1/sources/{source_id}/push-syncsعرض جلسات مزامنة مصدر مخصص - GET
/v1/push/sources/{source_id}التحقق من المفتاح والحصول على حالة مصدر مخصص - POST
/v1/push/sources/{source_id}/syncsفتح جلسة مزامنة - GET
/v1/push/sources/{source_id}/syncs/{sync_number}الحصول على جلسة مزامنة - GET
/v1/push/sources/{source_id}/syncs/{sync_number}/documentsعرض نتائج المستندات في جلسة مزامنة - POST
/v1/push/sources/{source_id}/syncs/{sync_number}/closeإغلاق جلسة مزامنة - POST
/v1/push/sources/{source_id}/syncs/{sync_number}/touchتأكيد المستندات دون إرسالها مرة أخرى - POST
/v1/push/sources/{source_id}/documentsإرسال مستند (إنشاء أو استبدال) - POST
/v1/push/sources/{source_id}/documents/batchإرسال دفعة من المستندات - GET
/v1/push/sources/{source_id}/documents/{external_id}الحصول على نتيجة مستند - DELETE
/v1/push/sources/{source_id}/documents/{external_id}حذف مستند