- 最新动态
- 功能总览
- 产品介绍
- 计费说明
- 快速入门
-
用户指南
- 需求管理(CodeArts Req)使用流程
- 购买并授权使用CodeArts Req
- 访问CodeArts Req服务首页
- 创建CodeArts项目
- 管理Scrum类型项目需求
- 管理IPD系统设备类型项目需求
- 管理IPD独立软件类型项目需求
- 管理IPD自运营/云服务类型项目需求
- 管理看板类型项目需求
- 查看审计日志(可选)
- 知识库用户指南
- 最佳实践
-
API参考
- 使用前必读
- API概览
- 如何调用API
-
API
- 用户信息
- 项目成员
- 项目信息
- 项目指标
- 项目统计
- 项目及成员
- Scrum项目的迭代
-
Scrum项目的工作项
- 创建工作项类型自定义字段
- 上传图片
- 获取工作项完成率
- 获取指定工作项的评论列表
- 按用户查询工时(单项目)
- 按用户查询工时(多项目)
- 添加指定工作项工时
- 查询项目下的工时类型
- 获取工作项历史记录
- 创建工作项
- 查询项目的工作项
- 高级查询工作项
- 批量删除工作项
- 查询工作项详情
- 更新工作项
- 删除工作项
- 获取子工作项
- 查询项目下所有工作项的历史记录
- 查询Scrum项目的工作项流转配置
- 细粒度权限用户创建工作项
- 查询当前工作项已经关联的工作项
- 查询当前工作项已经关联的关联Wiki
- 查询当前工作项已经关联的代码提交记录 / 分支创建记录
- 查询关联用例
- 查询Scrum工作项自定义字段
- 下载图片
- 上传工作项附件
- 下载工作项附件
- 删除附件
- 查询迭代下工作项状态的统计数据(处理人维度)
- 获取指定工作项停留时间
- 高级查询我的待办工作项
- Scrum项目的模块
- Scrum项目的领域
- Scrum项目的状态
- 看板项目的工作项
- IPD项目计划管理
- IPD工作项管理
- IPD统计概览
- IPD模块管理
- IPD配置管理
- IPD评审单管理
- IPD标签管理
- OpenAPI管理
- 应用示例
- 附录
- 文档修订记录
- 常见问题
- 视频帮助
- 文档下载
- 通用参考
链接复制成功!
查询字段列表
功能介绍
分页查询字段列表,关键字搜索支持标题、字段类型、创建人搜索
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/ipdprojectservice/projects/{project_id}/fields
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目Id |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
keyword |
否 |
String |
关键字搜索支持标题、字段类型、创建人搜索 |
offset |
是 |
Integer |
分页偏移量,从0开始,取值为limit的倍数 |
limit |
是 |
Integer |
分页大小 |
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
请求状态 |
message |
String |
请求失败信息 |
result |
FieldListResult object |
字段列表 |
参数 |
参数类型 |
描述 |
---|---|---|
display_name |
String |
字段显示名 |
code |
String |
字段code |
id |
String |
字段id |
description |
String |
字段描述 |
created_by |
String |
字段创建人显示名 |
created_date |
String |
字段创建时间 |
modified_by |
String |
字段最后更新人显示名 |
definition_type |
String |
字段级别 1,2,3为系统字段,4为租户字段,5为项目字段 |
field_type_name |
String |
字段类型名称 |
required |
Boolean |
字段在工作项中是否必填,为true表示必填。和工作流配置不一致时以工作流为准 |
controlled |
Boolean |
字段在工作项中是否受控,为true表示受控。修改已基线的工作项受控字段需要走变更评审流程。和工作流配置不一致时以工作流为准 |
immutable |
Boolean |
字段在工作项中是否可修改,为true时不可修改。和工作流配置不一致时以工作流为准 |
no |
Integer |
字段排序的序号 |
all_options |
Array of OptionEntity objects |
字段选项 |
请求示例
根据关键字查询字段列表
{endpoint}/v1/ipdprojectservice/projects/b54914d464d1498a97d683ef198ec448/fields?offset=0&limit=1
响应示例
状态码: 200
OK
{ "status" : "success", "result" : { "data" : [ { "display_name" : "小标题", "code" : "c7186197833374113792", "id" : "994277015639076864", "description" : "222222222222", "created_by" : "测试昵称", "created_date" : "1715305846000", "modified_by" : "测试昵称", "definition_type" : "4", "field_type_name" : "多行文本", "required" : false, "controlled" : false, "immutable" : false, "no" : 9999 } ], "total" : 1 } }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
错误码
请参见错误码。