# Lấy hợp đồng nút

> operationId: `getNodeType`


## Yêu cầu

Lấy một hợp đồng nút. nodeType là một loại, không phải nodeId bên trong mẫu. Đầu vào trước tiên được bổ sung các trường còn thiếu bằng NodeContract.defaults, sau đó được ghi đè bằng bindings với các tham chiếu đã phân giải, và cuối cùng được kiểm tra theo các quy tắc của nhánh điều kiện. x-editor-default chỉ là giá trị ban đầu trên giao diện. Để thiết kế ngoại tuyến, xem [58 hợp đồng nút tĩnh](/vi/browser-rpa/nodes). Nếu các hợp đồng này khác với instance đang chạy, hãy làm mới hợp đồng trước, và không trộn lẫn các bản sửa đổi danh mục. outputVariants xác định những đầu ra nào có thể được tham chiếu. fieldPolicies ràng buộc cả đầu vào lẫn bindings. Ví dụ được lấy từ một instance có hỗ trợ nút này. Khả năng sử dụng thực tế phụ thuộc vào những gì instance hiện tại trả về. Khi documentationComplete=false, đừng đoán các quy tắc còn thiếu.

- **Điều kiện tiên quyết**: nodeType lấy từ danh sách loại nút, ví dụ browser_waitTime.
- **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ề đầu vào, đầu ra, tham chiếu, điều kiện và chính sách trường của nút.
- **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/node-types/{nodeType}
```

Local API: `http://127.0.0.1:<port>/api/rpa/browser/v1/node-types/{nodeType}`. 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 |
|  --- | --- | --- | --- |
| `nodeType` | string | Có | ID loại thực tế, ví dụ browser_waitTime. Đây không phải là ID nút trong quy trình. Độ 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}/node-types/${RPA_NODE_TYPE}"
```

## Phản hồi

### 200

200 trả về đầu vào, đầu ra, tham chiếu, điều kiện và chính sách trường của nút.

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 |
|  --- | --- | --- | --- |
| `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. |
| `action` | string hoặc null | Có | Tên hành động của trình thực thi. Là null với nút cấu trúc. |
| `nodeVersion` | integer | Có | Phiên bản hợp đồng của loại nút này. Đây không phải là khóa phiên bản cho một nút riêng lẻ trong mẫu. Tối thiểu 1. |
| `category` | string | Có | Phân loại của nút. Lọc theo các giá trị thực tế trong danh mục. |
| `title` | string | Có | Tên hiển thị của loại nút. |
| `description` | string | Có | Mô tả hành vi và quy tắc ngữ nghĩa của nút. |
| `authorable` | boolean | Có | Cho biết loại này có thể dùng trong soạn thảo công khai hay không. Các trường của loại này vẫn tuân theo fieldPolicies. |
| `runtimeSupported` | boolean | Có | Cho biết trình thực thi nội bộ có hỗ trợ loại này hay không. |
| `externalRunnable` | boolean | Có | Cho biết instance hiện tại có thể chạy nút này qua Local API hay không. Là true khi hành động đã được đăng ký. Vẫn cần xác thực cho lượt chạy. |
| `documentationComplete` | boolean | Có | Cho biết toàn bộ quy tắc có thể thực thi đã được công bố hay chưa. |
| `unavailableReasons` | array<string> | Có | Danh sách lý do nút không khả dụng. Mảng rỗng nghĩa là không có lý do nào đã biết. |
| `inputSchema` | [JsonObject](/vi/browser-rpa/api/data-types#jsonobject) | Có | JSON Schema của đầu vào hành động. Với loại cấu trúc, schema này xác thực toàn bộ nút. |
| `outputVariants` | array<object> | Có | Các nhánh schema đầu ra, được chọn theo chế độ. |
| `referenceRules` | array<object> | Có | Dạng giá trị được phép và phạm vi tham chiếu của từng trường. |
| `conditionalRules` | array<object> | Có | Các quy tắc có điều kiện, được kiểm tra sau khi giá trị mặc định và bindings có hiệu lực. |
| `fieldPolicies` | array<object> | Có | Mức độ nhạy cảm và hạn chế soạn thảo theo từng trường. Các quy tắc này cũng áp dụng cho bindings. |
| `defaults` | [JsonObject](/vi/browser-rpa/api/data-types#jsonobject) | Có | Giá trị mặc định an toàn khi thực thi đã được chuẩn hóa, được hợp nhất vào các trường bị bỏ qua. x-editor-default không được dùng khi thực thi. |
| `examples` | array<object> | Có | Mảng các ví dụ gồm đầu vào và đầu ra minh họa của nút này. |
| `sideEffects` | array<`browser` / `read` / `write` / `file` / `script` / `credential` / `environment`> | Có | Các loại tác dụng phụ mà việc chạy nút có thể gây ra. |
| `docUrl` | string | Có | URL của tài liệu chi tiết cho nút này. |


**Các trường của `outputVariants[]`**

| Trường | Kiểu | Bắt buộc | Mô tả và ràng buộc |
|  --- | --- | --- | --- |
| `outputVariants[].when` | [ConditionRule](/vi/browser-rpa/api/data-types#conditionrule) | Có | Điều kiện dạng khai báo. Chỉ hỗ trợ các phép toán trong ConditionRule. |
| `outputVariants[].schema` | [JsonObject](/vi/browser-rpa/api/data-types#jsonobject) | Có | JSON Schema của node.data trong điều kiện này. Đây không phải là URL tài liệu. |
| `outputVariants[].publicProjection` | string | Có | Mô tả cách dữ liệu trong bản ghi lượt chạy khác với đầu ra của trình thực thi (không che thông tin; chỉ có handle là không thể tuần tự hóa). |


**Các trường của `referenceRules[]`**

| Trường | Kiểu | Bắt buộc | Mô tả và ràng buộc |
|  --- | --- | --- | --- |
| `referenceRules[].field` | string | Có | Trường đầu vào của nút hoặc trường quy tắc tương ứng. |
| `referenceRules[].allow` | array<`literal` / `reference` / `template` / `numericExpression`> | Có | Những dạng nào trong literal/reference/template/numericExpression được phép. |
| `referenceRules[].expectedType` | string | Có | Kiểu đích sau khi tham chiếu được phân giải. |
| `referenceRules[].scope` | string | Có | Phạm vi nhìn thấy được của tham chiếu. |


**Các trường của `conditionalRules[]`**

| Trường | Kiểu | Bắt buộc | Mô tả và ràng buộc |
|  --- | --- | --- | --- |
| `conditionalRules[].when` | [ConditionRule](/vi/browser-rpa/api/data-types#conditionrule) | Có | Điều kiện dạng khai báo. Chỉ hỗ trợ các phép toán trong ConditionRule. |
| `conditionalRules[].requiredFields` | array<string> | Có | Các trường bắt buộc trong điều kiện này. |
| `conditionalRules[].forbiddenFields` | array<string> | Có | Các trường bị cấm trong điều kiện này. |
| `conditionalRules[].constraints` | array<string> | Có | Mô tả ràng buộc. Trước khi công bố, mỗi mô tả phải tương ứng với một quy tắc xác thực có thể thực thi. |
| `conditionalRules[].issueCode` | string | Có | Mã vấn đề được trả về khi điều kiện bị vi phạm. |


**Các trường của `fieldPolicies[]`**

| Trường | Kiểu | Bắt buộc | Mô tả và ràng buộc |
|  --- | --- | --- | --- |
| `fieldPolicies[].field` | string | Có | Trường đầu vào của nút hoặc trường quy tắc tương ứng. |
| `fieldPolicies[].sensitivity` | `public` / `secret` / `credential` / `localPath` / `inlineFile` / `sourceCode` | Có | Phân loại mức độ nhạy cảm dữ liệu của trường. |
| `fieldPolicies[].authoringPolicy` | `allowed` / `privateReferenceOnly` / `restricted` | Có | Luôn là `allowed` trong phiên bản hiện tại: trường nhận giá trị literal hoặc tham chiếu. Hai giá trị còn lại chỉ được giữ để tương thích với các phiên bản trước. |
| `fieldPolicies[].when` | [ConditionRule](/vi/browser-rpa/api/data-types#conditionrule) | Có | Điều kiện dạng khai báo. Chỉ hỗ trợ các phép toán trong ConditionRule. |


**Các trường của `examples[]`**

| Trường | Kiểu | Bắt buộc | Mô tả và ràng buộc |
|  --- | --- | --- | --- |
| `examples[].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. |
| `examples[].input` | [JsonObject](/vi/browser-rpa/api/data-types#jsonobject) | Có | Đầu vào ví dụ. |
| `examples[].expectedOutput` | [JsonValue](/vi/browser-rpa/api/data-types#jsonvalue) | Có | Giá trị đầu ra minh họa. Giá trị thực tế lấy từ lượt chạy. |
| `examples[].requirements` | array<string> | Có | Điều kiện tiên quyết của ví dụ. |


### 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": {
    "id": "browser_waitTime",
    "action": "waitTime",
    "nodeVersion": 1,
    "category": "browser",
    "title": "Wait",
    "description": "**Branch rules:** For fixed, timeout defaults to 1000 ms. For randomInterval, the default is [1000,3000] ms, with timeoutMin ≤ timeoutMax.",
    "authorable": true,
    "runtimeSupported": true,
    "externalRunnable": true,
    "documentationComplete": true,
    "unavailableReasons": [],
    "inputSchema": {
      "$ref": "/api/rpa/browser/v1/docs/api/workflow.schema.json#/$defs/waitTimeInputs"
    },
    "outputVariants": [
      {
        "when": {
          "op": "always"
        },
        "schema": {
          "type": "object",
          "properties": {
            "waitedMs": {
              "type": "number"
            },
            "requestedMs": {
              "type": "number"
            }
          },
          "required": [
            "waitedMs",
            "requestedMs"
          ],
          "additionalProperties": false,
          "$schema": "https://json-schema.org/draft/2020-12/schema"
        },
        "publicProjection": "The data of a successful node. Reference it with ${nodeId.data.<field>}. Run records store the actual values as is (including credentials, cookies, values derived from private parameters, and local paths), without redaction. Only element and frame handles appear as {kind,available:false}."
      }
    ],
    "referenceRules": [
      {
        "field": "timeoutType",
        "allow": [
          "literal",
          "reference",
          "template"
        ],
        "expectedType": "See the matching field in inputSchema (it must still match after the reference is resolved)",
        "scope": "Initial variables of the same workflow, currently visible previous nodes, custom variables, and published system fields. No references to future nodes or sibling branches."
      },
      {
        "field": "timeout",
        "allow": [
          "literal",
          "numericExpression"
        ],
        "expectedType": "number",
        "scope": "Initial variables of the same workflow, currently visible previous nodes, custom variables, and published system fields. No references to future nodes or sibling branches."
      },
      {
        "field": "timeoutMin",
        "allow": [
          "literal",
          "numericExpression"
        ],
        "expectedType": "number",
        "scope": "Initial variables of the same workflow, currently visible previous nodes, custom variables, and published system fields. No references to future nodes or sibling branches."
      },
      {
        "field": "timeoutMax",
        "allow": [
          "literal",
          "numericExpression"
        ],
        "expectedType": "number",
        "scope": "Initial variables of the same workflow, currently visible previous nodes, custom variables, and published system fields. No references to future nodes or sibling branches."
      }
    ],
    "conditionalRules": [
      {
        "when": {
          "op": "eq",
          "field": "timeoutType",
          "value": "fixed"
        },
        "requiredFields": [],
        "forbiddenFields": [],
        "constraints": [
          "After resolution, timeout is a finite number from 0 to 2147483647, in milliseconds."
        ],
        "issueCode": "RPA_NODE_INPUT_INVALID"
      },
      {
        "when": {
          "op": "eq",
          "field": "timeoutType",
          "value": "randomInterval"
        },
        "requiredFields": [],
        "forbiddenFields": [],
        "constraints": [
          "timeoutMin/timeoutMax are numbers from 0 to 2147483647 and can be decimals. timeoutMin <= timeoutMax. The wait is timeoutMin + floor(random × (timeoutMax − timeoutMin + 1)). When both ends are integers, the result is a uniformly random integer in the closed interval. With decimals, the step is 1, and the result can exceed timeoutMax by less than 1 millisecond."
        ],
        "issueCode": "RPA_NODE_INPUT_INVALID"
      },
      {
        "when": {
          "op": "always"
        },
        "requiredFields": [],
        "forbiddenFields": [],
        "constraints": [
          "**Branch rules:** For fixed, timeout defaults to 1000 ms. For randomInterval, the default is [1000,3000] ms, with timeoutMin ≤ timeoutMax."
        ],
        "issueCode": "RPA_NODE_INPUT_INVALID"
      }
    ],
    "fieldPolicies": [
      {
        "field": "timeoutType",
        "sensitivity": "public",
        "authoringPolicy": "allowed",
        "when": {
          "op": "always"
        }
      },
      {
        "field": "timeout",
        "sensitivity": "public",
        "authoringPolicy": "allowed",
        "when": {
          "op": "always"
        }
      },
      {
        "field": "timeoutMin",
        "sensitivity": "public",
        "authoringPolicy": "allowed",
        "when": {
          "op": "always"
        }
      },
      {
        "field": "timeoutMax",
        "sensitivity": "public",
        "authoringPolicy": "allowed",
        "when": {
          "op": "always"
        }
      }
    ],
    "defaults": {
      "timeoutType": "fixed",
      "timeout": 1000,
      "timeoutMin": 1000,
      "timeoutMax": 3000
    },
    "examples": [
      {
        "id": "fixed",
        "input": {
          "timeoutType": "fixed",
          "timeout": 1200
        },
        "expectedOutput": {
          "requestedMs": 1200,
          "waitedMs": 1202
        },
        "requirements": [
          "waitedMs is the measured time. Don't assume that it exactly equals requestedMs."
        ]
      }
    ],
    "sideEffects": [
      "browser"
    ],
    "docUrl": "/api/rpa/browser/v1/docs/api/nodes/browser_waitTime.md"
  },
  "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)