Skip to content

读取周期计划详情 ​

读取指定周期计划的表单、执行状态、周期配置及本期、上期概况。plan_id 和 plan_scope 沿用 cyclePlans/list 的结果;更长时间范围用 cycleTasks/getCompletion。

请求 ​

text
POST https://open.cli.im/api/v2/rpc/cyclePlans/get
项目要求
最低权限只读,见权限档位
需要的 scoperecords.read
组织 Key不能调用,返回 403 credential_type_not_allowed,见历史组织 Key

请求参数 ​

请求体为 JSON。

字段类型必填说明
project_idinteger否计划所在分区 ID,0 为默认分区。默认 0
plan_idstring是周期计划 ID,取自 cyclePlans/list
plan_scopestring否计划所处阶段:running(默认)已启用且未结束,包含 active 和 not_started;active 已开始且生效中;not_started 已启用但未到开始时间;closed 已暂停;finished 计划已结束(不代表各周期的任务都已完成)。它与 cycleTasks/listQrcodes 的 status(某个周期内各码的完成状态)不是同一个概念。可选值:running、active、not_started、closed、finished。默认 "running"

请求示例 ​

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

bash
curl -sS -X POST 'https://open.cli.im/api/v2/rpc/cyclePlans/get' \
  -H "Authorization: Bearer ${CAOLIAO_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "project_id": 0,
  "plan_id": "40021",
  "plan_scope": "running"
}'

响应 ​

成功时 HTTP 状态码为 200,顶层 code 为 0,结果在 data 里。失败时的返回见错误码与调用额度和业务错误码。

字段类型一定返回说明
data.planobject是周期计划详情
data.plan.plan_idstring是周期计划 ID
data.plan.form_idstring是计划使用的表单 ID
data.plan.namestring是计划名称;未命名时为表单名称
data.plan.form_namestring是表单名称
data.plan.frequencystring是周期频次:day 每日、week 每周、month 每月、year 每年
data.plan.execute_statusany否计划的执行状态
data.plan.display_statusany否计划的展示状态
data.plan.required_timesany否每个周期要求完成的次数
data.plan.code_totalany否计划覆盖的码数量
data.plan.current_periodany否当前周期的概况;没有时不返回
data.plan.previous_periodany否上一周期的概况;没有时不返回
data.plan.cycle_task_configany否周期配置:频次、时段等
data.plan.completion_rule_textany否完成规则的文字说明
data.server_timeany是服务器当前时间

响应示例 ​

json
{
  "code": 0,
  "message": "ok",
  "data": {
    "plan": {
      "plan_id": "40021",
      "form_id": "122507",
      "name": "空压机日检",
      "form_name": "设备巡检",
      "frequency": "day",
      "execute_status": 1,
      "display_status": "running",
      "required_times": 1,
      "code_total": 12,
      "completion_rule_text": "每天完成 1 次"
    },
    "server_time": "2026-11-18 10:00:00"
  }
}

常见错误 ​

PERMISSION_DENIED、CYCLE_QUERY_REJECTED、CYCLE_QUERY_UNAVAILABLE、CYCLE_PLAN_NOT_FOUND。含义和处理方式见业务错误码。


本页由 openapi.json 生成。全部接口见接口清单。