文档首页/ 需求管理 CodeArts Req/ API参考/ API/ Scrum项目的工作项/ 按用户查询工时(多项目)
更新时间:2022-12-08 GMT+08:00

按用户查询工时(多项目)

功能介绍

按用户查询工时(多项目)

URI

POST /v4/projects/work-hours

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:10

最大长度:32768

表2 请求Body参数

参数

是否必选

参数类型

描述

project_ids

Array of strings

查询的项目id列表

user_ids

Array of strings

查询的用户id列表

work_hours_types

String

工时类型,以逗号分隔,21:研发设计,22:后端开发,23:前端开发(Web),24:前端开发(小程序),25:前端开发(App),26:测试验证,27:缺陷修复,28:UI设计,29:会议,30:公共事务,31:培训,32:研究,33:其它,34:调休请假

work_hours_dates

String

工时日期,以逗号分隔,年-月-日

begin_time

String

工时开始日期,年-月-日

end_time

String

工时结束日期,年-月-日

offset

Integer

偏移量,offset是limit的整数倍,limit=10,offset=0,10,20...

最小值:0

limit

Integer

每页显示数量,每页最多显示100条

最小值:1

最大值:100

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

work_hours

Array of work_hours objects

工时列表

total

Integer

总数

表4 work_hours

参数

参数类型

描述

project_name

String

项目名称

nick_name

String

用户昵称

user_id

String

用户id

user_name

String

用户名

work_date

String

工时日期

work_hours_num

String

工时花费

summary

String

工时内容

work_hours_type_name

String

工时类型

issue_id

Integer

工作项id

issue_type

String

工作项类型

subject

String

工作项标题

created_time

String

工作项创建时间

closed_time

String

工作项结束时间

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

状态码: 401

表6 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

请求示例

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

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

响应示例

状态码: 200

ok

{
  "work_hours" : [ {
    "project_name" : "项目名称",
    "nick_name" : "用户昵称",
    "user_id" : "09d75cdd9a00d44d2f17c01875483f26",
    "user_name" : "用户名",
    "work_date" : "2020-02-19",
    "work_hours_num" : "2.0",
    "summary" : "做了XXXXX",
    "work_hours_type_name" : "后端开发",
    "issue_id" : 123456,
    "issue_type" : "Story",
    "subject" : "工作项标题",
    "created_time" : "2019-12-17",
    "closed_time" : "2019-12-20"
  } ],
  "total" : 1
}

状态码

状态码

描述

200

ok

400

Bad Request

401

Unauthorized

错误码

请参见错误码