查看问题的源码文件 - ShowDefectsFileContent
功能介绍
查看代码仓中问题所在的源码文件。
调用方法
请参见如何调用API。
授权信息
当前API调用无需身份策略权限。
URI
GET /v1/defects/file-content
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目的32位UUID，通过查询项目列表接口获取。 约束限制: 不涉及。 取值范围: 32位uuid。 默认取值: 不涉及。 |
| task_id | 是 | String | 参数解释： 任务ID，即新建检查任务接口的返回值，每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即查询任务列表接口响应中的id字段。 约束限制： 不涉及。 取值范围： 长度为[1~32]个字符。 默认取值： 不涉及。 |
| job_id | 否 | String | 参数解释： 执行记录ID，即每一次执行版本级或门禁级扫描的唯一ID，主要用于查询门禁级任务。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
| merge_id | 否 | String | 参数解释： 合并请求ID或Commit ID，主要用于查询门禁级任务。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
| merge_key | 是 | String | 参数解释： MergeKey，问题ID。即“获取代码问题列表”的响应中的mergeKey字段 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
| bug_id | 是 | String | 参数解释： bugId，问题代码片段ID。即“获取代码问题列表”响应中的bugId 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Language | 否 | String | 参数解释： 语言，决定响应以哪种语言返回。 约束限制： 不涉及。 取值范围：
默认取值： zh-cn。 |
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释： 响应状态。 取值范围：
|
| result | String | 参数解释： 代码仓里的文件内容。 取值范围： 不涉及。 |
状态码：400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释： 错误码。 取值范围： 不涉及。 |
| error_msg | String | 参数解释： 错误描述。 取值范围： 不涉及。 |
状态码：401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释： 错误码。 取值范围： 不涉及。 |
| error_msg | String | 参数解释： 错误描述。 取值范围： 不涉及。 |
请求示例
GET https://{endpoint}/v1/tasks/2b31ed520xxxxxxebedb6e57xxxxxxxx/v1/defects/file-content 响应示例
状态码：200
Request succeeded!
{
"status" : "success",
"error" : null,
"result" : "import android.app.Application;\n\n..."
} 状态码：400
Bad Request
{
"error_code" : "CC.xxxxxxxx.400",
"error_msg" : "请求参数校验失败,请检查请求参数是否正确"
} 状态码：401
Unauthorized
{
"error_code" : "CC.00000003",
"error_msg" : "认证信息过期"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | Request succeeded! |
| 400 | Bad Request |
| 401 | Unauthorized |
错误码
请参见错误码。
