# 根据空间及工作项获取需求/版本工作项记录列表(标题,完整的url)

用于根据空间及工作项获取需求/版本工作项记录列表(标题,完整的url)

# 请求

基本
HTTP URL https://hi-qa.weizhipin.com/open-apis/gaea/v1/work/items/records
HTTP Method POST
支持的应用类型 自建应用
权限要求开启任一权限即可 [喜鹊]-[根据空间及工作项获取需求/版本工作项记录列表(标题,完整的url)]

# 请求头

名称 类型 必填 描述
Authorization string tenant_access_token
值格式:"Bearer access_token"
示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560"
Content-Type string 固定值:"application/json; charset=utf-8"

# 请求体

名称 类型 必填 描述
system_code string 系统标识
space_id string 空间id
work_item_id string 需要查询的工作项记录id
user_id string 用户id值
user_id_type string 用户id类型,控制参数内用户 ID 的类型示例值:"open_id"
可选值有:
open_id:用户的 open id
union_id:用户的 union id
user_id:用户的 user id
默认值:open_id
keyword string 筛选关键词
page_no int 页码
page_size int 每页元素数

请求体示例

{
  "system_code": "AB", //示例值
  "space_id": "17ec343ef1beb61b1k0Z", //示例值
  "work_item_id": "WRECORD_1739581313998123008", //示例值
  "user_id": "11111704", //示例值
  "user_id_type": "user_id", //示例值
  "keyword": "xxxxx", //示例值
  "page_no": 1, //示例值
  "page_size": 10 //示例值
}
1
2
3
4
5
6
7
8
9
10

# 响应

# 响应体

{
  "code": "0",
  "traceId": "",
  "data": {
    "total": "xxx", //分页列表总数
    "pageNum": "xxxxx", //页码
    "pageSize": "xxx", //页面展示数
    "items": [ //分页列表数据
      {
        "recordId": "xxx", //工作项记录id
        "recordName": "xxxxx", //工作项记录名称
        "visitUrl": "xxx", //完整的访问路径
        "workItemId": "xxx", //工作项id
        "categoryCode": "xxx", //工作项类别,需求:feature, 任务:task, 版本:version
        "spaceId": "xxx" //所属空间id
      }
    ]
  },
  "msg": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

如果响应非成功状态,请对照 错误码文档

最后更新于 : 2/18/2024, 11:51:39 AM