Obtaining the Overview of a Scrum Project
Function
This API is used to obtain the overview of a Scrum project.
Calling Method
For details, see Calling APIs.
URI
GET /v4/projects/{project_id}/summary
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: Regular expression: [A-Za-z0-9]{32} Options: N/A Default value: N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition: User token. Obtain the token by calling theObtaining a User TokenIAM API. In the returned response header, X-Subject-Token is the desired user token. Constraints: Mandatory. Range: Minimum length: 10 character. Maximum length: 32,768 characters. Default value: N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
bug_statistics |
Array of BugStatisticResponseV4 objects |
Definition: Bug list. |
demand_statistics |
Array of DemandStatisticResponseV4 objects |
Definition: Statistics list by module. |
issue_completion_rates |
Array of IssueCompletionRateResponseV4 objects |
Definition: Statistics list by work item type. |
project_id |
String |
Definition: Project ID. Options: Maximum length: 32 characters. |
Parameter |
Type |
Description |
---|---|---|
critical_num |
Integer |
Definition: Number of critical bugs. Options: N/A |
defect_index |
Double |
Definition: DI value, which is different for bugs of different severities. Options: N/A |
module |
String |
Definition: Module. Options: N/A |
normal_num |
Integer |
Definition: Number of minor bugs. Options: N/A |
serious_num |
Integer |
Definition: Number of major bugs. Options: N/A |
tip_num |
Integer |
Definition: Number of info bugs. Options: N/A |
total |
Integer |
Definition: Total number. Options: N/A |
Parameter |
Type |
Description |
---|---|---|
closed_num |
Integer |
Definition: Number of closed work items by module. Options: N/A |
module |
String |
Definition: Module information. Options: N/A |
new_num |
Integer |
Definition: Number of created work items by module. Options: N/A |
process_num |
Integer |
Definition: Number of ongoing work items by module. Options: N/A |
rejected_num |
Integer |
Definition: Number of rejected work items by module. Options: N/A |
solved_num |
Integer |
Definition: Number of resolved work items by module. Options: N/A |
test_num |
Integer |
Definition: Number of tests by module. Options: N/A |
total |
Integer |
Definition: Total number of work items by module. Options: N/A |
Parameter |
Type |
Description |
---|---|---|
issue_status |
IssueStatusResponseV4 object |
Definition: Work item status statistics. |
tracker_id |
Integer |
Definition: Work item type. Options: 2 (task) 3 (bug) 5 (epic) 6 (feature) 7 (story) |
Parameter |
Type |
Description |
---|---|---|
closed_num |
Integer |
Definition: Number of closed work items in the current project. Options: N/A |
new_num |
Integer |
Definition: Number of new work items in the current project. Options: N/A |
process_num |
Integer |
Definition: Number of work items being developed in the current project. Options: N/A |
rejected_num |
Integer |
Definition: Number of rejected work items in the current project. Options: N/A |
solved_num |
Integer |
Definition: Number of resolved work items in the current project. Options: N/A |
test_num |
Integer |
Definition: Number of work items under test in the current project. Options: N/A |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error Codes |
error_msg |
String |
Description |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error Codes |
error_msg |
String |
Description |
Example Requests
GET https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/summary
Example Responses
Status code: 200
OK
{ "bug_statistics" : [ { "critical_num" : 0, "defect_index" : 1, "module" : "Statistical Score", "normal_num" : 1, "serious_num" : 0, "tip_num" : 0, "total" : 1 } ], "demand_statistics" : [ { "closed_num" : 1, "module" : "Billing", "new_num" : 1, "process_num" : 1, "rejected_num" : 1, "solved_num" : 1, "test_num" : 1, "total" : 1 } ], "issue_completion_rates" : [ { "issue_status" : { "closed_num" : 1, "new_num" : 1, "process_num" : 1, "rejected_num" : 1, "solved_num" : 1, "test_num" : 1 }, "tracker_id" : 0 } ], "project_id" : "526cefde62004de2b62b5e8dd2c2b3af" }
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 ShowProjectSummaryV4Solution { 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(); ShowProjectSummaryV4Request request = new ShowProjectSummaryV4Request(); request.withProjectId("{project_id}"); try { ShowProjectSummaryV4Response response = client.showProjectSummaryV4(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 = ShowProjectSummaryV4Request() request.project_id = "{project_id}" response = client.show_project_summary_v4(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 |
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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := projectman.NewProjectManClient( projectman.ProjectManClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowProjectSummaryV4Request{} request.ProjectId = "{project_id}" response, err := client.ShowProjectSummaryV4(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.
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