文档首页/ 需求管理 CodeArts Req/ API参考/ API/ Scrum项目的工作项/ 查询项目下的工时类型
更新时间：2024-03-07 GMT+08:00
查看PDF
分享

查询项目下的工时类型

功能介绍

查询项目下的工时类型

调用方法

请参见如何调用API。

URI

GET /v4/projects/{project_id}/work-hours-type

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目id
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

每页显示的数量，默认显示10条，最多显示100条

最小值：1

最大值：100

缺省值：10

offset

否

Integer

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

最小值：0

缺省值：0

status

否

Integer

工时类型状态，支持按状态筛选查询，置空时查询所有工时类型，1表示查询启用的工时类型，2表示查询未启用的工时类型

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

最小长度：10

最大长度：32768

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

work_hours_types

Array of WorkHoursType objects

工时类型列表

total

Integer

总数
表5 WorkHoursType

参数

参数类型

描述

id

Integer

工时类型id

name

String

工时类型名称

status

Integer

工时类型状态，1表示启用中，2表示未启用

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

请求示例

Get https://{endpoint}/v4/projects/e2da96a5d2c845e284f0ad47f8ca8cb2/work-hours-type

Get https://{endpoint}/v4/projects/e2da96a5d2c845e284f0ad47f8ca8cb2/work-hours-type?limit=1&offset=0

响应示例

状态码： 200

ok

{
  "work_hours_types" : [ {
    "id" : 21,
    "name" : "研发设计",
    "status" : 1
  }, {
    "id" : 22,
    "name" : "后端开发",
    "status" : 1
  }, {
    "id" : 23,
    "name" : "前端开发(Web)",
    "status" : 1
  }, {
    "id" : 24,
    "name" : "前端开发(小程序)",
    "status" : 1
  }, {
    "id" : 25,
    "name" : "前端开发(App)",
    "status" : 1
  }, {
    "id" : 26,
    "name" : "测试验证",
    "status" : 1
  }, {
    "id" : 27,
    "name" : "缺陷修复",
    "status" : 1
  } ],
  "total" : 7
}

状态码

状态码

描述

200

ok

400

Bad Request

401

Unauthorized

错误码

请参见错误码。

相关文档