Help Center/ CodeArts Req/ API Reference/ API/ Work Items of the Scrum Project/ Querying the Numbers of Work Item Metrics on the Details Page
Updated on 2025-09-10 GMT+08:00

Querying the Numbers of Work Item Metrics on the Details Page

Function

This API is used to query the numbers of work item metrics on the details page.

Calling Method

For details, see Calling APIs.

URI

GET /v3/workitem/scrum/index-count

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

issue_id

Yes

Integer

Definition:

Work item ID, which can be obtained from the Performing Advanced Query of Work Items API. The value of the id field in the response message body is the work item ID.

Constraints:

The value must contain 1 to 10 digits.

Value range:

Minimum length: 1 character. Maximum length: 10 characters.

Default value:

N/A

project_uuid

Yes

String

Definition:

32-character UUID of a project, which uniquely identifies a project. Obtain the value of this parameter from the project_id field in the response body of the Querying the Project List API.

Constraints:

The value must contain 32 characters. Digits and letters are allowed.

Value range:

N/A

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition:

User token. Obtain a token by calling the IAM API forobtaining a user token. The value of X-Subject-Token in the response header is the user token.

Constraints:

Mandatory.

Value range:

Minimum length: 10 characters. Maximum length: 32,768 characters.

Default value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

result

result object

Definition:

Returned result.

status

String

Definition:

Returned status.

Value range:

success: Command execution succeeds.

error: Command execution failed.

Table 4 result

Parameter

Type

Description

related_issue_count

Integer

Definition:

Total number of associated work items.

Value range:

N/A

related_wiki_count

Integer

Definition:

Total number of associated wikis.

Value range:

N/A

related_test_case_count

Integer

Definition:

Total number of associated test cases.

Value range:

N/A

related_test_plan_count

Integer

Definition:

Total number of associated test plans.

Value range:

N/A

code_commit_count

Integer

Definition:

Total number of code commit records.

Value range:

N/A

code_branch_count

Integer

Definition:

Total number of code branches.

Value range:

N/A

code_mergerequest_count

Integer

Definition:

Total number of code merge requests.

Value range:

N/A

Example Requests

GET https://{engdpoint}/v3/workitem/scrum/index-count?issue_id=2884417&project_uuid=310eed4d6160446cb294a8bacfd46e7e

Example Responses

Status code: 200

OK (The request has succeeded).

{
  "result" : {
    "related_issue_count" : 0,
    "related_wiki_count" : 0,
    "related_test_case_count" : 0,
    "related_test_plan_count" : 0,
    "code_commit_count" : 0,
    "code_branch_count" : 0,
    "code_mergerequest_count" : 0
  },
  "status" : "success"
}

Status Codes

Status Code

Description

200

OK (The request has succeeded).

Error Codes

See Error Codes.