# 分页查询周期计划

分页查找周期计划。project_id=0 只查默认分区；默认 frequency=day；plan_scope 按计划生命周期筛选（running 含生效中和尚未开始，closed 为暂停，finished 为计划已结束）；keyword 匹配计划名称。

## 请求

```text
POST https://open.cli.im/api/v2/rpc/cyclePlans/list
```

| 项目 | 要求 |
|---|---|
| 最低权限 | 只读，见[权限档位](https://cli.im/open-api/openapi/v2/auth.md#org-policy) |
| 需要的 scope | `records.read` |
| 组织 Key | 不能调用，返回 403 `credential_type_not_allowed`，见[历史组织 Key](https://cli.im/open-api/openapi/v2/auth.md#org-key) |

## 请求参数

请求体为 JSON。

| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| `project_id` | integer | 否 | 要查询的分区 ID，0 为默认分区（不代表全部分区）。默认 `0` |
| `frequency` | string | 否 | 周期频次：day（默认，含按工作日执行的计划）、week、month、year。要列出全部计划需要分别查询四种频次。可选值：`day`、`week`、`month`、`year`。默认 `"day"` |
| `plan_scope` | string | 否 | 计划所处阶段：running（默认）已启用且未结束，包含 active 和 not_started；active 已开始且生效中；not_started 已启用但未到开始时间；closed 已暂停；finished 计划已结束（不代表各周期的任务都已完成）。它与 cycleTasks/listQrcodes 的 status（某个周期内各码的完成状态）不是同一个概念。可选值：`running`、`active`、`not_started`、`closed`、`finished`。默认 `"running"` |
| `keyword` | string | 否 | 按计划名称包含匹配；计划未命名时匹配表单名称。不匹配码名称或填写内容。最长 64 个字符 |
| `form_id` | string | 否 | 只返回使用这张表单的计划 |
| `page` | integer | 否 | 页码，从 1 开始。默认 `1`。范围 1–10000 |
| `page_size` | integer | 否 | 每页条数。默认 `20`。范围 1–50 |

## 请求示例

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

```bash
curl -sS -X POST 'https://open.cli.im/api/v2/rpc/cyclePlans/list' \
  -H "Authorization: Bearer ${CAOLIAO_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "project_id": 0,
  "frequency": "day",
  "plan_scope": "running",
  "page": 1,
  "page_size": 20
}'
```

## 响应

成功时 HTTP 状态码为 200，顶层 `code` 为 `0`，结果在 `data` 里。失败时的返回见[错误码与调用额度](https://cli.im/open-api/openapi/v2/error-codes.md)和[业务错误码](https://cli.im/open-api/openapi/v2/error-catalog.md)。

| 字段 | 类型 | 一定返回 | 说明 |
|---|---|---|---|
| `data.list` | object[] | 是 | 周期计划 |
| `data.list[].plan_id` | string | 是 | 周期计划 ID |
| `data.list[].form_id` | string | 是 | 计划使用的表单 ID |
| `data.list[].name` | string | 是 | 计划名称；未命名时为表单名称 |
| `data.list[].form_name` | string | 是 | 表单名称 |
| `data.list[].frequency` | string | 是 | 周期频次：day 每日、week 每周、month 每月、year 每年 |
| `data.list[].execute_status` | any | 否 | 计划的执行状态 |
| `data.list[].display_status` | any | 否 | 计划的展示状态 |
| `data.list[].required_times` | any | 否 | 每个周期要求完成的次数 |
| `data.list[].code_total` | any | 否 | 计划覆盖的码数量 |
| `data.list[].current_period` | any | 否 | 当前周期的概况；没有时不返回 |
| `data.list[].previous_period` | any | 否 | 上一周期的概况；没有时不返回 |
| `data.pagination` | object | 是 | 分页信息 |
| `data.pagination.page` | integer | 是 | 当前页码，从 1 开始 |
| `data.pagination.page_size` | integer | 是 | 每页条数 |
| `data.pagination.total` | integer | 是 | 符合条件的总条数 |
| `data.pagination.has_more` | boolean | 是 | 是否还有下一页。为 true 时即使当前页为空也应继续翻页 |
| `data.server_time` | any | 是 | 服务器当前时间 |

### 响应示例

```json
{
  "code": 0,
  "message": "ok",
  "data": {
    "list": [
      {
        "plan_id": "40021",
        "form_id": "122507",
        "name": "空压机日检",
        "form_name": "设备巡检",
        "frequency": "day",
        "execute_status": 1,
        "display_status": "running",
        "required_times": 1,
        "code_total": 12
      }
    ],
    "pagination": {
      "page": 1,
      "page_size": 20,
      "total": 1,
      "has_more": false
    },
    "server_time": "2026-11-18 10:00:00"
  }
}
```

## 常见错误

`PERMISSION_DENIED`、`CYCLE_QUERY_REJECTED`、`CYCLE_QUERY_UNAVAILABLE`。含义和处理方式见[业务错误码](https://cli.im/open-api/openapi/v2/error-catalog.md)。

---

本页由 [openapi.json](https://cli.im/open-api/openapi/v2/overview.md#%E6%8E%A5%E5%8F%A3%E8%A7%84%E8%8C%83-openapi-json) 生成。全部接口见[接口清单](https://cli.im/open-api/openapi/v2/api-index.md)。
