更新代码问题状态
功能介绍
根据代码问题MergeKey更新代码问题状态,支持批量更新多个问题
调用方法
请参见如何调用API。
URI
POST /v1/defect/issue-status
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Language |
否 |
String |
参数解释: 语言,决定响应以哪种语言返回。 约束限制: 不涉及。 取值范围:
默认取值: zh-cn |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
taskId |
否 |
String |
参数解释: 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
mergeId |
否 |
String |
参数解释: 合并请求ID。实际仅用于区分版本级和门禁级,版本级不传,门禁级传任意非空值即可。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
jobId |
否 |
String |
参数解释: 执行ID,来自代码检查执行任务接口的返回值,每次执行代码检查任务都有1个唯一的执行ID。版本级不传,门禁级必传。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
status |
否 |
String |
参数解释: 问题状态。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
comment |
否 |
String |
参数解释: 本次修改问题状态操作的备注。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
mergeKey |
否 |
String |
参数解释: MergeKey,问题ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
operator |
否 |
String |
参数解释: 操作人,用户名。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
参数解释: 响应状态。 取值范围:
|
result |
String |
参数解释: 修改结果。 取值范围: 不涉及。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
将ID为897acf5exxx48a5013cd的任务下MergeKey为df16aacxxxf6c8758的问题状态修改为已忽略,并评论为‘工具误报’。
POST https://{endpoint}/v1/defect/issue-status { "taskId" : "897acf5exxx48a5013cd", "mergeId" : "", "jobId" : "", "status" : 5, "comment" : "工具误报", "mergeKey" : "df16aacxxxf6c8758", "operator" : "devcloud_codecheck_l00493925_01" }
响应示例
状态码:200
更新代码问题状态响应体
{ "status" : "success", "error" : null, "result" : "修改成功" }
状态码:400
Bad Request
{ "error_code" : "CC.00000000", "error_msg" : "网络繁忙,请稍后再试" }
状态码:401
Unauthorized
{ "error_code" : "CC.00000003", "error_msg" : "认证信息过期" }
状态码
状态码 |
描述 |
---|---|
200 |
更新代码问题状态响应体 |
400 |
Bad Request |
401 |
Unauthorized |
错误码
请参见错误码。