文档首页/ 需求管理 CodeArts Req/ API参考/ API/ 需求池/ 查询RR列表
更新时间：2025-10-15 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询RR列表

功能介绍

分页查询RR(总量/提出/接收)

调用方法

请参见如何调用API。

URI

GET /v4/programs/{program_id}/rrs

表1 路径参数

参数

是否必选

参数类型

描述

program_id

是

String

项目空间id（提出或归属），32位的uuid
表2 Query参数

参数

是否必选

参数类型

描述

query_type

是

String

查询类型：可选ALL | DST | SRC；ALL（总量需求）查询[本空间]提给[本空间]的[根]RR + [本空间]提给[其他空间]的[根]RR + [其他空间]提给[本空间]的[根]RR + [其他空间]提给[本空间]的[子]IR；DST（归属内部）查询[本空间]提给[本空间]的[根]RR + [其他空间]提给[本空间]的[根]RR + [其他空间]提给[本空间]的[子]RR；SRC（提给外部）查询[本空间]提给[其他空间]的[根]RR

offset

是

Integer

参数解释：

分页索引，偏移量，offset是limit的整数倍数。

约束限制：

从0开始。

取值范围：

最小值：0，最大值：10000。

默认取值：

缺省值：0

limit

是

Integer

参数解释：

条数，每页显示查询的数量。

约束限制：

不涉及。

取值范围：

最小值：1，最大值：1000。

默认取值：

10

include_deleted

否

Boolean

参数解释：

是否包含被删除的IR，默认false不包含被删除的IR

约束限制：

不涉及

取值范围：

true，false

默认取值：

false

updated_time_interval

否

String

参数解释：

更新RR的时间(查询的起始时间,查询的结束时间)，unix时间戳，单位：毫秒

样例：1576114296000,1576114396000

约束限制：

正则表达式，([1-9][0-9]{0,12})?(,)?([1-9][0-9]{0,12})?。

取值范围：

不涉及

默认取值：

不涉及

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

rrs

Array of Requirement objects

参数解释：

查询返回的RR列表

total

Integer

参数解释：

查询RR返回的总数

取值范围：

不涉及
表4 Requirement

参数

参数类型

描述

accept_status

String

参数解释：

接纳状态。

取值范围：

WAITING、ACEPTED、REJECTED。

created_on

String

参数解释：

创建时间。

取值范围：

不涉及。

creator

RrUser object

参数解释：

RR项目管理用户创建信息。

deleted

Boolean

参数解释：

是否已经删除。

取值范围：

true 已经删除， false 未删除。

dst_program

Program object

参数解释：

项目信息。

fields_map

RequirementFieldList object

参数解释：

列表元素结构。

id

String

参数解释：

原始需求id。

取值范围：

不涉及。

node_type

String

参数解释：

节点类型: RR。

取值范围：

不涉及。

parent

String

参数解释：

父RR的id。

取值范围：

不涉及。

region

String

参数解释：

原始需求的region信息。

取值范围：

不涉及。

sequence

String

参数解释：

原始需求的顺序信息。

取值范围：

不涉及。

src_program

Program object

参数解释：

项目信息。

updated_on

String

参数解释：

最后更新时间。

取值范围：

不涉及。

updater

RrUser object

参数解释：

RR项目管理用户更新信息。
表5 RequirementFieldList

参数

参数类型

描述

approver

RrFieldUserValue object

参数解释：

批准人。

assigned_cc

RrFieldListUserValue object

参数解释：

抄送人。

assigned_to

RrFieldUserValue object

参数解释：

分配责任人。

dst_program

Program object

参数解释：

目标项目。

expected_due_date

RrFieldSingleValue object

参数解释：

预计到期日期。

plan_due_date

RrFieldSingleValue object

参数解释：

计划到期日期。

plan_start_date

RrFieldSingleValue object

参数解释：

计划开始日期。

status

RrFieldStatusValue object

参数解释：

RR状态。

subject

RrFieldSingleValue object

参数解释：

RR主题。

tag

RrFieldTagValue object

参数解释：

RR标签。
表6 RrFieldListUserValue

参数

参数类型

描述

field_id

String

参数解释：

字段id。

取值范围：

不涉及。

label

String

参数解释：

字段页面显示。

取值范围：

不涉及。

name

String

参数解释：

字段名称。

取值范围：

不涉及。

option_source

String

参数解释：

字段值的来源范围。

取值范围：

User字段值可以是在项目空间中的所有成员，tag标签，

Status状态，Importance重要程度，Priority优先级

Direct字段值为根据数据类型type输入值,Text字符串。

type

String

参数解释：

字段值输入的类型。

取值范围：

不涉及。

value

Array of RrUser objects

参数解释：

用户信息。
表7 RrUser

参数

参数类型

描述

domain_id

String

参数解释：

租户uuid。

取值范围：

不涉及。

domain_name

String

参数解释：

租户名。

取值范围：

不涉及。

nick_name

String

参数解释：

昵称。

取值范围：

不涉及。

user_id

String

参数解释：

用户uuid。

取值范围：

不涉及。

user_name

String

参数解释：

用户名。

取值范围：

不涉及。
表8 RrFieldUserValue

参数

参数类型

描述

field_id

String

参数解释：

字段id。

取值范围：

不涉及。

label

String

参数解释：

字段页面显示。

取值范围：

不涉及。

name

String

参数解释：

字段名称。

取值范围：

不涉及。

option_source

String

参数解释：

字段值的来源范围。

取值范围：

User字段值可以是在项目空间中的所有成员，tag标签，

Status状态，Importance重要程度，Priority优先级

Direct字段值为根据数据类型type输入值,Text字符串。

type

String

参数解释：

字段值输入的类型。

取值范围：

不涉及。

value

RrUser object

参数解释：

RR用户信息。
表9 RrFieldStatusValue

参数

参数类型

描述

field_id

String

参数解释：

字段id。

取值范围：

不涉及。

label

String

参数解释：

字段页面显示。

取值范围：

不涉及。

name

String

参数解释：

字段名称。

取值范围：

不涉及。

option_source

String

参数解释：

字段值的来源范围。

取值范围：

User字段值可以是在项目空间中的所有成员，tag标签，

Status状态，Importance重要程度，Priority优先级

Direct字段值为根据数据类型type输入值,Text字符串。

type

String

参数解释：

字段值输入的类型。

取值范围：

不涉及。

value

value object

参数解释：

字段值。
表10 value

参数

参数类型

描述

id

String

参数解释：

字段值的id。

取值范围：

不涉及。

name

String

参数解释：

字段值。

取值范围：

不涉及。
表11 RrFieldSingleValue

参数

参数类型

描述

field_id

String

参数解释：

字段id。

取值范围：

不涉及。

label

String

参数解释：

字段页面显示。

取值范围：

不涉及。

name

String

参数解释：

字段名称。

取值范围：

不涉及。

option_source

String

参数解释：

字段值的来源范围。

取值范围：

User字段值可以是在项目空间中的所有成员，tag标签，

Status状态，Importance重要程度，Priority优先级

Direct字段值为根据数据类型type输入值,Text字符串。

type

String

参数解释：

字段值输入的类型。

取值范围：

不涉及。

value

String

参数解释：

字段值。

取值范围：

不涉及。
表12 RrFieldTagValue

参数

参数类型

描述

field_id

String

参数解释：

字段id。

取值范围：

不涉及。

label

String

参数解释：

字段页面显示。

取值范围：

不涉及。

name

String

参数解释：

字段名称。

取值范围：

不涉及。

option_source

String

参数解释：

字段值的来源范围。

取值范围：

User字段值可以是在项目空间中的所有成员，tag标签，

Status状态，Importance重要程度，Priority优先级

Direct字段值为根据数据类型type输入值,Text字符串。

type

String

参数解释：

字段值输入的类型。

取值范围：

不涉及。

value

Array of InitialRequirementTag objects

参数解释：

标签值。
表13 InitialRequirementTag

参数

参数类型

描述

color

Integer

参数解释：

标签颜色索引

取值范围：

0~7

name

String

参数解释：

标签的内容

取值范围：

不涉及

tag_id

String

参数解释：

标签的id

取值范围：

不涉及
表14 Program

参数

参数类型

描述

name

String

参数解释：

项目空间名称

取值范围：

不涉及

program_id

String

参数解释：

项目空间的id

取值范围：

不涉及

状态码：400

表15 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：401

表16 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

GET https://{endpoint}/v4/programs/41b5ccfa79904a9b9780005cd5ecc4d4/rrs

响应示例

状态码：200

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

{
  "rrs" : [ {
    "accept_status" : "string",
    "created_on" : "1626680225895",
    "creator" : {
      "domain_id" : "9b33eb1d219140fea54d3b5ac689b073",
      "domain_name" : "devcloud_test",
      "nick_name" : "红海",
      "user_id" : "0a938608ac00f2271f2ec01cccb94c19",
      "user_name" : "Banna"
    },
    "deleted" : false,
    "dst_program" : {
      "name" : "样例空间",
      "program_id" : "0e7fbbbc472a4693a1835988f2fff76b"
    },
    "fields_map" : {
      "approver" : {
        "field_id" : "1",
        "label" : "标题",
        "name" : "Subject",
        "option_source" : "Text",
        "type" : "SingleLineText",
        "value" : {
          "domain_id" : "9b33eb1d219140fea54d3b5ac689b073",
          "domain_name" : "devcloud_test",
          "nick_name" : "红海",
          "user_id" : "0a938608ac00f2271f2ec01cccb94c19",
          "user_name" : "Banna"
        }
      },
      "assigned_cc" : {
        "field_id" : "1",
        "label" : "标题",
        "name" : "Subject",
        "option_source" : "Text",
        "type" : "SingleLineText",
        "value" : [ {
          "domain_id" : "9b33eb1d219140fea54d3b5ac689b073",
          "domain_name" : "devcloud_test",
          "nick_name" : "红海",
          "user_id" : "0a938608ac00f2271f2ec01cccb94c19",
          "user_name" : "Banna"
        } ]
      },
      "assigned_to" : {
        "field_id" : "1",
        "label" : "标题",
        "name" : "Subject",
        "option_source" : "Text",
        "type" : "SingleLineText",
        "value" : {
          "domain_id" : "9b33eb1d219140fea54d3b5ac689b073",
          "domain_name" : "devcloud_test",
          "nick_name" : "红海",
          "user_id" : "0a938608ac00f2271f2ec01cccb94c19",
          "user_name" : "Banna"
        }
      },
      "dst_program" : {
        "name" : "样例空间",
        "program_id" : "0e7fbbbc472a4693a1835988f2fff76b"
      },
      "expected_due_date" : {
        "field_id" : "1",
        "label" : "标题",
        "name" : "Subject",
        "option_source" : "Text",
        "type" : "SingleLineText",
        "value" : "样例"
      },
      "plan_due_date" : {
        "field_id" : "1",
        "label" : "标题",
        "name" : "Subject",
        "option_source" : "Text",
        "type" : "SingleLineText",
        "value" : "样例"
      },
      "plan_start_date" : {
        "field_id" : "1",
        "label" : "标题",
        "name" : "Subject",
        "option_source" : "Text",
        "type" : "SingleLineText",
        "value" : "样例"
      },
      "status" : {
        "field_id" : "1",
        "label" : "标题",
        "name" : "Subject",
        "option_source" : "Text",
        "type" : "SingleLineText",
        "value" : {
          "id" : "22",
          "name" : "builtin#status_working"
        }
      },
      "subject" : {
        "field_id" : "1",
        "label" : "标题",
        "name" : "Subject",
        "option_source" : "Text",
        "type" : "SingleLineText",
        "value" : "样例"
      },
      "tag" : {
        "field_id" : "1",
        "label" : "标题",
        "name" : "Subject",
        "option_source" : "Text",
        "type" : "SingleLineText",
        "value" : [ {
          "color" : 4,
          "name" : "近期需求",
          "tag_id" : "4646373704819490816"
        } ]
      }
    },
    "id" : "4661233167082606592",
    "node_type" : "RR",
    "parent" : "4659830057079767040",
    "region" : "region01",
    "sequence" : "5864667",
    "src_program" : {
      "name" : "样例空间",
      "program_id" : "0e7fbbbc472a4693a1835988f2fff76b"
    },
    "updated_on" : "1626680225895",
    "updater" : {
      "domain_id" : "9b33eb1d219140fea54d3b5ac689b073",
      "domain_name" : "devcloud_test",
      "nick_name" : "红海",
      "user_id" : "0a938608ac00f2271f2ec01cccb94c19",
      "user_name" : "Banna"
    }
  } ],
  "total" : 1
}

状态码：400

Bad Request

{
  "error_code" : "PM.00000001",
  "error_msg" : "参数错误"
}

状态码：401

Unauthorized

{
  "error_code" : "PM.00000001",
  "error_msg" : "参数错误"
}

状态码

状态码

描述

200

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

400

Bad Request

401

Unauthorized

错误码

请参见错误码。

父主题： 需求池

相关文档