تخطَّ إلى المحتوى
مرجع API
مرجع API

كائن الدُّفعة

دفعة إشراف نطاقها الحساب، تُبلَّغ دورة تنفيذها عبر Batch API المتوافق.

دفعة إشراف نطاقها الحساب، تُبلَّغ دورة تنفيذها عبر Batch API المتوافق.

01

حقول الكائن

نص JSON

الحقول الثابتة المشتركة بواسطة الكائن القابل لإعادة الاستخدام الخاص بالمورد.

الدُّفعات23 حقل
cancelled_atinteger | null
اختياري

الطابع الزمني Unix عند إلغاء الدُفعة.

cancelling_atinteger | null
اختياري

الطابع الزمني Unix عند بدء الإلغاء.

completed_atinteger | null
اختياري

الطابع الزمني Unix عند اكتمال الدُفعة.

completion_windowstring
مطلوب

نافذة الإكمال للدُّفعة.

created_atinteger
مطلوب

الطابع الزمني Unix عند إنشاء الدُفعة.

endpointstring
مطلوب

نقطة نهاية الإشراف التي تعالجها الدُّفعة.

error_file_idstring | null
اختياري

معرّف ملف الخطأ في RunAPI

errorsobject | null
اختياري

أخطاء التحقق أو التنفيذ في الدُّفعة

expired_atinteger | null
اختياري

الطابع الزمني Unix عند انتهاء صلاحية الدُفعة.

expires_atinteger | null
اختياري

الطابع الزمني Unix عند انتهاء صلاحية الدُفعة.

failed_atinteger | null
اختياري

الطابع الزمني Unix عند فشل الدُفعة.

finalizing_atinteger | null
اختياري

الطابع الزمني Unix عند دخول الدُفعة مرحلة الإنهاء.

idstring
مطلوب

معرّف الدُّفعة في RunAPI.

in_progress_atinteger | null
اختياري

الطابع الزمني Unix عند بدء معالجة الدُفعة.

input_file_idstring
مطلوب

معرّف ملف الإدخال في RunAPI.

metadataobject
مطلوب

بيانات وصفية للمُستدعي تُعاد مع الدُّفعة.

objectstring
مطلوب

نوع الكائن.

output_file_idstring | null
اختياري

معرّف ملف الإخراج في RunAPI

request_countsobject
مطلوب
request_counts.completedinteger
مطلوب
request_counts.failedinteger
مطلوب
request_counts.totalinteger
مطلوب
statusstring
مطلوب

حالة دورة حياة الدُّفعة.

القيم المسموح بها: validating, failed, in_progress, finalizing, completed, expired, cancelling, cancelled