Help Center/ CodeArts Req/ API Reference/ API/ Work Items of the Scrum Project/ Querying the Total Number of Work Items Using Filter Criteria in Tree Mode (V4)
Updated on 2026-05-19 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Total Number of Work Items Using Filter Criteria in Tree Mode (V4)

Function

This API is used to query the total number of work items using filter criteria in tree mode.

Calling Method

For details, see Calling APIs.

URI

POST /v4/{project_id}/scrum-issue-tree-count

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

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 for obtaining 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
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

pageNo

No

String

Definition:

Page index.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

pageSize

No

String

Definition:

Page size.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

projectUUId

No

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

tracker_id

No

String

Definition:

Work item type.

Constraints:

N/A

Value range:

2 (task)

3 (bug)

5 (epic)

6 (feature)

7 (story)

Default value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

result

result object

Definition:

Returned result.

status

String

Definition:

Returned status.

Value range:

success: The API is successfully called.

error: The API call failed.
Table 5 result

Parameter

Type

Description

total_count

Integer

Definition:

Total number of work items in the current project.

Value range:

N/A

Example Requests

POST http://{endpoint}/v4/c15cc54e338d4506afd9bd8103071ff0/scrum-issue-tree-count

{
  "page_no" : "1",
  "page_size" : "15",
  "project_uuid" : "c15cc54e338d4506afd9bd8103071ff0",
  "tracker_id" : "7,2,3"
}

Example Responses

Status code: 200

Response to a successful request for querying the total number of work items using filter criteria in tree mode.

{
  "result" : {
    "total_count" : 25
  },
  "status" : "success"
}

Status Codes

Status Code

Description

200

Response to a successful request for querying the total number of work items using filter criteria in tree mode.

Error Codes

See Error Codes.