اورکا : لوگو

ویرایش داده PUT {BASE_URL}/ingestionapi/api/v{version}/catalogs/{catalogId}/{docId}

توضیح

این API برای ویرایش داکیومنتی که قبلاً ارسال شده است استفاده می‌شود. پیدا‌کردن داکیومنت بر اساس کلید یکتای موجود در فیلد doc انجام می‌شود. مشابه «ارسال داده» کلید یکتا باید در فیلد doc حضور داشته باشد. 

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

Shell
خروجی موفق 
StatusCode: 200
کدهای خطا
ردیف کد خطا توضیحات
۱ ۴۰۰ ساختار json معتبر نیست.
فیلد کلید یکتا در بدنه doc وجود ندارد یا مقدار آن خالی است یا نوع آن رشته نیست.
نمونه خروجی در صورت بروز خطا
{
    "indexName": "dataindex",
    "errorType": "document_missing_exception",
    "errorReason": "[_doc][website_41]: document missing",
    "documentId": "123",
    "operation": "update",
    "status": 400
}
۲ ۴۰۴ در صورتی که شناسه کاتالوگ صحیح نباشد.