Skip to Content
🚀 Welcome to Humansoft Open API Documentation

Report Status

ตรวจสอบสถานะของงานสร้างรายงานด้วย trace_id ที่ได้จากการส่งคำขอ

เรียก API นี้เป็นระยะเพื่อติดตามความคืบหน้า เมื่อสถานะเป็น DONE จึงเรียก Report Result เพื่อรับลิงก์ดาวน์โหลด

Endpoint

GET /api/v1/open-apis/report-builder/reports/{traceId}/status

Request Parameters

Path Parameters

ParameterTypeRequiredDescriptionExample
traceIdstringYesรหัสติดตามงานที่ได้จาก Submit Report0190f8a1-2b3c-7def-8123-456789abcdef

Code Examples

curl -X GET "https://openapi.humansoft.co.th/api/v1/open-apis/report-builder/reports/0190f8a1-2b3c-7def-8123-456789abcdef/status" \ -H "Ocp-Apim-Subscription-Key: YOUR_API_KEY"

Response Format

กำลังประมวลผล (HTTP 200)

{ "trace_id": "0190f8a1-2b3c-7def-8123-456789abcdef", "status": "PROCESSING", "created_at": "2026-06-17T09:00:00.000Z", "updated_at": "2026-06-17T09:00:05.000Z" }

ประมวลผลเสร็จ (HTTP 200)

เมื่อสร้างรายงานเสร็จ จะมี object file พร้อมข้อมูลไฟล์ (แต่ยังไม่มีลิงก์ดาวน์โหลด — รับลิงก์ได้จาก Report Result):

{ "trace_id": "0190f8a1-2b3c-7def-8123-456789abcdef", "status": "DONE", "created_at": "2026-06-17T09:00:00.000Z", "updated_at": "2026-06-17T09:00:42.000Z", "file": { "name": "report.csv", "size": 20480, "content_type": "text/csv" } }

Response Fields

FieldTypeDescription
trace_idstringรหัสติดตามงาน
statusstringสถานะงาน — PENDING, PROCESSING, DONE หรือ FAILED
created_atstring (ISO 8601)เวลาที่รับคำขอ
updated_atstring (ISO 8601)เวลาที่อัปเดตสถานะล่าสุด
fileobjectข้อมูลไฟล์ — มีเมื่อสร้างรายงานเสร็จแล้ว
file.namestringชื่อไฟล์รายงาน
file.sizeintegerขนาดไฟล์ (byte)
file.content_typestringMIME type ของไฟล์

Response นี้จะไม่มีลิงก์ดาวน์โหลด — ใช้ Report Result เพื่อรับลิงก์แบบมีอายุจำกัด เมื่อสถานะเป็น DONE


Error Responses

Job Not Found (HTTP 404)

{ "error": { "code": "JOB_NOT_FOUND", "message": "Report job not found" } }

Status Codes

Codeความหมาย
200สำเร็จ
401ไม่ได้ส่ง API Key หรือ Key ไม่ถูกต้อง (UNAUTHORIZED)
403trace_id เป็นของผู้เช่ารายอื่น (JOB_FORBIDDEN)
404ไม่พบงานตาม trace_id ที่ระบุ หรือหมดอายุแล้ว (JOB_NOT_FOUND)
500เกิดข้อผิดพลาดระหว่างประมวลผลบนเซิร์ฟเวอร์

  • Submit Report - ส่งคำขอสร้างรายงาน
  • Report Result - รับลิงก์ดาวน์โหลด
Last updated on