Files

1.9 KiB

创建在线文字文档

本页只处理钉钉在线文字文档(adoc)创建。普通文件上传走 dingtalk-drive,表格和多维表分别走对应产品。

唯一推荐入口

dws doc +create --name "<文档名>" [--content "短文本"] [--folder <ID> | --workspace <ID>] --format json
dws doc +create --name "<文档名>" --content @body.md --format json
dws doc +create --name "<文档名>" --content @body.json --doc-format jsonml --format json
  • 统一输入协议:已有或临时文件先暂存到当前工作目录后传 @相对文件;单次生成文本可用 --content - 从 stdin 读取。
  • @file 禁止绝对路径和 .. 逃逸;不要直接引用宿主临时目录。
  • --name 是文档名称,不等于正文中的 heading。用户明确要求“正文一级标题”时,正文仍须包含对应 H1。
  • JSONML 顶层必须是数组;仅在确实需要富结构时加载 JSONML cookbook。

+create 负责创建、长 Markdown 分片和最终回读验证。正常成功结果至少包含:

{
  "status": "success",
  "complete": true,
  "data": {
    "nodeId": "...",
    "verified": true
  }
}

结果处理

  • status=success 且 verified=true:可以报告创建完成,并保留真实 nodeId/URL。
  • status=partial_success:文档或部分分片已经创建;按 steps 回读现状,禁止重跑整条创建。
  • status=unknown:服务端可能已经提交;先定位并读取文档,禁止自动重试。
  • 没有真实 nodeId 或写回执时,禁止声称“已创建”。

高级通道

只有 shortcut 未公开所需的底层参数或需要原始响应时,才读取精确 leaf Schema 后使用 dws doc create。不要因为熟悉旧参数就默认退回原子命令,也不要使用已删除的 Python 创建脚本。

复杂排版按需读取 doc-style-guideline.md;命令选路仍以本页的 +create 为准。