# Lấy mẫu

> operationId: `getTemplate`


## Yêu cầu

Endpoint này lấy chi tiết của một mẫu. Endpoint đọc phiên bản hiện tại. Không hỗ trợ truy vấn các phiên bản trước. Để sửa đổi mẫu, bạn phải giữ lại ETag từ phản hồi. Local API không che bất cứ thông tin nào: các trường của nút được trả về nguyên trạng, giá trị mặc định của tham số riêng tư được trả về dưới dạng văn bản thuần, và redactedPaths luôn là mảng rỗng. Nếu không còn đọc được một giá trị mặc định riêng tư, phản hồi trả về `{enabled:false}` kèm cảnh báo RPA_PRIVATE_DEFAULT_UNAVAILABLE. Tương tự, các mẫu cũ có phiên bản tham số 2 phải được chuyển đổi tường minh trước.

- **Điều kiện tiên quyết**: templateId lấy từ danh sách, từ phản hồi tạo mẫu hoặc từ một tài nguyên thực tế do người dùng chỉ định.
- **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ề phần thân mẫu hiện tại và một ETag mạnh.
- **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/{templateId}
```

Local API: `http://127.0.0.1:<port>/api/rpa/browser/v1/templates/{templateId}`. 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

| Tham số | Kiểu | Bắt buộc | Mô tả và ràng buộc |
|  --- | --- | --- | --- |
| `templateId` | string | Có | ID mẫu đích (ID đám mây của mẫu trong Mẫu tùy chỉnh của ứng dụng, là một chuỗi số). Độ dài tối thiểu 1; độ dài tối đa 128 |


### Tham số truy vấn

Không có.

### 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/${RPA_TEMPLATE_ID}"
```

## Phản hồi

### 200

200 trả về phần thân mẫu hiện tại và một ETag mạnh.

| Header | Mô tả |
|  --- | --- |
| `ETag` | Định danh phiên bản mạnh của mẫu trong phản hồi này. Gửi nguyên giá trị này trong If-Match cho các thay đổi sau đó. |


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 |
|  --- | --- | --- | --- |
| `title` | string | Có | Tên hiển thị. Khi ghi mẫu, dài 1–100 ký tự sau khi loại bỏ khoảng trắng ở hai đầu. |
| `description` | string | Có | Văn bản mô tả. Bắt buộc khi ghi mẫu. Dùng chuỗi rỗng để xóa mô tả. |
| `workflow` | [Cấu trúc quy trình](/vi/browser-rpa/api/workflow) / [JSON Schema](/vi/browser-rpa/local-api#h%E1%BB%A3p-%C4%91%E1%BB%93ng-c%E1%BB%A5c-b%E1%BB%99-d%E1%BA%A1ng-m%C3%A1y-%C4%91%E1%BB%8Dc-%C4%91%C6%B0%E1%BB%A3c) | Có | Đối tượng quy trình ở định dạng gốc của trình chỉnh sửa. Quy trình chạy theo thứ tự của nodes/blocks. |
| `dependencies` | array<[DependencyPin](/vi/browser-rpa/api/data-types#dependencypin)> | Có | Danh sách phụ thuộc mẫu con. Danh sách phải khớp một-một với các mẫu con được applySubProcess tham chiếu trong quy trình. revisionId là revisionId hiện tại của mẫu con (`remote:<childTemplateId>@<version>`). Nếu không có phụ thuộc, gửi []. Khi chạy, giống như trong ứng dụng máy tính, mỗi lượt chạy lấy một bản chụp nhanh cố định của phiên bản mới nhất của mẫu con tại thời điểm đó. Tối đa 1000 phần tử. |
| `id` | string | Có | ID duy nhất của tài nguyên hoặc nút. Lấy ID từ phản hồi trước đó; không tự đoán. Độ dài tối thiểu 1; độ dài tối đa 128. |
| `version` | integer | Có | Phiên bản mẫu có thể chỉnh sửa hiện tại. Đọc giá trị này từ phản hồi thực tế. Tối thiểu 1. |
| `revisionId` | string | Có | ID bản sửa đổi bất biến. Độ dài tối thiểu 1; độ dài tối đa 128. |
| `createdAt` | integer | Có | Thời điểm tạo, tính bằng mili giây Unix. Tối thiểu 0. |
| `updatedAt` | integer | Có | Thời điểm cập nhật gần nhất, tính bằng mili giây Unix. Tối thiểu 0. |
| `warnings` | array<[Issue](/vi/browser-rpa/api/data-types#issue)> | Có | Các vấn đề và hạn chế không cản trở việc lưu. Hãy đánh giá tác động của từng mục. |
| `redactedPaths` | array<string> | Có | Trường tương thích. Luôn là mảng rỗng trong phiên bản hiện tại. Local API không che nội dung mẫu. |


### 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": {
    "title": "Read the page URL",
    "description": "Visit the given page and return its URL",
    "workflow": {
      "editorVersion": 2,
      "editorParametersVersion": 1,
      "variables": {
        "type": "object",
        "properties": {
          "targetUrl": {
            "type": "string",
            "description": "HTTP(S) URL to visit"
          }
        },
        "required": [
          "targetUrl"
        ]
      },
      "nodes": [
        {
          "id": "start",
          "type": "start"
        },
        {
          "id": "visit",
          "type": "browser_gotoUrl",
          "data": {
            "browserAction": "gotoUrl",
            "browserUi": {
              "inputs": {
                "url": "${targetUrl}",
                "postWaitMs": 500
              },
              "bindings": {},
              "exception": {
                "policy": "interrupt",
                "timeout": 30000,
                "retry": false,
                "retryTimes": 1,
                "retryInterval": 2,
                "screenshot": true
              }
            },
            "title": "Visit website",
            "inputs": {
              "type": "object",
              "properties": {}
            },
            "inputsValues": {},
            "outputs": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "description": "Execution status"
                },
                "startedAt": {
                  "type": "string",
                  "description": "Start time"
                },
                "endedAt": {
                  "type": "string",
                  "description": "End time"
                },
                "durationMs": {
                  "type": "number",
                  "description": "Duration (ms)"
                },
                "matchedIndex": {
                  "type": "number",
                  "description": "Match index"
                },
                "error": {
                  "type": "object",
                  "description": "Error message",
                  "properties": {
                    "code": {
                      "type": "string"
                    },
                    "message": {
                      "type": "string"
                    }
                  }
                },
                "data": {
                  "type": "object",
                  "description": "Result",
                  "properties": {
                    "tabId": {
                      "type": "string",
                      "description": "Tab ID"
                    },
                    "httpStatus": {
                      "type": "number",
                      "description": "HTTP status code"
                    },
                    "url": {
                      "type": "string",
                      "description": "URL"
                    },
                    "finalUrl": {
                      "type": "string",
                      "description": "Final URL"
                    },
                    "title": {
                      "type": "string",
                      "description": "Page title"
                    },
                    "isRedirected": {
                      "type": "boolean",
                      "description": "Redirected"
                    }
                  }
                }
              }
            }
          }
        },
        {
          "id": "url_result",
          "type": "browser_getUrl",
          "data": {
            "browserAction": "getUrl",
            "browserUi": {
              "inputs": {
                "type": "href"
              },
              "bindings": {},
              "exception": {
                "policy": "interrupt",
                "timeout": 30000,
                "retry": false,
                "retryTimes": 1,
                "retryInterval": 2,
                "screenshot": true
              }
            },
            "title": "Get URL",
            "inputs": {
              "type": "object",
              "properties": {}
            },
            "inputsValues": {},
            "outputs": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "description": "Execution status"
                },
                "startedAt": {
                  "type": "string",
                  "description": "Start time"
                },
                "endedAt": {
                  "type": "string",
                  "description": "End time"
                },
                "durationMs": {
                  "type": "number",
                  "description": "Duration (ms)"
                },
                "matchedIndex": {
                  "type": "number",
                  "description": "Match index"
                },
                "error": {
                  "type": "object",
                  "description": "Error message",
                  "properties": {
                    "code": {
                      "type": "string"
                    },
                    "message": {
                      "type": "string"
                    }
                  }
                },
                "data": {
                  "type": "object",
                  "description": "Result",
                  "properties": {
                    "url": {
                      "type": "string",
                      "description": "URL"
                    },
                    "origin": {
                      "type": "string",
                      "description": "Origin"
                    },
                    "pathname": {
                      "type": "string",
                      "description": "Path"
                    },
                    "query": {
                      "type": "object",
                      "properties": {},
                      "description": "Query parameters"
                    }
                  }
                }
              }
            }
          }
        },
        {
          "id": "end",
          "type": "end",
          "data": {
            "inputsValues": {
              "status": {
                "type": "constant",
                "content": "success"
              },
              "message": {
                "type": "ref",
                "content": [
                  "url_result",
                  "data",
                  "value"
                ]
              }
            }
          }
        }
      ]
    },
    "dependencies": [],
    "id": "template_example",
    "version": 1,
    "revisionId": "revision_example_1",
    "createdAt": 1793318400000,
    "updatedAt": 1793318400000,
    "warnings": [],
    "redactedPaths": []
  },
  "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)