# Liệt kê mẫu

> operationId: `listTemplates`


## Yêu cầu

Endpoint này liệt kê các mẫu. Tham số search khớp theo chuỗi con, không phân biệt chữ hoa chữ thường, sau khi loại bỏ khoảng trắng ở hai đầu. Bản tóm tắt không bao gồm quy trình. Sau khi chọn một mẫu, hãy đọc chi tiết của mẫu đó để lấy toàn bộ phần thân và ETag. Nếu các mẫu bị chỉnh sửa trong khi bạn duyệt qua các trang của danh sách, hãy truy vấn lại. Danh sách không phải là một bản chụp nhanh nhất quán giữa các trang.

- **Điều kiện tiên quyết**: Ứng dụng máy tính đang đăng nhập có quyền đọc mẫu.
- **Xác thực truy cập**: Giống như ở các phần khác của Local API; xem [Xác thực](/vi/api-reference/getting-started/authentication). Tài nguyên thuộc phạm vi dữ liệu của tài khoản/nhóm hiện tại.
- **Tác dụng phụ**: Không có. Lệnh gọi này không ghi dữ liệu nghiệp vụ.
- **Tín hiệu hoàn tất**: 200 trả về bản tóm tắt các mẫu trong phạm vi được cấp quyền.
- **Thử lại**: Có thể thử lại các lệnh gọi chỉ đọc. Khi nhận 429 hoặc 503, hãy tạm dừng theo Retry-After.


### Endpoint

```http
GET /api/rpa/browser/v1/templates
```

Local API: `http://127.0.0.1:<port>/api/rpa/browser/v1/templates`. Dùng cổng được cấu hình trong ứng dụng.

### Header

| Tham số | Kiểu | Bắt buộc | Mô tả và ràng buộc |
|  --- | --- | --- | --- |
| `Authorization` | string | Khi bật xác thực Local API | Xem [Xác thực](/vi/api-reference/getting-started/authentication). |


### Tham số đường dẫn

Không có.

### Tham số truy vấn

| Tham số | Kiểu | Bắt buộc | Mô tả và ràng buộc |
|  --- | --- | --- | --- |
| `page` | integer | Không | Số trang, bắt đầu từ 1. Tối thiểu 1; mặc định 1 |
| `pageSize` | integer | Không | Số mục mỗi trang. Mặc định 20, tối đa 100. Tối thiểu 1; tối đa 100; mặc định 20 |
| `search` | string | Không | Chuỗi con không phân biệt chữ hoa chữ thường, được so khớp sau khi loại bỏ khoảng trắng ở hai đầu; tối đa 100 ký tự. Độ dài tối đa 100 |


### Phần thân yêu cầu

Không có phần thân yêu cầu.

### Ví dụ yêu cầu

Đây là ví dụ minh họa trong tài liệu; ví dụ này chưa được gửi tới một ứng dụng đang chạy thực tế. Đặt `RPA_BASE_URL` theo mô tả trong [Quy ước API](/vi/browser-rpa/api/common). Các biến tài nguyên, bản sửa đổi danh mục và ETag lấy từ phản hồi thực tế.

```bash
curl -i -X GET "${RPA_BASE_URL}/templates?page=1&pageSize=20"
```

## Phản hồi

### 200

200 trả về bản tóm tắt các mẫu trong phạm vi được cấp quyền.

Phần thân: `application/json`. Trường `data` ở cấp cao nhất dùng mô hình bên dưới. Về `meta`, xem [Metadata](/vi/browser-rpa/api/data-types#metadata).

| Trường | Kiểu | Bắt buộc | Mô tả và ràng buộc |
|  --- | --- | --- | --- |
| `items` | array<[TemplateSummary](/vi/browser-rpa/api/data-types#templatesummary)> | Có | Mảng các mục trên trang hiện tại hoặc của tài nguyên hiện tại. |
| `total` | integer | Có | Tổng số kết quả khớp. Tối thiểu 0. |
| `page` | integer | Có | Số trang, bắt đầu từ 1. Tối thiểu 1. |
| `pageSize` | integer | Có | Số mục mỗi trang. Mặc định 20, tối đa 100. Tối thiểu 1; tối đa 100. |


### Ví dụ phản hồi

Mọi ID, dấu thời gian, giá trị băm và kết quả lượt chạy đều là dữ liệu ví dụ. Các giá trị này không cho thấy ví dụ đã được thực thi.

```json
{
  "data": {
    "items": [
      {
        "id": "template_example",
        "title": "Read the page URL",
        "description": "Visit the given page and return its URL",
        "version": 1,
        "revisionId": "revision_example_1",
        "createdAt": 1793318400000,
        "updatedAt": 1793318400000
      }
    ],
    "total": 1,
    "page": 1,
    "pageSize": 20
  },
  "meta": {
    "requestId": "7d498f20-7bab-4e59-9b05-88daf51230e9",
    "catalogRevision": "sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  }
}
```

### Phản hồi lỗi

Về các lỗi 400/401/403/404/429/5xx thường gặp và các trường mô tả thất bại, xem [Lỗi và khôi phục](/vi/browser-rpa/api/common#l%E1%BB%97i-v%C3%A0-kh%C3%B4i-ph%E1%BB%A5c). Ví dụ phản hồi lỗi (403):

```json
{
  "error": {
    "code": "RPA_PERMISSION_DENIED",
    "message": "The request Host or Origin is not allowed, or the current identity can't access the target environment",
    "retryable": false,
    "issues": [],
    "details": null
  },
  "meta": {
    "requestId": "7d498f20-7bab-4e59-9b05-88daf51230e9",
    "catalogRevision": "sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  }
}
```

## Liên quan

[Tham chiếu Local API](/vi/browser-rpa/local-api) · [Quy ước API](/vi/browser-rpa/api/common) · [Mô hình dữ liệu](/vi/browser-rpa/api/data-types) · [Cấu trúc quy trình](/vi/browser-rpa/api/workflow) · [Bắt đầu nhanh](/vi/browser-rpa/quickstart)