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

生成PDF报告

功能介绍

生成PDF报告,创建一个生成PDF的异步任务。

调用方法

请参见如何调用API

URI

PUT /v1/tasks/{task_id}/pdf-async-job

表1 路径参数

参数

是否必选

参数类型

描述

task_id

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

project_name

String

PDF报告标题名称

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Language

String

参数解释:

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

约束限制:

不涉及。

取值范围:

  • zh-cn,中文。

  • en-us,英文。

默认取值:

zh-cn

响应参数

状态码:200

Request succeeded!

状态码:400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

对于ID为897acf5exxx48a5013cd的任务最新一次版本级扫描生成PDF报告,创建一个生成PDF的异步任务,PDF报告的标题中任务名为test_task。

PUT https://{endpoint}/v1/tasks/897acf5exxx48a5013cd/pdf-job?project_name=test_task

null

响应示例

状态码:200

Request succeeded!

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

错误码

请参见错误码

相关文档