← بازگشت به فهرست ATP
استخراج سند

جزئیات درخواست استخراج

GET /api/v1/document-extraction-requests/{request_id}/ مشاهده در Swagger

ATP - جزئیات درخواست استخراج (GET /api/v1/document-extraction-requests/{request_id}/)

Endpoint

GET /api/v1/document-extraction-requests/{request_id}/

هدف آزمون

وضعیت درخواست استخراج سند.

شرایط آزمون

فرآیند آزمون

  1. ارسال درخواست GET به /api/v1/document-extraction-requests/{request_id}/
  2. دریافت پاسخ HTTP
  3. بررسی کد وضعیت و بدنه JSON

معرفی ویژگی

این endpoint عملیات «جزئیات درخواست استخراج» را در API Patent Genie انجام می‌دهد.

سناریوی آزمون

سناریو 1: مسیر موفق

  1. ارسال GET /api/v1/document-extraction-requests/{request_id}/
  2. دریافت پاسخ موفق
  3. بررسی ساختار پاسخ

سناریو 2: خطا - درخواست نامعتبر

  1. ارسال درخواست با داده یا شناسه نامعتبر
  2. دریافت کد خطای 4xx
  3. بررسی پیام خطای استاندارد API

قالب API

مولفه نوع نوع داده اجباری توضیحات
بدون پارامتر ورودی

Swagger

get:
  summary: جزئیات درخواست استخراج
  responses:
    200:
      description: عملیات موفق
    401:
      description: احراز هویت نامعتبر یا ناقص

نمونه ورودی

curl -X GET "http://localhost:8000/api/v1/document-extraction-requests/{request_id}/" \
  -H "Authorization: Bearer <access>" \
  -H "Content-Type: application/json"

نمونه خروجی

{
  "success": true,
  "data": {}
}

Status Codes

نتیجه مورد انتظار

در صورت موفقیت، پاسخ JSON استاندارد با کد وضعیت مناسب برای GET برگردانده می‌شود.

روال صحت‌سنجی

  1. بررسی کد وضعیت HTTP
  2. بررسی فیلد success در بدنه
  3. بررسی عدم افشای داده حساس

توضیحات