2.1 KiB
2.1 KiB
okr +progress-get
前置条件: 先阅读
lark-shared/SKILL.md了解认证、全局参数和安全规则。
根据进展记录 ID 获取单条 OKR 进展记录。
推荐命令
# 获取指定 ID 的进展记录
lark-cli okr +progress-get --progress-id 1234567890123456789
# 使用特定的用户 ID 类型
lark-cli okr +progress-get --progress-id 1234567890123456789 --user-id-type open_id
# 预览 API 调用而不实际执行
lark-cli okr +progress-get --progress-id 1234567890123456789 --dry-run
参数
| 参数 | 必填 | 默认值 | 说明 |
|---|---|---|---|
--progress-id |
是 | — | 进展记录 ID(int64 类型,正整数) |
--user-id-type |
否 | open_id |
用户 ID 类型:open_id | union_id | user_id |
--dry-run |
否 | — | 预览 API 调用而不实际执行。 |
--format |
否 | json |
输出格式。 |
工作流程
- 获取目标进展记录的 ID。可通过
+cycle-detail获取目标和关键结果后,从中获取进展记录 ID。 - 执行
lark-cli okr +progress-get --progress-id "1234567890123456789"。 - 报告结果:进展记录的 ID、修改时间、进度百分比和内容。
输出
返回 JSON:
{
"progress": {
"progress_id": "1234567890123456789",
"modify_time": "2025-01-15 10:30:00",
"content": "{...}",
"progress_rate": {
"percent": 75.0,
"status": "normal"
}
}
}
其中:
content字段是 JSON 字符串,为 OKR ContentBlock 富文本格式。请参考 lark-okr-contentblock.md 了解详细信息。progress_rate.status返回可读字符串:normal(正常)、overdue(逾期)、done(已完成)。
参考
- lark-okr -- 所有 OKR 命令(shortcut 和 API 接口)
- lark-shared -- 认证和全局参数