# Lấy Schema báo cáo

> Lấy danh sách các trường, chế độ và bộ lọc khả dụng cho một loại báo cáo.

Source: https://docs.fleetwork.vn/vi/reports/reports-schema

**GET** `https://live.fleetwork.vn/api/v1/workspace/reports/schema`

Dùng endpoint này để khám phá các `fields` khả dụng trước khi gọi [Query Report](https://docs.fleetwork.vn/vi/reports/reports-query).

## Tham số query

| Tham số      | Kiểu   | Bắt buộc      | Mô tả                                                                       |
| ------------ | ------ | ------------- | --------------------------------------------------------------------------- |
| `reportType` | string | **Bắt buộc**  | `timeline`, `time-allocation`, `statistics`, `job-report`, `mileage-report` |
| `mode`       | string | Tuỳ chọn      | `by_user` (mặc định) hoặc `by_place`                                        |

## Ví dụ

### Yêu cầu

```bash
curl -X GET \
  "https://live.fleetwork.vn/api/v1/workspace/reports/schema?reportType=job-report&mode=by_user" \
  -H "API-KEY: <your-key>"
```

### Phản hồi

```json
{
  "code": "OK",
  "message": null,
  "data": {
    "reportType": "job-report",
    "mode": "by_user",
    "supportedModes": ["by_user", "by_place"],
    "supportedFilters": ["fromTime", "toTime", "userId", "placeId"],
    "fields": [
      {
        "field": "taskName",
        "label": "Tên nhiệm vụ",
        "engLabel": "Task Name",
        "dataType": "string",
        "isDefault": true
      },
      {
        "field": "status",
        "label": "Trạng thái",
        "engLabel": "Status",
        "dataType": "int",
        "isDefault": true
      },
      {
        "field": "completedAt",
        "label": "Hoàn thành lúc",
        "engLabel": "Completed At",
        "dataType": "datetime",
        "isDefault": false
      }
    ]
  }
}
```

Dùng các giá trị `field` từ phản hồi làm mảng `fields` trong [Query Report](https://docs.fleetwork.vn/vi/reports/reports-query).
