Help Center/ CodeArts Check/ API Reference/ APIs/ Issue Export/ Generating a PDF Report
Updated on 2026-02-03 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Generating a PDF Report

Function

This API is used to create an asynchronous job for generating a PDF report. The progress of the job can be queried using the API for querying the asynchronous job progress.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartscheck:task:getReport

Read

task *

-

-

-

-

codeartscheck:ProjectId

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

task_id

Yes

String

Definition :

Task ID, returned by the API for creating a check task. Each code check task, branch task, or incremental task generated through an API has a unique ID. Obtain the ID by calling the API used to . id indicates the task ID.

Constraints:

N/A

Value range:

1 to 128 characters.

Default value:

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

project_name

Yes

String

Definition:

PDF report title.

Constraints:

N/A

Value range:

1 to 128 characters.

Default value:

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Language

No

String

Definition:

Language of the response.

Constraints:

N/A

Value range:

  • zh-cn: Chinese.

  • en-us: English.

Default value:

zh-cn

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

status

String

Definition:

Response status.

Value range:

  • success: successful.

  • error: failed.

result

result object

Definition:

Result of generating a PDF report
Table 5 result

Parameter

Type

Description

timeAsk

Integer

Definition:

Recommended polling interval, in seconds.

Value range:

N/A

asyncJobId

Integer

Definition:

Asynchronous job ID.

Value range:

N/A

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

Example Requests

Create an asynchronous job to generate a PDF report for the latest version scan of task ID 897acf5exxx48a5013cd. Use the task name test_task for the PDF report title.

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

Example Responses

Status code: 200

Response body for generating a PDF report.

{
  "status" : "success",
  "error" : null,
  "result" : {
    "timeAsk" : 3,
    "asyncJobId" : 569151
  }
}

Status code: 400

Bad Request

{
  "error_code" : "CC.xxxxxxxx.400",
  "error_msg" : "Verify request parameter failed. Check whether the request parameters are correct."
}

Status code: 401

Unauthorized

{
  "error_code" : "CC.00000003",
  "error_msg" : "Authentication information expired."
}

Status Codes

Status Code

Description

200

Response body for generating a PDF report.

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.

Parent Topic: Issue Export