更新时间:2025-09-30 GMT+08:00
分享

下载PDF报告

功能介绍

根据查询异步任务接口返回的jobFile路径,下载对应的PDF报告,不可重复下载

调用方法

请参见如何调用API

URI

GET /v1/tasks/{task_id}/pdf-file

表1 路径参数

参数

是否必选

参数类型

描述

task_id

String

参数解释:

任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

job_file

String

文件路径

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Language

String

参数解释:

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

约束限制:

不涉及。

取值范围:

  • zh-cn,中文。

  • en-us,英文。

默认取值:

zh-cn

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

-

File

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

下载ID为897acf5exxx48a5013cd的任务的PDF报告,路径标识为defects/PdfFiles/20250625/CodeArtsCheck_Report_aaa_20250625100955.pdf。

GET https://{endpoint}/v1/tasks/897acf5exxx48a5013cd/pdf-file?job_file=defects%2FPdfFiles%2F20250625%2FCodeArtsCheck_Report_test_task_20250625100955.pdf

响应示例

状态码:400

Bad Request

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

状态码:401

Unauthorized

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

状态码

状态码

描述

200

PDF报告

400

Bad Request

401

Unauthorized

错误码

请参见错误码

相关文档