Pipefy HTML 接口技能用于操作“HTML 接口”——这是一种页面,其唯一元素是 customCode 元素,该元素包含一个 HTML 文档,并可声明数据源(管道或表格),HTML 通过源 ID 读取这些数据。写入 HTML 即发布,没有草稿状态。\n\n主要用途:\n- 创建展示实时数据(如开放请求、仪表板)的独立页面。\n- 修改现有 HTML 接口的布局、文案、颜色等。\n- 为页面添加表格或管道作为数据源。\n- 列出组织的 HTML 接口,或读取某个接口的 HTML 内容。\n\n主要能力(工具与操作):\n- get_interface_html_guidelines(只读):获取 HTML 必须遵守的规则、数据绑定属性(data-pfy-*)词汇表及过滤器格式;可选包含设计系统目录。\n- list_interface_repos(只读):列出可作为数据源的已发布管道和表格(需为管理员)。\n- get_interface_repo_fields(只读):获取管道或表格的自定义字段,用于选择源字段键。\n- list_interfaces(只读):列出组织的 HTML 接口及其可见性。\n- get_interface_html(只读):获取指定接口的页面、元素、数据源和实时 HTML。\n- create_html_interface(写入):创建接口并写入第一页,可附带数据源。\n- set_interface_sources(写入):替换某个元素的数据源。\n- write_interface_html(写入):替换并发布某个元素的 HTML。\n\n使用方式:\n1. 先调用 get_interface_html_guidelines 获取规则(若需要样式则附带 include_design_system=true)。\n2. 检查名称是否已被占用(list_interfaces)。\n3. 如需实时数据,用 list_interface_repos 列出候选仓库,再用 get_interface_repo_fields 获取字段。\n4. 按规则编写 HTML,并正确绑定数据源 ID。\n5. 创建接口:create_html_interface(需要组织 ID、名称、HTML、数据源列表)。数据源格式为 {"id", "name", "repoId", "fieldKeys", "filters"},每个源可包含 1 到 30 个字段键,每个元素最多 10 个源。\n6. 修改现有页面:先 list_interfaces 找到接口,再用 get_interface_html 读取;用 set_interface_sources 更新数据源(需发送完整列表);用 write_interface_html 写入新 HTML(写入前再次读取,若 contentHash 变化则需重新开始)。\n\n适用场景:\n- 构建基于管道数据的自定义仪表板页面。\n- 调整 HTML 接口的视觉样式或内容。\n- 为页面添加或移除数据源。\n\n限制与前提:\n- HTML 接口功能需由 Pipefy 为组织启用,组织管理员无法自行开启。\n- 需要组织的数字 ID(list_interface_repos 仅接受数字 ID,create_html_interface 和 list_interfaces 可接受数字 ID 或 UUID)。\n- 需要调用者对所展示的管道和表格具有管理员权限。\n- 每次写入都是即时生效的;超出用户明确请求的更改需先获得批准。\n- HTML 读取的源 ID 必须在元素中声明,否则该部分渲染为空白且无错误提示。\n- 写入被拒绝时不会存储任何内容,需根据错误列表修复所有违规后重试。\n- 此技能不适用于主门户、网格布局页面或子门户(应使用 pipefy-portal-setup),也不适用于管理管道、字段和卡片本身(应使用 pipefy-pipes-and-cards)。\n- 若用户仅说“页面”而含义不明,应先询问是独立 HTML 页面还是主门户内的页面。
pipefy-html-interfaces
前端与建站
更新于 10-27 11:55