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
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
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 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
pageNo |
No |
String |
Page number. The value starts from 1. |
pageSize |
No |
String |
Number of data records on each page. |
projectUUId |
No |
String |
Project ID. |
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
Parameter |
Type |
Description |
---|---|---|
result |
result object |
Definition: Returned result. |
status |
String |
Definition: Returned status. Value range: success: Command execution succeeds. error: Command execution failed. |
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
OK (The request has succeeded).
{ "result" : { "total_count" : 25 }, "status" : "success" }
Status Codes
Status Code |
Description |
---|---|
200 |
OK (The request has succeeded). |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot