lark-base-form-get.md 1.6 KB

base +form-get

前置条件: 先阅读 ../lark-shared/SKILL.md 了解认证、全局参数和安全规则。

获取多维表格数据表中指定表单的详情。只读操作,不修改任何数据。

命令

# 获取表单详情
lark-cli base +form-get \
  --base-token <base_token> \
  --table-id <table_id> \
  --form-id <form_id>

# 以 pretty 格式展示
lark-cli base +form-get \
  --base-token <base_token> \
  --table-id <table_id> \
  --form-id <form_id> \
  --format pretty

# 使用应用身份(bot)
lark-cli base +form-get \
  --base-token <base_token> \
  --table-id <table_id> \
  --form-id <form_id> \
  --as bot

参数

参数 必填 说明
--base-token <token> 多维表格 App token(base_token)
--table-id <id> 数据表 ID
--form-id <id> 表单 ID
--format 输出格式:json(默认)| pretty | table | ndjson | csv
--as 身份:user(默认)| bot
--dry-run 预览 API 调用,不执行

输出格式

字段 说明
id 表单 ID
name 表单名称
description 表单描述
{
  "ok": true,
  "data": {
    "id": "vewX58te9D",
    "name": "用户调研问卷",
    "description": "2024年度用户满意度调研"
  }
}

提示

  • form_id 可通过 lark-cli base +form-list --base-token <token> --table-id <id> 获取

参考