文档首页/ 需求管理 CodeArts Req/ API参考/ API/ IPD工时管理/ 查询工时类型 - ShowWorkHourCategory
更新时间:2026-09-15 GMT+08:00
分享

查询工时类型 - ShowWorkHourCategory

功能介绍

查询工时类型

调用方法

请参见如何调用API

授权信息

账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

codeartsreq:configuration:get

Read

-

  • codeartsreq:Model

  • codeartsreq:ProjectId

-

-

URI

GET /v1/ipdprojectservice/projects/{project_id}/work-hour/options

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及。

取值范围

32个字符,由英文字母和数字组成。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

display_value

String

参数解释

显示名称,支持模糊查询。

约束限制

0~30个字符。

取值范围

不涉及

默认取值

不涉及

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

status

String

参数解释

返回状态。

取值范围

success:响应成功。

error:响应失败

message

String

参数解释

消息。

取值范围

不涉及

result

Array of WorkHourCategoryVO objects

参数解释

工时类型。

表4 WorkHourCategoryVO

参数

参数类型

描述

id

String

参数解释

工时类型ID。

取值范围

18~19个字符的数字字符串。

value

String

参数解释

工时类型唯一标识值,用于接口传参。

取值范围

  • 研发设计

  • 后端开发

  • 前端开发(Web)

  • 前端开发(小程序)

  • 前端开发(App)

  • 测试验证

  • 缺陷修复

  • UI设计

  • 会议

  • 公共事务

  • 培训

  • 研究

  • 其它

  • 调休请假

  • 自定义工时类型

code

String

参数解释

工时类型唯一code码。

取值范围

与value字段取值相同。

sequence

Integer

参数解释

工时类型的显示排序序号。

取值范围

不涉及。

display_value

String

参数解释

工时类型的展示名称,用于页面显示。

取值范围

  • 研发设计

  • 后端开发

  • 前端开发(Web)

  • 前端开发(小程序)

  • 前端开发(App)

  • 测试验证

  • 缺陷修复

  • UI设计

  • 会议

  • 公共事务

  • 培训

  • 研究

  • 其它

  • 调休请假

  • 自定义工时类型

value_py

String

参数解释

工时类型展示名称的简拼(拼音首字母缩写)。

取值范围

不涉及。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

取值范围

不涉及。

error_msg

String

参数解释

错误描述,对error_code的补充解释。

取值范围

不涉及。

请求示例

模糊查询展示名带开发的工时类型

GET https://{endpoint}/v1/ipdprojectservice/projects/693d17d43d6340d782da7356efc584a7/work-hour/options?display_value=开发

响应示例

状态码:200

{
  "status" : "success",
  "message" : null,
  "result" : [ {
    "id" : "977516004109099010",
    "value" : "后端开发",
    "code" : "后端开发",
    "sequence" : 0,
    "display_value" : "后端开发",
    "value_py" : "hdkf"
  }, {
    "id" : "977516004109099016",
    "value" : "前端开发(Web)",
    "code" : "前端开发(Web)",
    "sequence" : 0,
    "display_value" : "前端开发(Web)",
    "value_py" : "qdkfw"
  }, {
    "id" : "977516004109099008",
    "value" : "前端开发(小程序)",
    "code" : "前端开发(小程序)",
    "sequence" : 0,
    "display_value" : "前端开发(小程序)",
    "value_py" : "qdkfc"
  }, {
    "id" : "977516004109099011",
    "value" : "前端开发(App)",
    "code" : "前端开发(App)",
    "sequence" : 0,
    "display_value" : "前端开发(App)",
    "value_py" : "qdkfa"
  } ]
}

状态码

状态码

描述

200

工时类型返回体

400

失败返回体

错误码

请参见错误码

相关文档