# 根据条件查询工时列表-分页 - ShowWorkHours #### 功能介绍 根据条件查询工时列表-分页。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-projectman/projectman_api_1002.html)。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-projectman/projectman_03_Permission.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | codeartsreq:workhour:get | Read | - | - codeartsreq:Model - codeartsreq:ProjectId | - | - | #### URI POST /v1/ipdprojectservice/projects/{project_id}/work-hour/query 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目32位ID，项目唯一标识。通过[查询IPD项目列表](https://support.huaweicloud.com/api-projectman/ShowIpdProjectList.html)获取，响应消息体中的**id**字段的值就是项目ID。 **约束限制**： 不涉及。 **取值范围**： 32个字符，由英文字母和数字组成。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | params | 是 | [WorkHourParamVO] object | **参数解释**： 条件入参。 | | page_info | 是 | [RequestPageInfoVO] object | **参数解释**： 分页参数。 | 表3WorkHourParamVO | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | plan_pi | 否 | Array of strings | **参数解释**： 发布计划ID数组，可以通过[发布/迭代计划详情查询](https://support.huaweicloud.com/api-projectman/ListPlanDetail.html)接口获取，响应消息体中的**id**字段的值就是发布计划ID。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | plan_iteration | 否 | Array of strings | **参数解释**： 迭代计划ID数组，可以通过[发布/迭代计划详情查询](https://support.huaweicloud.com/api-projectman/ListPlanDetail.html)接口获取，响应消息体中的**id**字段的值就是迭代计划ID。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | workitem_id | 否 | Array of strings | **参数解释**： 工作项ID数组，可以通过[查询工作项详情](https://support.huaweicloud.com/api-projectman/ShowIssueV4.html)接口获取，响应消息体中的**id**字段的值就是。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | created_by | 否 | Array of strings | **参数解释**： 创建人ID数组，可通过[查询项目成员列表](https://support.huaweicloud.com/api-projectman/ListProjectUsers.html)接口获取，响应消息体中的**id**字段的值就是用户ID。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | 表4RequestPageInfoVO | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 是 | String | **参数解释**： 分页起始，从0开始，为limit整数倍。 **约束限制**： 从0开始。 **取值范围**： 最小值：0。 **默认取值**： 0 | | limit | 是 | String | **参数解释**： 每页显示数量，最大值200。 **约束限制**： 不涉及 **取值范围**： 最小值：1，最大值：200。 **默认取值**： 不涉及 | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | status | String | **参数解释**： 返回状态。 **取值范围**： success：响应成功。 error：响应失败 | | message | String | **参数解释**： 返回体消息。 **取值范围**： 不涉及 | | result | Array of [WorkHourInfoVO] objects | **参数解释**： 返回数据。 | | page | [PageVO] object | **参数解释**： 分页信息。 | 表6WorkHourInfoVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | workitem | [workitem] object | **参数解释**： 工作项信息。 | | work_date | String | **参数解释**： 工时日期，unix时间戳，单位：毫秒。 **取值范围**： 不涉及 | | created_by | [UserEntity] object | **参数解释**： 创建人信息。 | | work_hour_category | String | **参数解释**： 工时类型唯一标识取值为value，页面展示取值为display_value。 **取值范围**： 不涉及 | | work_hours | String | **参数解释**： 工时。 **取值范围**： 不涉及 | 表7workitem | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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。 **取值范围**： 不涉及 | 表8UserEntity | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 用户ID，可通过[查询项目成员列表](https://support.huaweicloud.com/api-projectman/ListProjectUsers.html)接口获取，响应消息体中的**id**字段的值就是用户ID。 **取值范围**： 不涉及。 | | name | String | **参数解释**： 用户名称。 **取值范围**： 2\~64个字符。 | | nick_name | String | **参数解释**： 用户昵称。 **取值范围**： 2\~30个字符。 | 表9PageVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | page | String | **参数解释**： 当前页。 **取值范围**： 不涉及 | | size | String | **参数解释**： 每页条数。 **取值范围**： 不涉及 | | count | String | **参数解释**： 数据总数。 **取值范围**： 不涉及 | **状态码：400** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。 **取值范围**： 不涉及。 | | error_msg | String | **参数解释**： 错误描述，对error_code的补充解释。 **取值范围**： 不涉及。 | #### 请求示例 根据工作项ID查询项目下工时 ``` POST https://{endpoint}/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_01", "nick_name" : "测试账号" }, "work_hour_category" : "研发设计", "work_hours" : 6 } ], "page" : { "page" : 1, "size" : 200, "count" : 1 } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 工时信息以及分页信息返回 | | 400 | 错误返回体 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-projectman/ErrorCode.html)。