Skip to content

修改表单的名称或字段 ​

修改表单的名称或字段。需要 forms/getEditState 返回的 version 和幂等键 idempotency_key。fields 是完整快照:可改名称、必填、顺序,可追加字段和选项,不能删字段、删选项或改类型。

请求 ​

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

相关调用流程:修改和删除码、表单。

请求参数 ​

请求体为 JSON。

字段类型必填说明
versionstring是forms/getEditState 返回的 version。读取之后内容被改动过会返回 FORM_VERSION_CONFLICT,需要重新读取。最长 128 个字符
idempotency_keystring是幂等键,由调用方生成,1 到 128 位,只能包含字母、数字和 _ . : -。同一个键重复提交会返回第一次的结果,不会重复创建;请求超时或结果不明时用原键和原参数重试,新的请求换一个新键。最长 128 个字符
namestring否新的表单名称;不传保持原值。最长 100 个字符
form_idstring是表单 ID。最长 128 个字符
fieldsobject[]否字段的完整清单:已有字段用 forms/getEditState 返回的 field_id,新字段用新的自定标识。不能删除字段、删除选项或修改类型。不传保持原值。至少 1 项。最多 100 项
fields[].field_idstring是字段标识。已有字段用 forms/getEditState 返回的 field_id;新字段由调用方自定,保存后的字段 ID 见返回的 field_mapping。最长 128 个字符
fields[].namestring是字段名称。最长 100 个字符
fields[].typestring是字段类型:text 单行文本、textarea 多行文本、number 数字、date 日期、radio 单选、checkbox 多选、image 图片、file 附件。可选值:text、textarea、number、date、radio、checkbox、image、file
fields[].requiredboolean否是否必填,默认 false。默认 false
fields[].optionsstring[]否radio、checkbox 的选项文字,不能重复;其他类型不能传。至少 1 项。最多 100 项
fields[].scoringobject否计分设置,仅 radio 支持;判断题用两个选项。配置后提交页会显示得分和本次答案
fields[].scoring.correct_optionstring是正确选项,必须与 options 中的某一项完全一致。最长 200 个字符
fields[].scoring.pointsinteger是答对分值,1~100 整数。范围 1–100

请求示例 ​

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

bash
curl -sS -X POST 'https://open.cli.im/api/v2/rpc/forms/edit' \
  -H "Authorization: Bearer ${CAOLIAO_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "form_id": "122507",
  "version": "c_5f2b9c0e7a1d4c3b8e6f0a9d2c4b6e8f1a3c5e7090b1d2f3a4c5e6f708192a3b",
  "idempotency_key": "form-inspection-edit-001",
  "fields": [
    {
      "field_id": "71399639090001",
      "name": "巡检人",
      "type": "text",
      "required": true
    },
    {
      "field_id": "71399639090002",
      "name": "巡检结果",
      "type": "radio",
      "required": true,
      "options": [
        "正常",
        "异常"
      ]
    },
    {
      "field_id": "remark",
      "name": "备注",
      "type": "textarea"
    }
  ]
}'

响应 ​

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

字段类型一定返回说明
data.form_idstring是表单 ID
data.namestring是保存后的表单名称
data.versionstring是保存后的内容版本;保存后未能读回时为 null
data.field_mappingobject是请求中的 field_id 到保存后字段 ID 的对应关系,后续填值和修改都用保存后的字段 ID
data.statusstring是处理结果:succeeded 全部成功;partial_success 主体已保存,但有未确认的部分,见 errors。可选值:succeeded、partial_success
data.errorsobject[]是未成功或未确认的部分;全部成功时为空数组
data.errors[].codestring是错误码,含义见规范顶层的 x-error-catalog
data.errors[].pathstring否出错字段在请求体中的位置,如 items.0.values.12345;没有具体位置时为空字符串
data.errors[].item_keystring否批量数据中出错那一项的 item_key;不针对某一项时为空字符串
data.errors[].retryableboolean否原样重试是否可能成功
data.errors[].next_actionstring否建议的下一步:correct_input 修正入参;retry_later 稍后重试;retry_same_idempotency_key 用原幂等键重试;inspect_created_qrcode、inspect_created_form、inspect_result 先读取已保存的内容核对
data.errors[].messagestring否补充说明,部分错误才有
data.warningsobject[]是不影响结果的提示;没有时为空数组
data.warnings[].codestring是提示码
data.warnings[].messagestring否提示说明
data.warnings[].pathstring否相关字段在请求体中的位置
data.warnings[].next_actionstring否建议的下一步

响应示例 ​

json
{
  "code": 0,
  "message": "ok",
  "data": {
    "form_id": "122507",
    "name": "设备巡检",
    "version": "c_9e8d7c6b5a4f30211223344556677889900aabbccddeeff00112233445566778",
    "field_mapping": {
      "remark": "71399639090003"
    },
    "status": "succeeded",
    "errors": [],
    "warnings": []
  }
}

常见错误 ​

PERMISSION_DENIED、ACCESS_LEVEL_READ_ONLY、AI_EDIT_NOT_AI_CREATED、AI_EDIT_SCOPE_REQUIRED、IDEMPOTENCY_CONFLICT、IDEMPOTENCY_IN_PROGRESS、IDEMPOTENCY_OUTCOME_UNKNOWN、FORM_NOT_FOUND、FORM_VERSION_CONFLICT、DESTRUCTIVE_FIELD_CHANGE_UNSUPPORTED、FORM_CONTENT_UNCONFIRMED。含义和处理方式见业务错误码。


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