# 说明
根据ID获取业务对象信息
# url
https://apiv2.tapd.tencent.com/workitems/quick_search
# 支持格式
JSON/XML(默认JSON格式)
# HTTP请求方式
GET
# 请求参数
字段名 | 必选 | 类型及范围 | 说明 | 特殊规则 |
---|---|---|---|---|
id | 是 | integer | 短ID或长ID | |
workspace_id | 否 | integer | 项目id(缩小查找范围,提升查找速度) | |
types | 否 | string | 查找业务对象类型的范围 | 候选值:story,task,bug(多类型以“,”分隔) |
其余支持参数参照各业务对象的获取文档
# 调用示例及返回结果
# 根据短id获取业务对象信息
# curl 使用 Basic Auth 鉴权调用示例
curl -u 'api_user:api_password' 'https://apiv2.tapd.tencent.com/workitems/quick_search?id=500585465&with_v_status=1&fields=id,created,owner,name,title&types=story,bug'
# curl 使用 OAuth Access Token 鉴权调用示例
curl 'https://apiv2.tapd.tencent.com/workitems/quick_search?id=500585465&with_v_status=1&fields=id,created,owner,name,title&types=story,bug&access_token=ACCESS_TOKEN'
# 返回结果
{
"status": 1,
"data": {
"bug": [
{
"Bug": {
"id": "1100000755500585465",
"created": "2014-06-11 15:40:41",
"title": "this is test bug1"
}
},
{
"Bug": {
"id": "1100000755500585465",
"created": "2014-06-11 15:40:41",
"title": "this is test bug2"
}
}
],
"story": [
{
"Story": {
"id": "1010083881500585465",
"created": "2023-11-10 16:23:31",
"owner": "",
"name": "this is test story1"
}
},
{
"Story": {
"id": "1010083881500585465",
"created": "2023-11-10 16:23:31",
"owner": "",
"name": "this is test story2"
}
}
]
},
"info": "success"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# 数据权限说明
# 如返回结果受限,可按如下规则确认数据权限
- 确认传入的workspace_id或获取的长ID对应的workspace_id是否在API账号授权项目范围内
- 确认API账号是否有对应的业务对象获取权限