# 预览模板修改及影响范围

预览模板修改及受影响的子码数量，返回有时效的 preview_token，不保存。需要当前 template_version；默认只能预览通过接口创建的模板。

## 请求

```text
POST https://open.cli.im/api/v2/rpc/templates/previewEdit
```

| 项目 | 要求 |
|---|---|
| 最低权限 | 读写，见[权限档位](https://cli.im/open-api/openapi/v2/auth.md#org-policy) |
| 需要的 scope | `templates.write` |
| 组织 Key | 不能调用，返回 403 `credential_type_not_allowed`，见[历史组织 Key](https://cli.im/open-api/openapi/v2/auth.md#org-key) |

## 请求参数

请求体为 JSON。

| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| `template_id` | string | 是 | 模板 ID，取自 templates/listEditable 或 templates/list 返回的 template_id。最长 128 个字符 |
| `template_version` | string | 是 | 模板版本，取自 templates/getSchema 返回的 template_version；模板变化后需要重新读取。最长 128 个字符 |
| `patch` | object | 是 | — |
| `patch.name` | string | 否 | 新的模板名称。最长 100 个字符 |
| `patch.groups` | object[] | 否 | 基础信息分组的完整清单；不能删除已有字段或修改字段类型。至少 1 项。最多 20 项 |
| `patch.groups[].group_id` | string | 是 | 分组标识。新分组由调用方自定；已有分组用 templates/getSchema 返回的 group_id。最长 128 个字符 |
| `patch.groups[].name` | string | 是 | 分组名称，可以是空字符串。最长 200 个字符 |
| `patch.groups[].fields` | object[] | 是 | 分组内的字段，1 到 100 个。至少 1 项。最多 100 项 |
| `patch.groups[].fields[].field_id` | string | 是 | 字段标识。新字段由调用方自定（字母、数字、下划线、短横线），保存后的字段 ID 见返回的 field_mapping；已有字段用 templates/getSchema 返回的 field_id。最长 128 个字符 |
| `patch.groups[].fields[].name` | string | 是 | 字段名称。最长 100 个字符 |
| `patch.groups[].fields[].type` | string | 是 | 字段类型：text 单行文本、textarea 多行文本、number 数字、date 日期（YYYY-MM-DD）、image 图片、file 附件。可选值：`text`、`textarea`、`number`、`date`、`image`、`file` |
| `patch.groups[].fields[].required` | boolean | 否 | 是否必填，默认 false。默认 `false` |
| `patch.groups[].fields[].variable` | boolean | 否 | true（默认）表示每个子码各自填写；false 表示公共字段，所有子码共用 public_value 的内容。默认 `true` |
| `patch.groups[].fields[].public_value` | any | 否 | 公共字段的内容，仅 variable 为 false 时使用。图片、附件传 [{"file_key": ...}]，file_key 取自 assets/requestUpload |
| `patch.name_rule` | any[] | 否 | 新的子码命名规则，写法同 templates/create。最多 100 项 |
| `patch.components` | object[] | 否 | 正文图文组件的完整清单，按顺序排列：keep 保留已有组件，basic_info 标出基础信息的位置，带 ref 的内容原地替换对应组件，不带 ref 的是新增；没有写到的图文组件会被删除（基础信息不会）。对模板下所有子码同时生效。至少 1 项。最多 50 项 |

### patch.components 中 type 为 `rich_text` 的项

| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| `patch.components[].type` | 固定值 "rich_text" | 是 | 固定为 rich_text，富文本 |
| `patch.components[].blocks` | object[] | 是 | 内容块，按顺序排列：标题、段落或列表。至少 1 项。最多 100 项 |
| `patch.components[].ref` | string | 否 | 填 templates/getSchema 的 components[].ref 时原地替换该组件的内容（组件 ID 和其他设置不变）；不填是新增 |

### patch.components[].blocks 的一种写法（DisplayTextBlock）

| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| `patch.components[].blocks[].type` | string | 是 | heading 标题；paragraph 段落。可选值：`heading`、`paragraph` |
| `patch.components[].blocks[].text` | string | 是 | 纯文本，不解析 HTML 或 Markdown。最长 10000 个字符 |

### patch.components[].blocks 的一种写法（DisplayListBlock）

| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| `patch.components[].blocks[].type` | string | 是 | bullet_list 无序列表；numbered_list 有序列表。可选值：`bullet_list`、`numbered_list` |
| `patch.components[].blocks[].items` | string[] | 是 | 列表项，纯文本。至少 1 项。最多 100 项 |

### patch.components 中 type 为 `image` 的项

| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| `patch.components[].file_key` | string | 是 | 图片的 file_key，取自 assets/requestUpload，并已由 assets/getUpload 确认状态为 temporary_available。不接受外部网址。最长 512 个字符 |
| `patch.components[].type` | 固定值 "image" | 是 | 固定为 image，单张图片 |
| `patch.components[].ref` | string | 否 | 填 templates/getSchema 的 components[].ref 时原地替换该组件的内容（组件 ID 和其他设置不变）；不填是新增 |

### patch.components 中 type 为 `file` 的项

| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| `patch.components[].file_key` | string | 是 | 文件的 file_key，取自 assets/requestUpload，并已确认状态为 temporary_available。页面上显示上传时的文件名，默认允许下载；不接受外部网址。最长 512 个字符 |
| `patch.components[].type` | 固定值 "file" | 是 | 固定为 file，文件 |
| `patch.components[].ref` | string | 否 | 填 templates/getSchema 的 components[].ref 时原地替换该组件的内容（组件 ID 和其他设置不变）；不填是新增 |

### patch.components 中 type 为 `gallery` 的项

| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| `patch.components[].type` | 固定值 "gallery" | 是 | 固定为 gallery，图集 |
| `patch.components[].items` | object[] | 是 | 图片，1 到 10 张。至少 1 项。最多 10 项 |
| `patch.components[].items[].file_key` | string | 是 | 图片的 file_key，取自 assets/requestUpload，并已由 assets/getUpload 确认状态为 temporary_available。不接受外部网址。最长 512 个字符 |
| `patch.components[].ref` | string | 否 | 填 templates/getSchema 的 components[].ref 时原地替换该组件的内容（组件 ID 和其他设置不变）；不填是新增 |

### patch.components 中 type 为 `button` 的项

| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| `patch.components[].type` | 固定值 "button" | 是 | 固定为 button，链接按钮 |
| `patch.components[].text` | string | 是 | 按钮文字。最长 100 个字符 |
| `patch.components[].url` | string | 是 | 按钮跳转的地址，须为绝对 HTTP(S) 地址且只含 ASCII 字符：中文域名用 punycode，中文路径和参数用百分号编码；不能带登录凭证。最长 2048 个字符 |

### patch.components 中 type 为 `basic_info` 的项

| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| `patch.components[].type` | 固定值 "basic_info" | 是 | 固定为 basic_info，标出基础信息（groups）在页面上的位置；最多一个，且 groups 不能为空 |

### patch.components 中 type 为 `keep` 的项

| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| `patch.components[].type` | 固定值 "keep" | 是 | 固定为 keep，原样保留已有组件 |
| `patch.components[].ref` | string | 是 | templates/getSchema 的 components[].ref，如 c_123 |

## 请求示例

示例里的 ID、幂等键等换成实际值。

```bash
curl -sS -X POST 'https://open.cli.im/api/v2/rpc/templates/previewEdit' \
  -H "Authorization: Bearer ${CAOLIAO_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "template_id": "6801234",
  "template_version": "v_7c1e0f5a9b3d4e6f8a0b2c4d6e8f0a1b3c5d7e9f1a2b4c6d8e0f1a3b5c7d9e0f",
  "patch": {
    "name": "设备档案（2026）"
  }
}'
```

## 响应

成功时 HTTP 状态码为 200，顶层 `code` 为 `0`，结果在 `data` 里。失败时的返回见[错误码与调用额度](https://cli.im/open-api/openapi/v2/error-codes.md)和[业务错误码](https://cli.im/open-api/openapi/v2/error-catalog.md)。

| 字段 | 类型 | 一定返回 | 说明 |
|---|---|---|---|
| `data.preview_token` | string | 是 | 预览令牌，10 分钟内有效。修改会影响已有子码时，提交 templates/edit 必须带上 |
| `data.expires_at` | integer | 是 | 预览令牌的过期时间（Unix 秒） |
| `data.affected_count` | integer | 是 | 会受这次修改影响的子码数量 |
| `data.template_version` | string | 是 | 预览所基于的模板版本 |
| `data.preview` | object | 是 | 应用修改后的模板结构，尚未保存 |
| `data.preview.template_id` | string | 是 | 模板 ID |
| `data.preview.coding` | string | 是 | 模板的短编号 |
| `data.preview.web_url` | string | 是 | 模板的扫码地址 |
| `data.preview.project_id` | integer | 是 | 模板所在分区 ID，0 为默认分区 |
| `data.preview.category_id` | integer | 是 | 模板所在目录 ID |
| `data.preview.name` | string | 是 | 模板名称 |
| `data.preview.template_version` | string | 是 | 模板版本。预校验、提交和修改时原样传回；模板变化后需要重新读取 |
| `data.preview.groups` | object[] | 是 | 字段分组 |
| `data.preview.groups[].group_id` | string | 是 | 分组 ID |
| `data.preview.groups[].name` | string | 是 | 分组名称 |
| `data.preview.groups[].fields` | object[] | 是 | 分组内的字段 |
| `data.preview.groups[].fields[].field_id` | string | 是 | 字段 ID，填值时作为 values 的键 |
| `data.preview.groups[].fields[].name` | string | 是 | 字段名称 |
| `data.preview.groups[].fields[].type` | string | 是 | 字段类型：text 单行文本、textarea 多行文本、number 数字、date 日期、image 图片、file 附件 |
| `data.preview.groups[].fields[].variable` | boolean | 是 | true 表示每个码各自填写；false 表示所有码共用同一内容（公共字段） |
| `data.preview.groups[].fields[].required` | boolean | 是 | 是否必填 |
| `data.preview.groups[].fields[].max_length` | integer | 否 | 文本类字段的最大长度 |
| `data.preview.groups[].fields[].max_count` | integer | 否 | 图片、附件字段最多可放的文件数 |
| `data.preview.groups[].fields[].example` | any | 否 | 该类型字段的取值示例 |
| `data.preview.groups[].fields[].public_value` | any | 否 | 公共字段的当前内容；图片、附件以 [{"existing_resource_id": ...}] 引用已有文件，修改时原样传回即保留 |
| `data.preview.name_rule` | any[] | 是 | 子码命名规则，按顺序拼接；没有规则时为空数组 |
| `data.preview.unsupported_fields` | object[] | 是 | 模板里不能通过接口填写的字段 |
| `data.preview.unsupported_fields[].field_id` | string | 是 | 字段 ID |
| `data.preview.unsupported_fields[].name` | string | 是 | 字段名称 |
| `data.preview.unsupported_fields[].type` | string | 是 | 字段类型 |
| `data.preview.unsupported_fields[].variable` | boolean | 是 | 是否每个码各自填写 |
| `data.preview.unsupported_fields[].required` | boolean | 是 | 是否必填 |
| `data.preview.capabilities` | object | 是 | 这个模板支持的操作 |
| `data.preview.capabilities.types` | string[] | 是 | 可填写的字段类型 |
| `data.preview.capabilities.delete_field` | boolean | 是 | 是否可以删除字段，目前固定为 false |
| `data.preview.capabilities.change_type` | boolean | 是 | 是否可以修改字段类型，目前固定为 false |
| `data.preview.capabilities.edit` | boolean | 是 | 是否可以通过 templates/edit 修改名称和字段 |
| `data.preview.capabilities.create_children` | boolean | 是 | 是否可以用它批量建码 |
| `data.preview.capabilities.replace_components` | boolean | 是 | 是否可以通过 templates/edit 的 patch.components 修改正文图文组件 |
| `data.preview.capabilities.unsupported_reasons` | string[] | 是 | 不支持某些操作的原因 |
| `data.preview.capabilities.blockers` | object[] | 是 | 阻止批量建码的问题；为空表示可以建码 |
| `data.preview.capabilities.blockers[].code` | string | 是 | 错误码，含义见规范顶层的 x-error-catalog |
| `data.preview.capabilities.blockers[].path` | string | 否 | 出错字段在请求体中的位置，如 items.0.values.12345；没有具体位置时为空字符串 |
| `data.preview.capabilities.blockers[].item_key` | string | 否 | 批量数据中出错那一项的 item_key；不针对某一项时为空字符串 |
| `data.preview.capabilities.blockers[].retryable` | boolean | 否 | 原样重试是否可能成功 |
| `data.preview.capabilities.blockers[].next_action` | string | 否 | 建议的下一步：correct_input 修正入参；retry_later 稍后重试；retry_same_idempotency_key 用原幂等键重试；inspect_created_qrcode、inspect_created_form、inspect_result 先读取已保存的内容核对 |
| `data.preview.capabilities.blockers[].message` | string | 否 | 补充说明，部分错误才有 |
| `data.preview.components` | object[] | 是 | 页面上可通过接口管理的图文组件，按页面顺序 |
| `data.preview.components[].ref` | string | 否 | 组件引用，如 c_123。修改时用 {"type":"keep","ref":...} 保留该组件，或在新内容上带 ref 原地替换 |
| `data.preview.components[].type` | string | 是 | 组件类型：basic_info 基础信息；rich_text 富文本；gallery 图片或图集；file 文件；button 链接按钮。可选值：`basic_info`、`rich_text`、`gallery`、`file`、`button` |
| `data.preview.components[].html` | string | 否 | rich_text：保存后的富文本 HTML |
| `data.preview.components[].items` | object[] | 否 | gallery：图片列表 |
| `data.preview.components[].items[].url` | string | 是 | 图片地址 |
| `data.preview.components[].url` | string | 否 | file：文件地址；button：跳转地址 |
| `data.preview.components[].name` | string | 否 | file：文件名 |
| `data.preview.components[].text` | string | 否 | button：按钮文字 |
| `data.component_changes` | any | 否 | 正文图文组件的新增、替换和删除清单；patch 里有 components 时返回 |

### 响应示例

```json
{
  "code": 0,
  "message": "ok",
  "data": {
    "preview_token": "1795000600.4be1c0d9a7f35e2861c40b7d9e1f3a5c7092b4d6e8f0a1c3e5f7092b4d6e8f0a",
    "expires_at": 1795000600,
    "affected_count": 12,
    "template_version": "v_7c1e0f5a9b3d4e6f8a0b2c4d6e8f0a1b3c5d7e9f1a2b4c6d8e0f1a3b5c7d9e0f",
    "preview": {
      "template_id": "6801234",
      "coding": "qTpl001",
      "web_url": "https://qr61.cn/oAbCdE/qTpl001",
      "project_id": 0,
      "category_id": 120045,
      "name": "设备档案（2026）",
      "template_version": "v_7c1e0f5a9b3d4e6f8a0b2c4d6e8f0a1b3c5d7e9f1a2b4c6d8e0f1a3b5c7d9e0f",
      "groups": [
        {
          "group_id": "g_901_0",
          "name": "设备信息",
          "fields": [
            {
              "field_id": "71399639089153",
              "name": "设备名称",
              "type": "text",
              "variable": true,
              "required": true,
              "max_length": 2000,
              "max_count": 10,
              "example": "001"
            },
            {
              "field_id": "71399639089154",
              "name": "设备照片",
              "type": "image",
              "variable": true,
              "required": false,
              "max_length": 20000,
              "max_count": 10,
              "example": []
            }
          ]
        }
      ],
      "name_rule": [
        {
          "type": "cmpId",
          "value": "71399639089153"
        }
      ],
      "unsupported_fields": [],
      "capabilities": {
        "types": [
          "text",
          "textarea",
          "number",
          "date",
          "image",
          "file"
        ],
        "delete_field": false,
        "change_type": false,
        "edit": true,
        "create_children": true,
        "unsupported_reasons": [],
        "blockers": [],
        "replace_components": true
      },
      "components": [
        {
          "ref": "c_901",
          "type": "basic_info"
        }
      ]
    }
  }
}
```

## 常见错误

`TEMPLATE_NOT_FOUND`、`TEMPLATE_LOCKED`、`PERMISSION_DENIED`、`TEMPLATE_VERSION_CONFLICT`、`TEMPLATE_EDIT_UNSUPPORTED`、`ORG_TEMPLATE_MANAGED`、`AI_EDIT_NOT_AI_CREATED`、`AI_EDIT_SCOPE_REQUIRED`、`DESTRUCTIVE_FIELD_CHANGE_UNSUPPORTED`、`INVALID_COMPONENT_REF`。含义和处理方式见[业务错误码](https://cli.im/open-api/openapi/v2/error-catalog.md)。

---

本页由 [openapi.json](https://cli.im/open-api/openapi/v2/overview.md#%E6%8E%A5%E5%8F%A3%E8%A7%84%E8%8C%83-openapi-json) 生成。全部接口见[接口清单](https://cli.im/open-api/openapi/v2/api-index.md)。
