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

查询IR详情

功能介绍

查询单个IR。

调用方法

请参见如何调用API。

URI

GET /v4/programs/{program_id}/irs/{ir_id}

表1 路径参数

参数

是否必选

参数类型

描述

ir_id

是

String

参数解释：

IR的id。可以通过查询工作项列表接口获取，请求参数的issue_type为IR的时候，响应消息体中的issues.id字段的值就是ir_id。

约束限制：

正则表达式：[0-9]*。

取值范围：

不涉及。

默认取值：

不涉及。

program_id

是

String

参数解释：

项目空间ID（提出或归属），32位的uuid，可以通过查询项目空间列表接口获取，响应消息体中的program_id字段的值就是项目空间ID

约束限制：

正则表达式，[A-Za-z0-9]{32}

取值范围：

不涉及

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

必传。

取值范围：

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

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

accept_status

String

参数解释：

接纳状态

取值范围：

WAITING（待接纳）

ACCEPTED（已接纳）

REJECTED（已拒绝）

assigned_cc

Array of User objects

参数解释：

抄送人列表

取值范围：

不涉及

assigned_to

User object

参数解释：

处理人

child_count

Integer

参数解释：

直接子节点数量

取值范围：

不涉及

created_time

Long

参数解释：

创建时间，长整型时间戳

取值范围：

不涉及

creator

User object

参数解释：

创建人

custom_fields

Array of IrFieldBasic objects

参数解释：

自定义字段

description

String

参数解释：

描述

取值范围：

不涉及

done_ratio

String

参数解释：

完成度

取值范围：

可选：0%，20%，40%，60%，80%，100%

dst_program

Program object

参数解释：

目标项目

importance

String

参数解释：

重要程度

取值范围：

提示

一般

重要

关键

ir_id

String

参数解释：

IR的id

取值范围：

不涉及

node_type

String

参数解释：

节点类型

取值范围：

SUB_IR

TBD_IR

parent

String

参数解释：

父IR的id

取值范围：

不涉及

plan_due_date

String

参数解释：

预计结束日期，年-月-日

取值范围：

不涉及

plan_start_date

String

参数解释：

预计开始日期，年-月-日

取值范围：

不涉及

priority

String

参数解释：

优先级

取值范围：

低

中

高

region

String

参数解释：

区域

取值范围：

不涉及

sequence

String

参数解释：

编号

取值范围：

不涉及

src_program

Program object

参数解释：

源项目

status

String

参数解释：

状态

取值范围：

1（新建）

2（规划中）

3（开发中）

4（已完成）

5（已拒绝）

subject

String

参数解释：

标题

取值范围：

不涉及

tags

Array of InitialRequirementTag objects

参数解释：

标签列表

updated_time

Long

参数解释：

最后更新时间，长整型时间戳

取值范围：

不涉及

updater

User object

参数解释：

更新人
表4 User

参数

参数类型

描述

domain_id

String

参数解释：

租户uuid

取值范围：

不涉及

domain_name

String

参数解释：

租户名

取值范围：

不涉及

gender

String

参数解释：

性别

取值范围：

不涉及

nick_name

String

参数解释：

昵称

取值范围：

不涉及

user_id

String

参数解释：

用户uuid

取值范围：

不涉及

user_name

String

参数解释：

用户名

取值范围：

不涉及
表5 IrFieldBasic

参数

参数类型

描述

field_id

String

参数解释：

字段id

取值范围：

不涉及

label

String

参数解释：

字段页面显示

取值范围：

不涉及

name

String

参数解释：

字段名称

取值范围：

不涉及

option_source

String

参数解释：

字段值的来源范围

取值范围：

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

tag（标签）

Status（状态）

Importance（重要程度）

Priority（优先级）

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

type（输入值）

Text（字符串）

type

String

参数解释：

字段值输入的类型

取值范围：

不涉及
表6 Program

参数

参数类型

描述

name

String

参数解释：

项目空间名称

取值范围：

不涉及

program_id

String

参数解释：

项目空间的id

取值范围：

不涉及
表7 InitialRequirementTag

参数

参数类型

描述

color

Integer

参数解释：

标签颜色索引

取值范围：

0~7

name

String

参数解释：

标签的内容

取值范围：

不涉及

tag_id

String

参数解释：

标签的id

取值范围：

不涉及

状态码：400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：401

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

GET https://{endpoint}/v4/programs/41b5ccfa79904a9b9780005cd5ecc4d4/irs/4647058403938004992

响应示例

状态码：200

请求成功并返回数据

{
  "accept_status" : "待接纳",
  "assigned_cc" : [ {
    "domain_id" : "9b33eb1d219140fea54d3b5ac689b073",
    "domain_name" : "devcloud_test",
    "gender" : "男",
    "nick_name" : "红海",
    "user_id" : "0a938608ac00f2271f2ec01cccb94c19",
    "user_name" : "Banna"
  } ],
  "assigned_to" : {
    "domain_id" : "9b33eb1d219140fea54d3b5ac689b073",
    "domain_name" : "devcloud_test",
    "gender" : "男",
    "nick_name" : "红海",
    "user_id" : "0a938608ac00f2271f2ec01cccb94c19",
    "user_name" : "Banna"
  },
  "child_count" : 0,
  "created_time" : 1623123226808,
  "creator" : {
    "domain_id" : "9b33eb1d219140fea54d3b5ac689b073",
    "domain_name" : "devcloud_test",
    "gender" : "男",
    "nick_name" : "红海",
    "user_id" : "0a938608ac00f2271f2ec01cccb94c19",
    "user_name" : "Banna"
  },
  "custom_fields" : [ {
    "field_id" : "1",
    "label" : "标题",
    "name" : "Subject",
    "option_source" : "Text",
    "type" : "SingleLineText"
  } ],
  "description" : "创建IR样例",
  "done_ratio" : "0%",
  "dst_program" : {
    "name" : "样例空间",
    "program_id" : "0e7fbbbc472a4693a1835988f2fff76b"
  },
  "importance" : "一般",
  "ir_id" : "4647241055560245248",
  "node_type" : "TBD_IR",
  "parent" : "4647409374213619712",
  "plan_due_date" : "2021-07-18",
  "plan_start_date" : "2021-07-08",
  "priority" : "低",
  "region" : "region01",
  "sequence" : "7292456",
  "src_program" : {
    "name" : "样例空间",
    "program_id" : "0e7fbbbc472a4693a1835988f2fff76b"
  },
  "status" : "新建",
  "subject" : "创建IR样例",
  "tags" : [ {
    "color" : 4,
    "name" : "近期需求",
    "tag_id" : "4646373704819490816"
  } ],
  "updated_time" : 1623404966015,
  "updater" : {
    "domain_id" : "9b33eb1d219140fea54d3b5ac689b073",
    "domain_name" : "devcloud_test",
    "gender" : "男",
    "nick_name" : "红海",
    "user_id" : "0a938608ac00f2271f2ec01cccb94c19",
    "user_name" : "Banna"
  }
}

状态码

状态码

描述

200

请求成功并返回数据

400

Bad Request

401

Unauthorized

错误码

请参见错误码。

父主题： 需求池

相关文档