文档首页/ 代码检查 CodeArts Check/ API参考/ API/ 缺陷管理/ 提交修改的源码文件 - SubmitDefectsFileContent
更新时间:2025-12-09 GMT+08:00
分享

提交修改的源码文件 - SubmitDefectsFileContent

功能介绍

提交修改后的代码到代码仓。

调用方法

请参见如何调用API

授权信息

当前API调用无需身份策略权限。

URI

PUT /v1/defects/file-content

表1 Query参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目的32位UUID,通过查询项目列表接口查询项目列表获取。

约束限制:

不涉及。

取值范围:

32位uuid。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Language

String

参数解释:

语言,决定响应以哪种语言返回。

约束限制:

不涉及。

取值范围:

  • zh-cn,中文。

  • en-us,英文。

默认取值:

zh-cn。

表3 请求Body参数

参数

是否必选

参数类型

描述

taskId

String

参数解释:

任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID。即“查询任务列表接口”的响应中的ID字段。

约束限制:

不涉及。

取值范围:

字符串长度不少于1,不超过32。

默认取值:

不涉及。

jobId

String

参数解释:

执行ID,来自代码检查执行任务接口的返回值,每次执行代码检查任务都有唯一的执行ID。版本级不传,门禁级必传。即“根据任务ID查询任务执行记录”的响应中的ID字段。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

mergeId

String

参数解释:

合并请求ID。实际仅用于区分版本级和门禁级,版本级不传,门禁级传任意非空值即可。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

mergeKey

String

参数解释:

MergeKey,问题ID。获取代码问题列表响应中的mergeKey字段。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

bugId

String

参数解释:

bugId,问题代码片段ID。即“获取代码问题列表”响应中的bugId

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

occursMd5

String

参数解释:

occursMd5,智能化分析后,生成的md5值。即“智能化分析告警”中的occursMd5字段

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

content

String

参数解释:

提交到代码仓的内容。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

message

String

参数解释:

提交到代码仓的commit描述。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

status

String

参数解释:

响应状态。

取值范围:

  • success,成功。

  • error,失败。

result

String

参数解释:

修改结果。

取值范围:

不涉及。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

PUT https://{endpoint}/v1/tasks/2b31ed520xxxxxxebedb6e57xxxxxxxx/v1/defects/file-content

响应示例

状态码:200

Request succeeded!

{
  "status" : "success",
  "error" : null,
  "result" : null
}

状态码:400

Bad Request

{
  "error_code" : "CC.00000000",
  "error_msg" : "网络繁忙,请稍后再试"
}

状态码:401

Unauthorized

{
  "error_code" : "CC.00000003",
  "error_msg" : "认证信息过期"
}

状态码

状态码

描述

200

Request succeeded!

400

Bad Request

401

Unauthorized

错误码

请参见错误码

相关文档