Querying Work Item Status Statistics in a Sprint (by Handler)
Function
This API is used to query work item status statistics in a Sprint (by handler).
Calling Method
For details, see Calling APIs.
Authorization Information
No identity policy-based permission required for calling this API.
URI
GET /v4/projects/{project_id}/status-statistic
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition A 32-character UUID. It uniquely identifies a project. Obtain a project ID by calling the API for querying projects. The value of project_id in the response message body is a project ID. Constraints A string of 32 characters consisting of letters and digits. Range N/A Default Value N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| iteration_id | Yes | Integer | Definition Sprint ID. You can obtain the sprint list of a project using the Obtaining the Sprint List of a Specified Project API. Constraints ≥ 1 digit Range ≥ 1 Default Value N/A |
| tracker_id | Yes | Integer | Definition: Work item types of custom fields. The options are as follows: 2 (task) 3 (bug) 7 (story) Constraints: N/A Options: 2, 3, and 7 Default value: N/A |
| status_id | Yes | Integer | Definition Status ID. The options are as follows: 1: new 2: developing 3: resolved 4: testing 5: closed 6: rejected Constraints ≥ 1 digit Range 1, 2, 3, 4, 5, 6 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 for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Constraints N/A Range The value contains 10 to 32,768 characters. Default Value N/A |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| [items] | Array of UserStatusStatistic objects | Definition: Array of work item status statistics in a sprint (by handler). |
| Parameter | Type | Description |
|---|---|---|
| data | Map<String,Integer> | Definition: Statistics on work item statuses Options: N/A |
| item_count | Integer | Definition: Total number of work items that meet conditions. Options: N/A |
| user | IssueUser object | Definition: User information. Options: N/A |
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Definition User ID. Range N/A |
| name | String | Definition Username. Range N/A |
| nick_name | String | Definition: Alias. Options: N/A |
| user_id | String | Definition User UUID. Range N/A |
| user_num_id | Integer | Definition Digital ID of a user. Range N/A |
| first_name | String | Definition: Username. Value range: N/A |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Definition: Error code. Value range: N/A |
| error_msg | String | Definition: Error description. Value range: N/A |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Definition: Error code. Value range: N/A |
| error_msg | String | Definition: Error description. Value range: N/A |
| request_id | String | Definition Request ID, which is automatically generated by the system. Range N/A |
Example Requests
GET https://{endpoint}/v4/projects/f7a67aee4c034fd6944fd5f769e89042/status-statistic?iteration_id=1234&tracker_id=7&status_id=1 Example Responses
Status code: 200
[ {
"user" : {
"user_id" : "112a642015cf11eca152fa163ec9f6c1",
"user_num_id" : 5055,
"name" : "devcloud_devcloud_test_01_test"
},
"item_count" : 1,
"data" : {
"5874579" : 1
}
}, {
"user" : {
"user_id" : "1139ffb615cf11eca152fa163ec9f6c1",
"user_num_id" : 5255,
"name" : "devcloud_devcloud_test_01_test"
},
"item_count" : 1,
"data" : {
"5874580" : 1
}
}, {
"user" : {
"user_id" : "a360371833bf4c558f796fd707b44daf",
"user_num_id" : 9078,
"nick_name" : "sstest5",
"name" : "devcloud_devcloud_test_01"
},
"item_count" : 2,
"data" : {
"5874581" : 1,
"5874584" : 1
}
}, {
"user" : {
"user_id" : "D0XCOQMxQ9Nujj9lybk51lFEQzpdpzMc",
"user_num_id" : 15437,
"name" : "devcloud_devcloud_test_01_FederationUser"
},
"item_count" : 1,
"data" : {
"5874582" : 2
}
} ] SDK Sample Code
The SDK sample code is as follows.
Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 | package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.projectman.v4.region.ProjectManRegion; import com.huaweicloud.sdk.projectman.v4.*; import com.huaweicloud.sdk.projectman.v4.model.*; public class ListStatusStatisticSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); ProjectManClient client = ProjectManClient.newBuilder() .withCredential(auth) .withRegion(ProjectManRegion.valueOf("<YOUR REGION>")) .build(); ListStatusStatisticRequest request = new ListStatusStatisticRequest(); request.withProjectId("{project_id}"); try { ListStatusStatisticResponse response = client.listStatusStatistic(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkprojectman.v4.region.projectman_region import ProjectManRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkprojectman.v4 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = ProjectManClient.new_builder() \ .with_credentials(credentials) \ .with_region(ProjectManRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListStatusStatisticRequest() request.project_id = "{project_id}" response = client.list_status_statistic(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" projectman "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := projectman.ProjectManClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := projectman.NewProjectManClient(hcClient) request := &model.ListStatusStatisticRequest{} request.ProjectId = "{project_id}" response, err := client.ListStatusStatistic(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
| Status Code | Description |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
Error Codes
See Error Codes.
What is your overall rating for this page?
Thank 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