Help Center/ CodeArts Req/ API Reference/ API/ Work Items of the Scrum Project/ Querying Labor Hours by User (for Multiple Projects)
Updated on 2025-09-10 GMT+08:00

Querying Labor Hours by User (for Multiple Projects)

Function

This API is used to query labor hours by user (for multiple projects).

Calling Method

For details, see Calling APIs.

URI

POST /v4/projects/work-hours

Request Parameters

Table 1 Request body parameters

Parameter

Mandatory

Type

Description

begin_time

No

String

Definition:

Work start time. The format is YYYY-MM-DD.

Constraints:

N/A

Options:

N/A

Default value:

N/A

end_time

No

String

Definition:

Work end time. The format is YYYY-MM-DD.

Constraints:

N/A

Options:

N/A

Default value:

N/A

limit

No

Integer

Definition:

Number of records displayed on each page (max: 500).

Constraints:

N/A

Options:

Minimum value: 1. Maximum value: 500.

Default value:

N/A

offset

No

Integer

Definition:

Offset, which is an integer multiple of limit.

Constraints:

N/A

Options:

Minimum value: 0.

Default value:

N/A

project_ids

No

Array of strings

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

user_ids

No

Array of strings

Definition:

User ID. 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}

Options:

N/A

Default value:

N/A

work_hours_dates

No

String

Definition:

Work date. The date format is YYYY-MM-DD. Separate multiple values by commas (,).

Example: 2020-05-02,2020-03-02,2021-09-01

Constraints:

N/A

Options:

N/A

Default value:

N/A

work_hours_types

No

String

Definition:

Work type. Separate multiple values by commas (,). Example: 21, 22, 23

Constraints:

N/A

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

Table 2 Response body parameters

Parameter

Type

Description

total

Integer

Definition:

Total number.

Options:

N/A

work_hours

Array of work_hours objects

Definition:

Workload list.

Table 3 work_hours

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

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Example Requests

Post https://{endpoint}/v4/projects/work-hours

{
  "end_time" : "2020-08-14",
  "limit" : 1,
  "offset" : 0,
  "project_ids" : [ "e2da96a5d2c845e284f0ad47f8ca8cb2", "a2da96a5d2c845e284f0ad47f8ca8cef" ]
}

Example Responses

Status code: 200

ok

{
  "work_hours" : [ {
    "project_name" : "Project name",
    "nick_name" : "User alias.",
    "user_id" : "09d75cdd9a00d44d2f17c01875483f26",
    "user_name" : "Username",
    "work_date" : "2020-02-19",
    "work_hours_num" : "2.0",
    "summary" : "XXXXX was done.",
    "work_hours_type_name" : "Backend development",
    "issue_id" : 123456,
    "issue_type" : "Story",
    "subject" : "Work Item 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
52
53
54
55
56
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.*;

import java.util.List;
import java.util.ArrayList;

public class ListProjectWorkHoursSolution {

    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();
        ListProjectWorkHoursRequest request = new ListProjectWorkHoursRequest();
        ListProjectWorkHoursRequestBody body = new ListProjectWorkHoursRequestBody();
        List<String> listbodyProjectIds = new ArrayList<>();
        listbodyProjectIds.add("e2da96a5d2c845e284f0ad47f8ca8cb2");
        listbodyProjectIds.add("a2da96a5d2c845e284f0ad47f8ca8cef");
        body.withLimit(1);
        body.withOffset(0);
        body.withEndTime("2020-08-14");
        body.withProjectIds(listbodyProjectIds);
        request.withBody(body);
        try {
            ListProjectWorkHoursResponse response = client.listProjectWorkHours(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
37
38
39
40
# 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 = ListProjectWorkHoursRequest()
        listProjectIdsbody = [
            "e2da96a5d2c845e284f0ad47f8ca8cb2",
            "a2da96a5d2c845e284f0ad47f8ca8cef"
        ]
        request.body = ListProjectWorkHoursRequestBody(
            limit=1,
            offset=0,
            end_time="2020-08-14",
            project_ids=listProjectIdsbody
        )
        response = client.list_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
43
44
45
46
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.ListProjectWorkHoursRequest{}
	var listProjectIdsbody = []string{
        "e2da96a5d2c845e284f0ad47f8ca8cb2",
	    "a2da96a5d2c845e284f0ad47f8ca8cef",
    }
	endTimeListProjectWorkHoursRequestBody:= "2020-08-14"
	request.Body = &model.ListProjectWorkHoursRequestBody{
		Limit: int32(1),
		Offset: int32(0),
		EndTime: &endTimeListProjectWorkHoursRequestBody,
		ProjectIds: &listProjectIdsbody,
	}
	response, err := client.ListProjectWorkHours(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.