更新时间:2025-08-11 GMT+08:00
分享

查询用户详细工时

功能介绍

查询用户详细工时。

调用方法

请参见如何调用API

URI

POST /v3/work-hours/get-member-work-hours

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

必传。

取值范围:

最小长度:10,最大长度:32768。

默认取值:

不涉及。

表2 请求Body参数

参数

是否必选

参数类型

描述

page_no

String

参数解释:

分页索引。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

page_size

String

参数解释:

分页大小。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

project_uuid

String

参数解释

项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。

约束限制

由数字和英文组成的32字符串。

取值范围

不涉及。

默认取值

不涉及。

staff_id

String

参数解释:

用户id(用户数字id和用户uuid均支持)。通过获取当前用户信息接口查询用户id信息,返回数据的user_id为用户uuid,user_num_id为用户数字id。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

result

result object

参数解释:

返回结果。

status

String

参数解释:

返回状态。

取值范围:

success:返回成功

error :返回失败

表4 result

参数

参数类型

描述

dataList

Array of dataList objects

参数解释:

项目成员的工时列表。

total

Integer

参数解释:

返回工时列表总数。

取值范围:

不涉及。

表5 dataList

参数

参数类型

描述

id

Integer

参数解释:

工作项数字id。

取值范围:

不涉及。

subject

String

参数解释:

工作项标题。

取值范围:

不涉及。

summary

String

参数解释:

工时内容。

取值范围:

不涉及。

created_on

String

参数解释:

创建时间,时间戳格式(示例:1747065600000)。

取值范围:

不涉及。

work_date

String

参数解释:

工时日期,时间戳格式(示例:1747065600000)。

取值范围:

不涉及。

work_hours

String

参数解释:

工时(单位:人/时)。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

assigned_to

assigned_to object

参数解释:

工时的创建人信息。

tracker

Tracker object

参数解释:

工作项类型。

表6 assigned_to

参数

参数类型

描述

assigned_nick_name

String

参数解释:

用户的昵称。

取值范围:

不涉及。

name

String

参数解释:

有租户信息的用户名(租户_用户名)。

取值范围:

不涉及。

image_id

String

参数解释:

用户头像。

取值范围:

不涉及。

first_name

String

参数解释:

用户名。

取值范围:

不涉及。

id

Integer

参数解释:

用户的数字id。

取值范围:

不涉及。

表7 Tracker

参数

参数类型

描述

name

String

参数解释:

类型名称。

取值范围:

2(任务/Task)

3(缺陷/Bug)

5(Epic)

6(Feature)

7(Story)

id

Integer

参数解释:

类型id。

取值范围:

2,3,5,6,7

请求示例

POST https://{endpoint}/v3/work-hours/get-member-work-hours

{
  "page_no" : 1,
  "page_size" : 10,
  "project_uuid" : "a8ac165097ff4e42bcfb234dd27d30a6",
  "staff_id" : "1111"
}

响应示例

状态码:200

项目成员工时列表响应。

{
  "result" : {
    "total" : 1,
    "dataList" : [ {
      "work_date" : "1747065600000",
      "created_on" : "1747065600000",
      "subject" : "TEST",
      "work_hours" : 22,
      "tracker" : {
        "name" : "Story",
        "id" : 7
      },
      "id" : 9079052,
      "assigned_to" : {
        "first_name" : "xxxxxx",
        "image_id" : "xxxxxx",
        "assigned_nick_name" : "xxxxxx",
        "name" : "xxxxxx",
        "id" : "1111"
      }
    } ]
  },
  "status" : "success"
}

状态码

状态码

描述

200

项目成员工时列表响应。

错误码

请参见错误码

相关文档