文档首页/ 需求管理 CodeArts Req/ API参考/ API/ OpenAPI管理/ 根据条件查询工时列表-分页
更新时间：2024-11-30 GMT+08:00
查看PDF
分享

根据条件查询工时列表-分页

功能介绍

根据条件查询工时列表-分页

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v1/ipdprojectservice/projects/{project_id}/work-hour/query

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目id

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

params

是

WorkHourParamVO object

条件入参

page_info

是

RequestPageInfoVO object

分页参数
表3 WorkHourParamVO

参数

是否必选

参数类型

描述

plan_pi

否

Array of strings

发布条件id数组

plan_iteration

否

Array of strings

迭代条件id数组

workitem_id

否

Array of strings

工作项条件id数组

created_by

否

Array of strings

创建人条件id数组
表4 RequestPageInfoVO

参数

是否必选

参数类型

描述

offset

是

String

分页索引，偏移量，offset是limit的整数倍数，limit=10,offset=0,10,20...

limit

是

String

每页显示数量,最大值200

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

status

String

返回状态

message

String

返回体消息

result

Array of WorkHourInfoVO objects

返回数据

page

PageVO object

分页信息
表6 WorkHourInfoVO

参数

参数类型

描述

workitem

workitem object

工作项信息

work_date

String

工时日期

created_by

UserEntity object

创建人信息

work_hour_category

String

工时类型唯一标识取值为value，页面展示取值为display_value

work_hours

String

工时
表7 workitem

参数

参数类型

描述

plan_pi

String

发布id

sum_workload_man_day

String

实际工时

workload_man_day

String

计划工时

convolution_plan_hours

String

卷积计划工时

convolution_actual_hours

String

卷积实际工时

id

String

工作项id

plan_iteration

String

迭代id
表8 UserEntity

参数

参数类型

描述

id

String

用户Id

name

String

用户名称

nick_name

String

用户昵称
表9 PageVO

参数

参数类型

描述

page

String

当前页

size

String

每页条数

count

String

数据总数

状态码： 400

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

根据工作项id查询项目下工时

{url}/v1/ipdprojectservice/projects/05c7d8bcf3db4829bc841e4ba93aaea5/work-hour/query

{
  "params" : {
    "plan_pi" : [ ],
    "plan_iteration" : [ ],
    "workitem_id" : [ "976857692367659008" ],
    "created_by" : [ ]
  },
  "page_info" : {
    "offset" : 0,
    "limit" : 200
  }
}

响应示例

状态码： 200

工时信息以及分页信息返回

{
  "status" : "success",
  "message" : null,
  "result" : [ {
    "workitem" : {
      "plan_pi" : null,
      "sum_workload_man_day" : "112.00",
      "convolution_actual_hours" : null,
      "id" : "976857692367659008",
      "plan_iteration" : null
    },
    "work_date" : "1706803200000",
    "created_by" : {
      "id" : "a360371833bf4c558f796fd707b44daf",
      "name" : "devcloud_devcloud_s00404480_01",
      "nick_name" : "测试账号"
    },
    "work_hour_category" : "研发设计",
    "work_hours" : 6
  } ],
  "page" : {
    "page" : 1,
    "size" : 200,
    "count" : 1
  }
}

状态码

状态码

描述

200

工时信息以及分页信息返回

400

错误返回体

错误码

请参见错误码。

父主题： OpenAPI管理

相关文档