Help Center/ CodeArts Check/ API Reference/ APIs/ Issue Management/ Querying Issue Details Statistics
Updated on 2024-11-28 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Issue Details Statistics

Function

This API is used to query issue details statistics based on the task ID.

Calling Method

For details, see Calling APIs.

URI

GET /v2/tasks/{task_id}/defects-statistic

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

task_id

Yes

String

Task ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

severity

StatisticSeverityV2 object

Issue level statistics.

status

StatisticStatusV2 object

Issue status statistics.
Table 4 StatisticSeverityV2

Parameter

Type

Description

critical

Integer

Critical issues.

major

Integer

Major issues.

minor

Integer

Minor issues.

suggestion

Integer

Suggestion issues.
Table 5 StatisticStatusV2

Parameter

Type

Description

unresolved

Integer

Unresolved.

resolved

Integer

Resolved.

dismissed

Integer

Ignored.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

GET https://{endpoint}/v2/tasks/2b31ed520xxxxxxebedb6e57xxxxxxxx/defects-statistic

Example Responses

Status code: 200

Request succeeded!

{
  "severity" : {
    "critical" : 120,
    "major" : 877,
    "minor" : 79,
    "suggestion" : 3
  },
  "status" : {
    "unresolved" : 877,
    "resolved" : 79,
    "dismissed" : 5
  }
}

Status code: 400

Bad Request

{
  "error_code" : "CC.00000000",
  "error_msg" : "Network busy. Try again later."
}

Status code: 401

Unauthorized

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

Status Codes

Status Code

Description

200

Request succeeded!

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.

Parent Topic: Issue Management