Tham chiếu API: Module Auto Report
Tài liệu này chi tiết về các điểm cuối API RESTful cho module Auto Report.
1. Xác thực
Tất cả các yêu cầu PHẢI bao gồm một Platform JWT trong tiêu đề Authorization.
http
Authorization: Bearer <JWT>2. API Mẫu báo cáo
GET /templates
Liệt kê tất cả các mẫu báo cáo cho tổ chức.
POST /templates
Tạo một mẫu báo cáo tự động mới.
Thân yêu cầu (Body):
json
{
"name": "Tóm tắt Tuyển dụng Hàng tuần",
"sources": ["hrm/employees", "hrm/departments"],
"systemPrompt": "Phân tích các nhân viên mới trong tuần này và tóm tắt theo bộ phận.",
"scheduleCron": "0 9 * * 1"
}PUT /templates/:id
Cập nhật một mẫu hiện có hoặc thay đổi trạng thái lập lịch của nó (active / paused).
DELETE /templates/:id
Xóa một mẫu và cấu hình của nó. Lịch sử vẫn được bảo toàn.
3. API Thực thi & Kết quả
POST /templates/:id/run
Kích hoạt thực thi thủ công mẫu báo cáo.
GET /executions
Liệt kê lịch sử thực thi báo cáo.
Tham số Truy vấn:
templateId: Lọc theo mẫu.status:success,error, v.v.
GET /executions/:id/result
Truy xuất nội dung Markdown đã tạo và ảnh chụp nhanh dữ liệu.
GET /executions/:id/export
Tạo và tải xuống bản PDF của báo cáo.
4. Webhooks & Callbacks
POST /callbacks/mastra
Điểm cuối nội bộ được Mastra worker sử dụng để cập nhật trạng thái báo cáo khi hoàn thành.
5. Mã Lỗi Tiêu chuẩn
| Mã Trạng thái | Mô tả |
|---|---|
400 Bad Request | Chuỗi cron hoặc danh sách nguồn không hợp lệ. |
403 Forbidden | Không đủ quyền hạn để thu thập dữ liệu S2S. |
404 Not Found | Mẫu báo cáo hoặc nhật ký thực thi không tồn tại. |
422 Unprocessable Entity | Nguồn dữ liệu trả về kết quả trống hoặc lỗi. |
500 Server Error | LLM tạo nội dung quá hạn hoặc lỗi dịch vụ PDF. |