Skip to content

修改表单之前读取字段、版本和是否可改 ​

修改表单之前先调用:返回字段(field_id 为持久 ID)、version、editable 和 reason。默认只能修改通过接口创建的表单;修改人工创建的内容需要“完全”档凭证。

请求 ​

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

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

请求参数 ​

请求体为 JSON。

字段类型必填说明
form_idstring是表单 ID。最长 128 个字符

请求示例 ​

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

bash
curl -sS -X POST 'https://open.cli.im/api/v2/rpc/forms/getEditState' \
  -H "Authorization: Bearer ${CAOLIAO_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "form_id": "122507"
}'

响应 ​

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

字段类型一定返回说明
data.form_idstring是表单 ID
data.namestring是表单名称
data.fieldsobject[]是表单字段,按表单顺序
data.fields[].field_idstring是字段 ID
data.fields[].namestring是字段名称
data.fields[].typestring是字段类型,如 text、textarea、number、date、radio、checkbox、image、file
data.fields[].requiredboolean是是否必填
data.fields[].optionsstring[]否radio、checkbox 的选项
data.versionstring是内容版本。修改时原样传回;内容变化后版本随之变化,需要重新读取
data.editableboolean是当前凭证能否修改这张表单
data.reasonstring是不能修改的原因:AI_EDIT_NOT_AI_CREATED 不是通过接口创建的内容;AI_EDIT_SCOPE_REQUIRED 需要“完全”档凭证。可以修改时为 null

响应示例 ​

json
{
  "code": 0,
  "message": "ok",
  "data": {
    "form_id": "122507",
    "name": "设备巡检",
    "fields": [
      {
        "field_id": "71399639090001",
        "name": "巡检人",
        "type": "text",
        "required": true
      },
      {
        "field_id": "71399639090002",
        "name": "巡检结果",
        "type": "radio",
        "required": true,
        "options": [
          "正常",
          "异常"
        ]
      }
    ],
    "version": "c_5f2b9c0e7a1d4c3b8e6f0a9d2c4b6e8f1a3c5e7090b1d2f3a4c5e6f708192a3b",
    "editable": true,
    "reason": null
  }
}

常见错误 ​

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


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