انتقل إلى المحتوى
Sursa Developers

الكائنات

CardList

الحقول

array of Card
  • expandedCardExpanded
  • permissionsObjectPermissionList
  • accessstring

    القيم المسموح بها: wholepartial

  • access_contactstring

    الجهة التي يُتواصل معها للحصول على الوصول (فقط عند access=partial).

  • aclobject
    الحقول
    • verifybooleanمطلوب
    • writebooleanمطلوب
  • categorystringمطلوب
  • category_confidencenumber | nullمطلوب
  • category_lockedbooleanمطلوب
  • category_reviewbooleanمطلوب
  • category_sourceCategorySource | nullمطلوب
  • collectionstringمطلوب
  • collection_idintegerمطلوب
  • collection_titlestring
  • commentsarray of CardComment
  • content_jsonContentJSON | null

    محتوى المحرر لأحدث إصدار منشور. قد يغيب الحقل؛ وفي هذه الحالة، احصل على محتوى المحرر من مسودة (POST /v1/drafts مع card_id).

  • editing_lockEditingLock | null

    قفل التحرير النشط. قد يغيب الحقل؛ وفي هذه الحالة، يعرف المحرر من يملك القفل من 409 cards.locked عند POST /v1/cards/{card_id}/lock.

  • created_atstring (date-time)مطلوب
  • days_since_verifiedintegerمطلوب
  • errorstring | nullمطلوب
  • eventsarray of CardEvent
  • feedback_negintegerمطلوب
  • feedback_posintegerمطلوب
  • foldersarray of CardFolderRef

    في قائمة البطاقات فقط: المجلدات التي تحتوي البطاقة (المرئية للمستخدم)، مع مساراتها من جذر المجموعة. القائمة الفارغة تعني أن البطاقة ليست في أي مجلد.

  • has_tablesboolean

    في قائمة البطاقات فقط.

  • hidden_partsboolean
  • idstringمطلوب
  • jobJob | null
  • kindCardKindمطلوب
  • org_idintegerمطلوب
  • owner_activeboolean | null
  • owner_idinteger | nullمطلوب
  • owner_namestring | nullمطلوب
  • pagesinteger | nullمطلوب
  • parserstring | nullمطلوب

    أداة قراءة المستند بوصفها رمزًا محايدًا: document (البنية الكاملة: الصفحات، والعناوين، والجداول، والصفحات المصوَّرة)، وpdf (طبقة النص في PDF)، وdocx، وxlsx، وcsv، وmarkdown، وhtml، وtext. قد تتوسع القائمة.

  • partsarray of CardPartمطلوب
  • sensitivebooleanمطلوب
  • sha256string | nullمطلوب
  • sizeintegerمطلوب
  • snoozed_atstring (date-time) | null
  • snoozed_byinteger | null
  • snoozed_untilstring | null
  • source_changedbooleanمطلوب
  • source_pathstring | nullمطلوب
  • source_urlstring | nullمطلوب
  • statusstringمطلوب

    القيم المسموح بها: processingreadyerrorarchived

  • tablesarray of CardTable
  • tagsarray of stringمطلوب
  • titlestringمطلوب
  • trustnumberمطلوب
  • trust_if_verifiednumber
  • trust_partsTrustPartsمطلوب
  • updated_atstring (date-time)مطلوب
  • verificationVerificationمطلوب
  • verified_atstring (date-time) | nullمطلوب
  • verified_byinteger | nullمطلوب
  • verified_by_namestring | null
  • verifier_idsarray of integerمطلوب
  • verifiersarray of object
    الحقول
    • activebooleanمطلوب
    • idintegerمطلوب
    • namestringمطلوب
  • verify_interval_daysintegerمطلوب
  • versionintegerمطلوب
  • versionsarray of CardVersion
  • source_archiveArchiveSource
  • created_byinteger | null
  • manual_optionsobject

    إعدادات القراءة اليدوية (المعاينة).

  • doc_kindDocKind | null

    نوع المستند. القيمة null إن لم يُحدَّد النوع (مثلًا للبطاقات التي فُهرست قبل إدخال أنواع المستندات).

  • doc_kind_confidencenumber | null

    درجة الثقة في نوع المستند، من 0 إلى 1.

  • doc_kind_sourcestring | null

    ما حدّد النوع: القواعد (rules)، أو مستخدم (manual)، أو التصنيف التلقائي. قد تتوسع القائمة: تعامل مع القيمة غير المعروفة على أنها تصنيف تلقائي.

    القيم المسموح بها: rulesmanualnull

  • invoiceDocInvoiceExtraction | null

    حقول الفاتورة أو الإشعار الدائن أو الإيصال (لهذه الأنواع فقط، وفي البطاقة فقط، لا في القائمة). القيمة null إن لم يكن لديك وصول إلى المستند كاملًا، لأن الحقول تُستخرج من المستند كاملًا.

  • warningsarray of ReviewWarning

    تحذيرات قراءة المستند (ReviewWarning؛ في البطاقة فقط، لا في القائمة).

  • enrichmentCardEnrichmentStatus | null

    حالة الإثراء (في البطاقة فقط، لا في القائمة). يُضاف نوع المستند وحقول الفاتورة والسجلات المالية في الخلفية بعد الفهرسة، ويمكن إعادة حسابها لاحقًا؛ وتظهر في البطاقة حين تجهز. القيمة null تعني أنه لا تتوفر حالة (فُهرست البطاقة بلا إثراء في الخلفية).

  • external_idstring | null

    معرّف البطاقة في نظام جهة التكامل. وهو فريد في المؤسسة بين البطاقات التي لا تأتي من مصادر؛ والقيمة null تعني أنه غير محدد. تقرأ /v1/cards-by-external-id/{external_id} البطاقة وتستبدلها به.

    length ≤ 512

  • metadataMetadata

يُستخدم في