نتیجه عملیات دسته‌ای GET {BASE_URL}/ingestionapi/api/v{version}/data/catalogs/batch/{trackId}

توضیح

با توجه به اینکه تمامی APIهای «ارسال دسته‌ای»، «ویرایش دسته‌ای» و «حذف دسته‌ای» به صورت غیر همزمان (async) پیاده‌سازی شده‌اند، به کمک این API می‌توان نتیجه اجرای آنها را دریافت کرد. لازم به ذکر است با توجه به اینکه عملیات دسته‌ای ممکن است به میزان پردازش بالایی نیاز داشته باشد، اگر این API بلافاصله پس از اجرای عملیات دسته‌ای فراخوانی شود، ممکن است خطای ۴۰۴ را در خروجی گزارش کند. در این حالت لازم است پس از گذشت مدت زمانی، دوباره تلاش کنید. ضمن اینکه می‌توانید وضعیت عملیات دسته‌ای را از طریق پنل آبی رنگ، قسمت نتیجه عملیات و بخش پیگیری عملیات مشاهده کنید.

پارامترها
ردیف پارامتر مقدار پیشفرض توضیحات ضروری نوع
۱ catalogId ندارد شناسه اختصاصی کاتالوگ مورد نظر بله string
۲ trackId ندارد شناسه یکتایی که در خروجی APIهای دسته‌ای برگردانده می‌شود. بله string
نمونه درخواست
curl -X GET "{BASE_URL}/ingestionapi/api/v{version}/data/batch/{trackId}"
Shell
خروجی موفق

در صورت اجرای موفقیت‌آمیز نتیجه اجرای عملیات دسته‌ای به صورت زیر در خروجی آورده می‌شود:

{
    "summary": {
        "trackId": "a9e2ab24-36c1-4557-be31-95945f9beb45",
        "catalogId": "fceef942-dd26-40a3-9424-537b305e8d45",
        "sourceCategory": "Dolphin",
        "requestedAt": "2021-06-19T10:21:31.543107Z",
        "completedAt": "2021-06-19T10:21:32.742291Z",
        "action": "INSERT",
        "totalDocuments": 2,
        "errorCount": 2,
        "successCount": 0,
        "isSuccess": true
    }
}
JSON

در صورتیکه در عملیات دسته‌ای برای هیچ‌یک از داکیومنت‌ها خطایی رخ نداده باشد، فیلد errors خالی خواهد بود.

اگر کل عملیات با خطا مواجه شده باشد (خطای داخلی سرور) مقدار فیلد isSuccess برابر False خواهد بود. در این حالت با شماره شرکت دلفین تماس بگیرید.

کدهای خطا
ردیف کد خطا توضیحات
۱ ۴۰۴ ممکن است یکی از این دو حالت رخ بدهد: یا پردازشی با این شناسه پیدا نشده است. و یا اینکه پردازش با این شناسه هنوز به پایان نرسیده است که در این حالت لازم است دوباره تلاش کنید.