Help Center/ CodeArts Check/ API Reference/ APIs/ Issue Export/ Checking the Progress of an Asynchronous Job
Updated on 2026-02-03 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Checking the Progress of an Asynchronous Job

Function

This API is used to check the PDF report generation progress based on the value of asyncJobId returned by the API for generating a PDF report.

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

GET /v1/tasks/{task_id}/async-job/{async_job_id}

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

async_job_id

Yes

Integer

Definition:

Asynchronous job ID, which is obtained from the response body of the API for [generating a PDF report].

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Request Parameters

Table 2 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 3 Response body parameters

Parameter

Type

Description

status

String

Definition:

Response status.

Value range:

  • success: successful.

  • error: failed.

result

AsyncJob object

Definition:

Asynchronous task.
Table 4 AsyncJob

Parameter

Type

Description

id

Integer

Definition:

Asynchronous job ID.

Value range:

N/A

jobFile

String

Definition:

Path of the exported file.

Value range:

N/A

jobStatus

String

Definition:

Asynchronous task status.

Value range:

  • SUCCESS: successful.

  • RUNNING: running.

  • FAILED: failed.

createTime

String

Definition:

Time (GMT+8) when an asynchronous task is created. Format: yyyy-MM-dd HH:mm:ss. For example, 2020-09-25 12:05:00.

Value range:

N/A

progress

String

Definition:

Progresses of an asynchronous task. For example, 100 indicates that the task is complete.

Value range:

1–100

reason

String

Definition:

Asynchronous task failure cause.

Value range:

N/A

Status code: 400

Table 5 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 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

Example Requests

Check the progress of asynchronous export job ID 4xx9 under the check task ID 897acf5exxx48a5013cd.

GET https://{endpoint}/v1/tasks/897acf5exxx48a5013cd/async-job/4xx9

Example Responses

Status code: 200

Response body for querying the asynchronous job progress

{
  "status" : "success",
  "error" : null,
  "result" : {
    "id" : 569151,
    "jobFile" : "defects/PdfFiles/20250923/local_test_master_Code check report_20250923164928.pdf",
    "jobStatus" : "SUCCESS",
    "createTime" : "2025-09-23 16:49:27",
    "progress" : "100",
    "taskId" : null,
    "reason" : null
  }
}

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 querying the asynchronous job progress

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.

Parent Topic: Issue Export