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

جزئیات job استخراج (alias)

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

ATP - جزئیات job استخراج (alias) (GET /api/v1/document-extraction-jobs/{request_id}/)

Endpoint

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

هدف آزمون

همان DocumentExtractionRequestDetailView با مسیر legacy.

شرایط آزمون

  • سرویس core-api در حال اجرا باشد
  • هدر Authorization با access token معتبر

فرآیند آزمون

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

معرفی ویژگی

نام قدیمی «job»؛ رفتار byte-for-byte با requests endpoint یکسان است.

  • ورودی معتبر: اعتبارسنجی در مرز API
  • پاسخ استاندارد: قالب JSON یکسان با سایر endpointها
  • کنترل دسترسی: مطابق policy ماژول مربوطه

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

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

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

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

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

سناریو 3: یکسان بودن alias

  1. GET requests/{id} و jobs/{id}
  2. مقایسه عمیق JSON
  3. بررسی برابری status و timestamps

سناریو 4: خطا — request_id نامعتبر

  1. UUID تصادفی
  2. دریافت 404
  3. بررسی پیام not found

قالب API

مولفه نوع نوع داده اجباری توضیحات
request_id Path uuid بله شناسه درخواست استخراج

Swagger

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

نمونه ورودی

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

نمونه خروجی

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

Status Codes

  • 200: عملیات موفق
  • 401: احراز هویت نامعتبر یا ناقص

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

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

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

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

توضیحات

  • فقط برای سازگاری عقب‌رو؛ در کلاینت جدید از requests استفاده کنید