اورکا : لوگو

ارسال داده POST {BASE_URL}/ingestionapi/api/v{version}/data/catalogs/{catalogId}/{docId}

توضیح

این API برای ارسال یک داکیومنت‌ها (رکورد) استفاده می‌شود. پیش از فراخوانی این API باید حداقل یک کاتالوگ ایجاد و از بخش آبی رنگ پنل، قسمت انتقال داده و بخش تنظیمات RESTful، فیلد کلید داده‌های خود را معرفی کرده باشید (فیلدی که مقادیر آن برای تمامی اسناد یکتا باشد). مثلاً اگر نام فیلد کلید شما id است، حتما باید در داکیومنت ارسالی حضور داشته باشد: 

{
    "id":"a-unique-identifier"
    ...
}
پارامترها
ردیف پارامتر مقدار پیشفرض توضیحات ضروری نوع
۱ catalogId ندارد شناسه اختصاصی کاتالوگ مورد نظر. پیش از فراخوانی این API باید حداقل یک کاتالوگ ایجاد کرده باشید. شناسه کاتالوگ مورد نظر را می‌توانید در قسمت مدیریت کاتالوگ‌ها و با انتخاب کاتالوگ مورد نظر، از بخش تنظیمات پایه و شناسه اختصاصی کاتالوگ پیدا کنید. بله string
۲ docId ندارد شناسه یکتای داکیومنت که باید یکتا باشد. بله string
۳ محتوای درخواست ندارد داده مورد نظر در قالب JSON که باید حتما شامل فیلد کلید یکتای داده‌ها در قالب رشته باشد. این فیلد یکتا باید پیش از فراخوانی API در بخش آبی رنگ پنل، قسمت انتقال داده و بخش تنظیمات RESTful تعریف شده باشد. بله json
نمونه درخواست 
curl -X POST "{BASE_URL}/ingestionapi/api/v{version}/data/catalogs/{catalogId}/{docId}" --header 'Content-Type: application/json' \
--data-raw '{
        "id": "123",
        "name": "Sunglass",
        "price": 1000
}'

Shell
خروجی موفق 
StatusCode: 200
کدهای خطا
ردیف کد خطا توضیحات
۱ ۴۰۰ ساختار json معتبر نیست. فیلد کلید یکتا در بدنه doc وجود ندارد یا مقدار آن خالی است یا نوع آن رشته نیست.
۲ ۴۰۹ داکیومنتی با فیلد یکتای تکراری وجود دارد. نمونه خروجی در صورت بروز خطا
{
    "indexName": "dataindex",
    "errorType": "version_conflict_engine_exception",
    "errorReason": "[website_123]: version conflict, document already exists (current version [1])",
    "documentId": "123",
    "operation": "create",
    "status": 409
}