Help Center> CodeArts Check> API Reference> APIs> Defect Management> Querying Defect Details Statistics
Updated on 2023-11-28 GMT+08:00

Querying Defect Details Statistics

Function

This interface is used to query defect details based on the check task ID.

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 an IAM API. The value of X-Subject-Token in the response header is the user token.

Minimum: 1

Maximum: 100000

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

severity

StatisticSeverityV2 object

Problem Level Statistics

status

StatisticStatusV2 object

Issue Status Statistics

Table 4 StatisticSeverityV2

Parameter

Type

Description

critical

Integer

Critical

major

Integer

Major

minor

Integer

Minor

suggestion

Integer

Suggestion

Table 5 StatisticStatusV2

Parameter

Type

Description

unresolved

Integer

Unsolved

resolved

Integer

Solved

dismissed

Integer

Ignored

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

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" : "The network is busy. Please try again later."
}

Status code: 401

Unauthorized

{
  "error_code" : "CC.00000003",
  "error_msg" : "The authentication information has expired."
}

Status Codes

Status Code

Description

200

Request succeeded!

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.