# 创建填写表单及可选周期

创建填写表单，支持基础字段、单选计分和可选的日/周/月/年周期。需要幂等键 idempotency_key；返回的 form_id 和 field_mapping 用于后续建码绑定。partial_success 表示表单已建成但部分设置未确认，不要重复创建。

## 请求

```text
POST https://open.cli.im/api/v2/rpc/forms/create
```

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

## 请求参数

请求体为 JSON。

| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| `idempotency_key` | string | 是 | 幂等键，由调用方生成，1 到 128 位，只能包含字母、数字和 _ . : -。同一个键重复提交会返回第一次的结果，不会重复创建；请求超时或结果不明时用原键和原参数重试，新的请求换一个新键。最长 128 个字符 |
| `project_id` | integer | 否 | 分区 ID，0 为默认分区（不代表全部分区）。可用的分区用 qrcodes/listCreateTargets 查询。默认 `0` |
| `name` | string | 是 | 表单名称。最长 100 个字符 |
| `fields` | object[] | 是 | 表单字段，1 到 100 个，field_id 不能重复。至少 1 项。最多 100 项 |
| `fields[].field_id` | string | 是 | 字段标识，由调用方自定（字母、数字、下划线、短横线）；保存后的字段 ID 见返回的 field_mapping。最长 128 个字符 |
| `fields[].name` | string | 是 | 字段名称。最长 100 个字符 |
| `fields[].type` | string | 是 | 字段类型：text 单行文本、textarea 多行文本、number 数字、date 日期、radio 单选、checkbox 多选、image 图片、file 附件。可选值：`text`、`textarea`、`number`、`date`、`radio`、`checkbox`、`image`、`file` |
| `fields[].required` | boolean | 否 | 是否必填，默认 false。默认 `false` |
| `fields[].options` | string[] | 否 | radio、checkbox 的选项文字，不能重复；其他类型不能传。至少 1 项。最多 100 项 |
| `fields[].scoring` | object | 否 | 计分设置，仅 radio 支持；判断题用两个选项。配置后提交页会显示得分和本次答案 |
| `fields[].scoring.correct_option` | string | 是 | 正确选项，必须与 options 中的某一项完全一致。最长 200 个字符 |
| `fields[].scoring.points` | integer | 是 | 答对分值，1～100 整数。范围 1–100 |
| `cycle` | object | 否 | 周期设置；不按周期填写时不要传这个字段 |
| `cycle.frequency` | string | 是 | 周期频次：day 每日、week 每周、month 每月、year 每年。可选值：`day`、`week`、`month`、`year` |
| `cycle.windows` | object[] | 是 | 每个周期内要求填写的时段，1 到 20 个，不能重复。至少 1 项。最多 20 项 |
| `cycle.windows[].start` | object | 是 | — |
| `cycle.windows[].start.time` | string | 是 | 时刻，格式 HH:mm |
| `cycle.windows[].start.weekday` | integer | 否 | 星期几，1 到 7；frequency 为 week 时必填，其他频次不能传。范围 1–7 |
| `cycle.windows[].start.day` | integer | 否 | 几号，1 到 31；frequency 为 month 或 year 时必填，其他频次不能传。范围 1–31 |
| `cycle.windows[].start.month` | integer | 否 | 月份，1 到 12；frequency 为 year 时必填，其他频次不能传。范围 1–12 |
| `cycle.windows[].end` | object | 是 | — |
| `cycle.windows[].end.time` | string | 是 | 时刻，格式 HH:mm |
| `cycle.windows[].end.weekday` | integer | 否 | 星期几，1 到 7；frequency 为 week 时必填，其他频次不能传。范围 1–7 |
| `cycle.windows[].end.day` | integer | 否 | 几号，1 到 31；frequency 为 month 或 year 时必填，其他频次不能传。范围 1–31 |
| `cycle.windows[].end.month` | integer | 否 | 月份，1 到 12；frequency 为 year 时必填，其他频次不能传。范围 1–12 |

## 请求示例

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

```bash
curl -sS -X POST 'https://open.cli.im/api/v2/rpc/forms/create' \
  -H "Authorization: Bearer ${CAOLIAO_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "idempotency_key": "form-inspection-001",
  "project_id": 0,
  "name": "设备巡检",
  "fields": [
    {
      "field_id": "inspector",
      "name": "巡检人",
      "type": "text",
      "required": true
    },
    {
      "field_id": "result",
      "name": "巡检结果",
      "type": "radio",
      "required": true,
      "options": [
        "正常",
        "异常"
      ]
    }
  ],
  "cycle": {
    "frequency": "day",
    "windows": [
      {
        "start": {
          "time": "08:00"
        },
        "end": {
          "time": "18:00"
        }
      }
    ]
  }
}'
```

## 响应

成功时 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.form_id` | string | 是 | 表单 ID |
| `data.project_id` | integer | 是 | 表单所在分区 ID |
| `data.status` | string | 是 | 处理结果：succeeded 全部成功；partial_success 主体已保存，但有未确认的部分，见 errors。可选值：`succeeded`、`partial_success` |
| `data.field_mapping` | object | 是 | 请求中的 field_id 到保存后字段 ID 的对应关系，后续填值和修改都用保存后的字段 ID |
| `data.cycle` | object | 是 | 周期计划；请求里没有 cycle 或周期未确认保存时为 null |
| `data.cycle.plan_id` | string | 是 | 周期计划 ID |
| `data.cycle.frequency` | string | 是 | 周期频次 |
| `data.errors` | object[] | 是 | 未成功或未确认的部分；全部成功时为空数组 |
| `data.errors[].code` | string | 是 | 错误码，含义见规范顶层的 x-error-catalog |
| `data.errors[].path` | string | 否 | 出错字段在请求体中的位置，如 items.0.values.12345；没有具体位置时为空字符串 |
| `data.errors[].item_key` | string | 否 | 批量数据中出错那一项的 item_key；不针对某一项时为空字符串 |
| `data.errors[].retryable` | boolean | 否 | 原样重试是否可能成功 |
| `data.errors[].next_action` | string | 否 | 建议的下一步：correct_input 修正入参；retry_later 稍后重试；retry_same_idempotency_key 用原幂等键重试；inspect_created_qrcode、inspect_created_form、inspect_result 先读取已保存的内容核对 |
| `data.errors[].message` | string | 否 | 补充说明，部分错误才有 |

### 响应示例

```json
{
  "code": 0,
  "message": "ok",
  "data": {
    "form_id": "122507",
    "project_id": 0,
    "status": "succeeded",
    "field_mapping": {
      "inspector": "71399639090001",
      "result": "71399639090002"
    },
    "cycle": {
      "plan_id": "40021",
      "frequency": "day"
    },
    "errors": []
  }
}
```

## 常见错误

`PERMISSION_DENIED`、`ACCESS_LEVEL_READ_ONLY`、`quota_exceeded`、`IDEMPOTENCY_CONFLICT`、`IDEMPOTENCY_IN_PROGRESS`、`IDEMPOTENCY_OUTCOME_UNKNOWN`、`CYCLE_SAVE_UNCONFIRMED`、`QUIZ_SAVE_UNCONFIRMED`、`AI_ORIGIN_MARK_FAILED`。含义和处理方式见[业务错误码](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)。
