添加数据评论

更新时间:2026.07.21 10:41

功能说明

为指定表单实例添加评论。评论创建人固定为当前 API Key 的创建者。

调用说明

地址:

https://www.shudacloud.com/api/open-api/platform/form-data/comment/create

方式:POST

接口编码:form-data:comment:create

鉴权方式:在请求 Header 中传入 X-API-Key。无需传入 tenant-id,服务端会根据 API Key 自动识别所属租户。

本页参数和返回值来自测试环境真实调试;请求示例中的域名已按生产环境填写。当前示例 API Key 仅在测试环境有效。

请求参数

名称 位置 类型 是否必选 示例值 描述
X-API-Key Header String qop_f9f5d23ff4c84e2aa513e37d08780022 开放平台 API Key
appCode Body String cd5151d248b24b1cac453a423648cb4f 应用编码
id Body String c3f5f8b41e21c012ec7a065c32cb7a74 表单实例编号
content Body String 开放接口文档测试评论 评论内容
mentions Body Array [] 提及成员列表,可包含 userId、nickname、start、end
attachments Body Array [] 附件列表,可包含 name、url、size、ext

返回数据

名称 类型 示例值 描述
code Integer 0 业务状态码,0 表示成功
msg String 空字符串 业务提示信息
data String 9843416bf9584c67ab7e28c1b6e4026b 新建成功的评论编号

示例

请求示例

curl --request POST \
  --url "https://www.shudacloud.com/api/open-api/platform/form-data/comment/create" \
  --header "X-API-Key: qop_f9f5d23ff4c84e2aa513e37d08780022" \
  --header "Content-Type: application/json" \
  --data '{
  "appCode": "cd5151d248b24b1cac453a423648cb4f",
  "id": "c3f5f8b41e21c012ec7a065c32cb7a74",
  "content": "开放接口文档测试评论",
  "mentions": [],
  "attachments": []
}'

正常返回示例

{
  "code": 0,
  "msg": "",
  "data": "9843416bf9584c67ab7e28c1b6e4026b"
}

常见异常

业务状态码 说明
400 请求参数格式或必填参数校验失败
1002030001 未传入 X-API-Key
1002030002 API Key 无效
1002030003 API Key 已停用
1002030004 当前调用 IP 不在 API Key 白名单内
1002030006 当前 API Key 无权调用该接口
1002030007 appCode 不能为空
1002030008 当前 API Key 无权访问该应用

开放接口的业务异常通常仍返回 HTTP 200,请以响应体中的 code 判断调用是否成功。