- 最新动态
- 功能总览
- 产品介绍
- 快速入门
-
用户指南
- 需求管理(CodeArts Req)使用流程
- 购买并授权使用CodeArts Req
- 访问CodeArts Req服务首页
- 管理项目群
- 创建CodeArts项目
- 管理Scrum类型项目需求
- 管理IPD系统设备类型项目需求
- 管理IPD独立软件类型项目需求
- 查看审计日志（可选）
- 最佳实践
- API参考
- 常见问题
- 视频帮助
- 通用参考
链接复制成功！
查询项目列表
功能介绍
查询项目列表
URI
GET /v4/projects
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
query_type |
否 |
String |
默认返回当前用户参与的项目列表,domain_projects租户下的所有项目列表,absent返回当前用户未参与的租户项目列表 |
|
limit |
是 |
Integer |
条数 最小1条,最大1000 |
|
offset |
是 |
Integer |
偏移量 从0开始 |
|
search |
否 |
String |
模糊查询项目名称或描述,不支持通配符等高级查询 |
|
project_type |
否 |
String |
项目类型 scrum|xboard |
|
sort |
否 |
String |
排序条件 默认创建时间降序(name|created_on)(asc|desc) |
|
archive |
否 |
String |
是否归档 true已归档|false未归档 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
projects |
Array of projects objects |
项目信息列表 |
|
total |
Integer |
项目总数 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
project_num_id |
Integer |
项目numId |
|
project_id |
String |
项目uuid |
|
project_name |
String |
项目名称 |
|
description |
String |
项目描述 |
|
created_time |
Long |
项目创建时间 |
|
updated_time |
Long |
项目更新时间 |
|
project_type |
String |
项目类型 |
|
creator |
creator object |
创建者信息 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
user_num_id |
Integer |
创建人numId |
|
user_id |
String |
创建人id |
|
user_name |
String |
创建人姓名 |
|
domain_id |
String |
创建人租户id |
|
domain_name |
String |
创建人租户名称 |
|
nick_name |
String |
创建人租户昵称 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
错误描述 |
|
error_code |
String |
错误码 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
错误描述 |
|
error_code |
String |
错误码 |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
错误描述 |
|
error_code |
String |
错误码 |
请求示例
GET https://{endpoint}/v4/projects?limit=10&offset=0&project_type=scrum&sort=&search=aa&archive=true&query_type=domain_projects响应示例
状态码：200
OK
{
"projects" : [ {
"project_num_id" : 3183801,
"project_id" : "41bd3eab86544863b8fc92ffcd35e3c8",
"project_name" : "demo_project",
"description" : "demo",
"created_time" : 1576114296000,
"updated_time" : 1576114296000,
"project_type" : "xboard",
"creator" : {
"user_num_id" : 4097,
"user_id" : "c4bd39f0573a436589714bedbcca8536",
"user_name" : "modile_user",
"domain_id" : "2489d8cbba804db8bcd35384685ff3ac",
"domain_name" : "modile_user",
"nick_name" : "Tom.M.Riddle"
}
} ],
"total" : 10
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
错误码
请参见错误码。
