查询单个问题详情和上下文代码 - GetSingleDefect

codeartscheck:task:getReport

Read

task *

-

-

-

-

codeartscheck:ProjectId

task_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

长度为[1~32]个字符。

默认取值：

不涉及。

merge_id

否

String

参数解释：

合并请求ID或Commit ID，主要用于查询门禁级任务。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

job_id

否

String

参数解释：

执行记录ID，即每一次执行版本级或门禁级扫描的唯一ID，主要用于查询门禁级任务。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

merge_key

是

String

参数解释：

MergeKey，问题ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

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

约束限制：

不涉及。

取值范围：

• zh-cn：中文。

• en-us：英文。

默认取值：

zh-cn。

status

String

参数解释：

响应状态。

取值范围：

• success：成功。

• error：失败。

result

SingleDefectAndContext object

参数解释：

问题的详细信息及上下文代码。

approver

String

参数解释：

问题忽略的审核人用户名。

取值范围：

不涉及。

language

String

参数解释：

编程语言。

取值范围：

• PYTHON：PYTHON语言。

• JAVA：JAVA语言。

• C++：C++语言。

• CSS：CSS语言。

• PHP：PHP语言。

• JAVASCRIPT：JAVASCRIPT语言。

• GO：GO语言。

• HTML：HTML语言。

• C#：C#语言。

• TYPESCRIPT：TYPESCRIPT语言。

• SHELL：SHELL语言。

• LUA：LUA语言。

• RUST：RUST语言。

• KOTLIN：KOTLIN语言。

• SCALA：SCALA语言。

• ARKTS：ARKTS语言。

• SQL：SQL语言。

• CANGJIE：CANGJIE语言。

filePath

String

参数解释：

文件路径。

取值范围：

不涉及。

line

Integer

参数解释：

问题所在行号。

取值范围：

不涉及。

functionName

String

参数解释：

问题所在函数名。

取值范围：

不涉及。

checkerName

String

参数解释：

工具名称。

取值范围：

不涉及。

checkerVersion

String

参数解释：

工具版本。

取值范围：

不涉及。

ruleName

String

参数解释：

工具规则名称。

取值范围：

不涉及。

defectLevel

String

参数解释：

问题级别。

取值范围：

• 0：致命。

• 1：严重。

• 2：一般。

• 3：提示。

createdAt

String

参数解释：

问题发现时间，使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。例如：2020-09-25T12:05:00Z。

取值范围：

不涉及。

criterionName

String

参数解释：

规则名称。

取值范围：

不涉及。

defectStatus

String

参数解释：

问题状态。

取值范围：

• 0：待处理。

• 2：已解决。

• 5：已忽略。

• 6：已修复。

occursInfo

OccursInfo object

参数解释：

代码片段信息。

nickName

String

参数解释：

问题责任人。

取值范围：

不涉及。

statusComment

Array of Comment objects

参数解释：

问题操作历史。

ruleId

String

参数解释：

规则ID。

取值范围：

不涉及。

occurId

String

参数解释：

问题代码片段ID。

取值范围：

不涉及。

occurDescription

String

参数解释：

问题描述。

取值范围：

不涉及。

engine

String

参数解释：

工具名称。

取值范围：

不涉及。

sourceCodeUrl

String

参数解释：

源码文件URL。

取值范围：

不涉及。

events

Array of Events objects

参数解释：

调用链信息。

description

String

参数解释：

问题详细描述。

取值范围：

不涉及。

fixSuggestions

Array of strings

参数解释：

修复建议。

line

Integer

参数解释：

问题所在文件行号。

取值范围：

不涉及。

startLine

Integer

参数解释：

废弃字段。

取值范围：

不涉及。

endLine

Integer

参数解释：

废弃字段。

取值范围：

不涉及。

main

Boolean

参数解释：

废弃字段。

取值范围：

不涉及。

path

String

参数解释：

文件路径。

取值范围：

不涉及。

tag

String

参数解释：

废弃字段。

取值范围：

不涉及。

mainBuggyCode

String

参数解释：

问题主事件对应的代码片段内容。

取值范围：

不涉及。

codeContext

String

参数解释：

废弃字段。

取值范围：

不涉及。

codeContextStartLine

Integer

参数解释：

代码上下文起始行号。

取值范围：

不涉及。

codePassage

Array of CodeLine objects

参数解释：

代码上下文。

events

Array of DefectEvents objects

参数解释：

调用链信息。

lineNumber

Integer

参数解释：

行号。

取值范围：

不涉及。

lineContent

String

参数解释：

代码内容。

取值范围：

不涉及。

events

Array of DefectEvents objects

参数解释：

调用链信息。

description

String

参数解释：

问题详细描述。

取值范围：

不涉及。

fix_suggestions

Array of strings

参数解释：

修复建议。

line

Integer

参数解释：

问题所在文件行号。

取值范围：

不涉及。

end_line

Integer

参数解释：

废弃字段。

取值范围：

不涉及。

main

Boolean

参数解释：

废弃字段。

取值范围：

不涉及。

path

String

参数解释：

文件路径。

取值范围：

不涉及。

tag

String

参数解释：

废弃字段。

取值范围：

不涉及。

main_buggy_code

String

参数解释：

问题主事件对应的代码片段内容。

取值范围：

不涉及。

code_context

String

参数解释：

代码上下文。

取值范围：

不涉及。

code_context_start_line

Integer

参数解释：

代码上下文起始行号。

取值范围：

不涉及。

id

Integer

参数解释：

操作历史ID。

取值范围：

不涉及。

comments

String

参数解释：

备注。

取值范围：

长度为[1~256]个字符。

mergeKey

String

参数解释：

MergeKey，问题ID。

取值范围：

长度为[1~32]个字符。

createTime

String

参数解释：

发生时间，使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。例如：2020-09-25T12:05:00Z。

取值范围：

不涉及。

applicant

String

参数解释：

操作人。

取值范围：

不涉及。

statusFrom

String

参数解释：

问题起始状态。

取值范围：

不涉及。

statusTo

String

参数解释：

问题目标状态。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

200

查询单个问题详情和上下文代码响应体

400

Bad Request

401

Unauthorized