حذف دسته‌ای داده‌ها DELETE {BASE_URL}/ingestionapi/api/v{version}/data/catalogs/{catalogId}/batch
توضیح
این API برای حذف لیستی از داکیومنت‌هایی که قبلاً ارسال شده‌اند، استفاده می‌شود. پیدا کردن داکیومنت بر اساس کلید یکتای موجود در فیلد docIds انجام می‌شود.
["123", "102", "777"]
پارامترها
| ردیف | پارامتر | مقدار پیشفرض | توضیحات | ضروری | نوع |
| ۱ | catalogId | ندارد | شناسه اختصاصی کاتالوگ مورد نظر. پیش از فراخوانی این API باید حداقل یک کاتالوگ ایجاد کرده باشید. شناسه کاتالوگ مورد نظر را می‌توانید در قسمت مدیریت کاتالوگ‌ها و با انتخاب کاتالوگ مورد نظر، از بخش تنظیمات پایه و شناسه اختصاصی کاتالوگ پیدا کنید. | بله | string |
| ۲ | محتوای درخواست | ندارد | این فیلد لیستی از کلیدهای یکتای داکیومنت‌های موردنظر را به صورت آرایه مشخص می‌کند. | بله | string |
نمونه درخواست
curl -X DELETE "{BASE_URL}/ingestionapi/api/v{version}/data/catalogs/{catalogId}/batch" --header 'Content-Type: application/json' \
--data-raw '["123", "102", "777"]'
Shell
خروجی موفق
در صورت ارسال موفقیت‌آمیز اطلاعات، شناسه‌ای (trackId) برای اطلاع از نتیجه اجرای درخواست بازگردانده می‌شود که از این شناسه در فراخوانی API مربوط به دریافت «نتیجه عملیات دسته‌ای» استفاده خواهد شد.
{
"trackId": "fc442947-318c-44b4-9aa2-f8f672c6b1ea"
}
JSON
کدهای خطا
| ردیف | کد خطا | توضیحات |
| ۱ | ۴۰۰ | در صورتی که ساختار هر یک از مقادیر به صورت اشتباه به API فرستاده شده باشد. |
| ۲ | ۴۰۴ | در صورتی که شناسه کاتالوگ صحیح نباشد. |