文档首页/ 需求管理 CodeArts Req/ API参考/ API/ 需求池/ 查询项目空间的IR或者RR字段
更新时间：2025-07-28 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询项目空间的IR或者RR字段

功能介绍

查询项目空间的IR或者RR字段。

调用方法

请参见如何调用API。

URI

GET /v4/programs/{program_id}/fields

表1 路径参数

参数

是否必选

参数类型

描述

program_id

是

String

参数解释：

项目空间id（提出或归属）

约束限制：

[0-9a-z]{32}

取值范围：

不涉及

默认取值：

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

field_type

是

String

参数解释：

查询类型

约束限制：

不涉及

取值范围：

RR

IR

默认取值：

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

必传。

取值范围：

最小长度：10，最大长度：32768。

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

fields

Array of ProgramField objects

参数解释：

项目空间中RR的字段列表
表5 ProgramField

参数

参数类型

描述

config

ProgramFieldConfig object

参数解释：

字段配置信息

default_value_can_update

Boolean

参数解释：

字段的默认值是否可以更改

取值范围：

true（可更改）

false（不可更改）

id

String

参数解释：

字段id

取值范围：

不涉及

label

String

参数解释：

字段在页面上显示的含义

取值范围：

不涉及

name

String

参数解释：

字段名称

取值范围：

不涉及

option_source

String

参数解释：

字段值的来源范围

取值范围：

User（字段值可以是在项目空间中的所有成员）

tag（标签）

Status（状态）

Importance（重要程度）

Priority（优先级）

Direct（字段值为根据数据类型）

type（输入值）

Text（字符串）

options

Array of ProgramFieldOption objects

参数解释：

该字段可选值

取值范围：

不涉及

required_can_update

Boolean

参数解释：

更新是否必填

约束限制：

true（必填）

false（非必填）

type

String

参数解释：

字段的类型

约束限制：

不涉及
表6 ProgramFieldConfig

参数

参数类型

描述

default_value

Array of default_value objects

参数解释：

默认值

field_id

String

参数解释：

字段id

取值范围：

不涉及

required

Boolean

参数解释：

是否必填

取值范围：

不涉及
表7 default_value

参数

参数类型

描述

id

String

参数解释：

默认值id

取值范围：

不涉及

label

String

参数解释：

字段值页面显示含义

取值范围：

不涉及

name

String

参数解释：

字段值名称

取值范围：

不涉及
表8 ProgramFieldOption

参数

参数类型

描述

id

String

参数解释：

该字段可填入的值，创建RR时填入

取值范围：

不涉及

label

String

参数解释：

该字段值在页面显示的值

取值范围：

不涉及

name

String

参数解释：

字段名称

取值范围：

不涉及

状态码：400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：401

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

GET https://{endpoint}/v4/programs/41b5ccfa79904a9b9780005cd5ecc4d4/fields?field_type=RR

响应示例

状态码：200

请求成功并返回数据（数组）

{
  "fields" : [ {
    "config" : {
      "default_value" : [ {
        "id" : "1",
        "label" : "默认选项1",
        "name" : "default1"
      } ],
      "field_id" : "field1",
      "required" : true
    },
    "default_value_can_update" : true,
    "id" : "field1",
    "label" : "任务名称",
    "name" : "task_name",
    "option_source" : "Text",
    "options" : [ {
      "id" : "option1",
      "label" : "选项1",
      "name" : "option1"
    }, {
      "id" : "option2",
      "label" : "选项2",
      "name" : "option2"
    } ],
    "required_can_update" : false,
    "type" : "Text"
  }, {
    "config" : {
      "default_value" : [ ],
      "field_id" : "field2",
      "required" : false
    },
    "default_value_can_update" : false,
    "id" : "field2",
    "label" : "任务状态",
    "name" : "task_status",
    "option_source" : "Status",
    "options" : [ ],
    "required_can_update" : true,
    "type" : "Select"
  } ]
}

状态码

状态码

描述

200

请求成功并返回数据（数组）

400

Bad Request

401

Unauthorized

错误码

请参见错误码。

父主题： 需求池

相关文档