الكائنات

PushDocument

الحقول

• external_idstringمطلوب

  المعرّف الثابت للمستند لديك. إرسال المعرّف نفسه يستبدل المستند.

  length ≤ 512

• titlestringمطلوب

  length ≤ 500

• urlstring

  رابط المستند في نظامك (http أو https).

• contentstring

  المحتوى (حتى 5 ميغابايت).

• content_typestring

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

  القيمة الافتراضية: "html"

• patharray of string | string

  مجلدات المستند: مصفوفة أسماء أو سلسلة نصية مفصولة بالرمز «/» (حتى 10 مستويات).

• permissionsPushPermissions
• tagsarray of string

  items ≤ 50

• author_emailstring

  المؤلف. يصبح المسؤول عن البطاقة إن كان مستخدمًا في Sursa.

• updated_atstring (date-time)

  وقت التعديل في نظامك (جزء من إصدار المستند).

• metadataMetadataPatch

  قيمة metadata لبطاقة المستند (منذ 1.62.0): يحل الكائن محل الكائن السابق في البطاقة، والقيمة {} تزيل كل الأزواج؛ وبلا الحقل metadata لا تتغير البيانات الوصفية للبطاقة.

• categorystring

  فئة البطاقة: مفتاح فئة من فئات المؤسسة (GET /v1/categories)، منذ 1.62.0.

  length ≤ 64

• verifiersPushVerifiers
• verify_interval_daysinteger

  الفاصل الزمني لتوثيق البطاقة بالأيام (منذ 1.62.0)؛ وبدونه يُستخدم الفاصل الزمني للمصدر.

  ≥ 1, ≤ 3650

• upload_idstring

  ملف المستند من رفع متعدد الأجزاء (upl_…، منذ 1.62.0) بدلًا من content. تُستخدم عملية الرفع مرة واحدة؛ وإعادة إرسال المستند نفسه بالقيمة upload_id نفسها لا تستهلكها. ما دام الرفع متعدد الأجزاء غير متاح في التثبيت، يُرفض المستند بالسبب file_rejected.

  length ≤ 64

• attachmentsarray of string

  مرفقات المستند بوصفها عمليات رفع متعدد الأجزاء (upl_…، منذ 1.62.0): يصبح كل مرفق بطاقة مستقلة للمصدر بالمجلد والصلاحيات وحقول البطاقة نفسها. المرفق الغائب عن إصدار جديد من المستند يُؤرشف.

  items ≤ 20

يُستخدم في

• POST/v1/push/sources/{source_id}/documentsإرسال مستند (إنشاء أو استبدال)

جزء من

PushDocumentBatch