Querying Labor Hours of a Project by User
Function
This API is used to query labor hours of a project by user.
Calling Method
For details, see Calling APIs.
URI
POST /v4/projects/{project_id}/work-hours
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 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
begin_time |
No |
String |
Definition: Work start date: YYYY-MM-DD. Constraints: Regular expression: [1-9]\d{3}-(0?[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) Options: N/A Default value: N/A |
end_time |
No |
String |
Definition: Work end date: YYYY-MM-DD. Constraints: Regular expression: [1-9]\d{3}-(0?[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) Options: N/A Default value: N/A |
limit |
No |
Integer |
Definition: Number of records displayed on each page. Constraints: A maximum of 500 records can be displayed on each page. Options: Minimum value: 1. Maximum value: 1,000. Default value: 10. |
offset |
No |
Integer |
Definition: Offset. Constraints: Offset must be an integral multiple of limit. If limit equals 10, then valid offset values are 0, 10, 20, and so on. Options: Minimum value: 0. Maximum value: 10,000. Default value: Default value: 0. |
user_ids |
No |
Array of strings |
Definition: List of queried user IDs. You can obtain the value using the Obtaining the Current User Information API. The value of user_id in the response message body is the user ID. Constraints: Regular expression: [0-9a-z]{32} |
work_hours_dates |
No |
String |
Definition: Work date in the format of YYYY-MM-DD. Separate multiple values by commas (,). Constraints: N/A Options: N/A Default value: N/A |
work_hours_types |
No |
String |
Definition: Work type. Separate multiple values by commas (,). Constraints: The enumerated values are separated by commas (,). Options: 21: R&D and design 22: backend development 23: frontend development (web) 24: frontend development (applet) 25: frontend development (app) 26: test and verification 27: bug fixing 28: UI design 29: conference 30: public affairs 31: training 32: research 33: other 34: replacement leave Default value: N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total |
Integer |
Definition: Total number. Options: N/A |
work_hours |
Array of work_hours objects |
Definition: Workload list. |
Parameter |
Type |
Description |
---|---|---|
closed_time |
String |
Definition: End time of a work item. Options: N/A |
created_time |
String |
Definition: Creation time of a work item. Options: N/A |
issue_id |
Integer |
Definition: Work item ID. Options: N/A |
issue_type |
String |
Definition: Work item type. Options: N/A |
nick_name |
String |
Definition: User alias. Options: N/A |
project_name |
String |
Definition: Project name. Options: N/A |
subject |
String |
Definition: Work item title. Options: N/A |
summary |
String |
Definition: Workload details. Options: N/A |
user_id |
String |
Definition: User ID. Options: N/A |
user_name |
String |
Definition: Username. Options: N/A |
work_date |
String |
Definition: Work date. Options: N/A |
work_hours_created_time |
String |
Definition: Workload creation time. Options: N/A |
work_hours_num |
String |
Definition: Workloads. Options: N/A |
work_hours_type_name |
String |
Definition: Work type. Options: N/A |
work_hours_updated_time |
String |
Definition: Workload update time. 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
Post https://{endpoint}/v4/projects/e2da96a5d2c845e284f0ad47f8ca8cb2/work-hours { "end_time" : "2020-08-14", "limit" : 1, "offset" : 0 }
Example Responses
Status code: 200
ok
{ "work_hours" : [ { "project_name" : "demo", "nick_name" : "demo", "user_id" : "09d75cdd9a00d44d2f17c01875483f26", "user_name" : "userName", "work_date" : "2020-02-19", "work_hours_num" : "2.0", "summary" : "summaryXXXXX", "work_hours_type_name" : "Backend development", "issue_id" : 123456, "issue_type" : "Story", "subject" : "title", "created_time" : "2019-12-17", "closed_time" : "2019-12-20", "work_hours_created_time" : "2019-12-17 09:00:00", "work_hours_updated_time" : "2019-12-20 15:00:00" } ], "total" : 1 }
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 47 48 49 50 51 |
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 ShowProjectWorkHoursSolution { 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(); ShowProjectWorkHoursRequest request = new ShowProjectWorkHoursRequest(); request.withProjectId("{project_id}"); ShowProjectWorkHoursRequestBody body = new ShowProjectWorkHoursRequestBody(); body.withLimit(1); body.withOffset(0); body.withEndTime("2020-08-14"); request.withBody(body); try { ShowProjectWorkHoursResponse response = client.showProjectWorkHours(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 32 33 34 35 36 |
# 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 = ShowProjectWorkHoursRequest() request.project_id = "{project_id}" request.body = ShowProjectWorkHoursRequestBody( limit=1, offset=0, end_time="2020-08-14" ) response = client.show_project_work_hours(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 |
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.ShowProjectWorkHoursRequest{} request.ProjectId = "{project_id}" endTimeShowProjectWorkHoursRequestBody:= "2020-08-14" request.Body = &model.ShowProjectWorkHoursRequestBody{ Limit: int32(1), Offset: int32(0), EndTime: &endTimeShowProjectWorkHoursRequestBody, } response, err := client.ShowProjectWorkHours(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