1. 授权认证
  2. 获取用户个人信息
  3. 项目协同
  4. 代码托管
  5. 持续集成
  6. 制品仓库
  7. 测试管理
  1. 项目协同
  2. 代码仓库
  3. DevOps 实践之旅
  4. 一分钟开始持续集成之旅
  5. 持续部署
  6. 制品库

查询事项列表

接口描述

中文:查询事项列表

英文:DescribeIssueList

输入参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeIssueList
ProjectName String 项目名称
IssueType Integer 事项类型
ALL - 全部事项
DEFECT - 缺陷
REQUIREMENT - 需求
MISSION - 任务
EPIC - 史诗
Offset Integer 偏移量
Limit Integer 限制数目
Conditions Array of IssueCondition 筛选条件列表
SortKey String 排序字段,默认:CODE
SortValue String 排序方式
DESC - 倒序(默认值)
ASC - 正序

输出参数

参数名称 类型 描述
IssueList Array of IssueListData 事项列表。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

IssueCondition

参数名称 类型 描述
Key String 字段名,例如:STATUS_TYPE。
自定义字段 Key 为 “CUSTOM”,同时需指定 CustomFieldId
Value String 筛选值,多选值用逗号隔开。
日期格式: 2020-08-01,日期时间格式: 2020-08-01 12:00:00
整数、小数、日期、日期时间类型的字段值应为一个范围,前后闭区间,范围开始值与结束值之间使用”_”连接,例如:”0.1_5.0”、”2020-08-01_2020-08-31”。
ConstValue String 常量值
“UNSPECIFIC” 表示未指定,例如:处理人、需求类型、标签等字段,使用此值来筛选未指定处理人、需求类型或标签的事项。
CustomFieldId Integer 自定义字段 Id,Key 为 “CUSTOM” 时需设置该值,常规字段无需设置。

IssueListData

参数名称 类型 描述
ParentType String 父事项类型
Code Integer 事项 Code
Type String 事项类型
Name String 名称
Description String 描述
IterationId Integer 迭代 Id
IssueStatusId Integer 迭代状态 Id
IssueStatusName String 迭代状态名称
IssueStatusType String 迭代状态类型,例如:TODO
Priority String 优先级
“0” - 低
“1” - 中
“2” - 高
“3” - 紧急
“” - 未指定
AssigneeId Integer 处理人 Id
StartDate Long 开始日期时间戳
DueDate Long 截止日期时间戳
WorkingHours Double 工时(小时)
CreatorId Integer 创建人 Id
StoryPoint String 故事点,例如:”0.5”、”0”
空字符串 “” 表示未指定。
CreatedAt Long 创建时间
UpdatedAt Long 修改时间
CompletedAt Long 完成时间

示例

输入示例

{
    "Action": "DescribeIssueList",
    "ProjectName": "demo-project",
    "IssueType": "ALL",
    "Offset": 0,
    "Limit": 10,
}

输出示例

{
    "Response": {
        "RequestId": "35c5b423-d311-d27f-f48c-a2ddf8b1cc59",
        "IssueList": [
            {
                "ParentType": "REQUIREMENT",
                "Code": 27,
                "Type": "REQUIREMENT",
                "Name": "test-20200826-1",
                "Description": "",
                "IterationId": 0,
                "IssueStatusId": 4,
                "IssueStatusName": "未开始",
                "IssueStatusType": "TODO",
                "Priority": "3",
                "AssigneeId": 0,
                "StartDate": 0,
                "DueDate": 0,
                "WorkingHours": 0.0,
                "CreatorId": 1,
                "StoryPoint": "0.5",
                "CreatedAt": 1598843625000,
                "UpdatedAt": 1598922564000,
                "CompletedAt": 0
            },
            {
                "ParentType": "REQUIREMENT",
                "Code": 25,
                "Type": "REQUIREMENT",
                "Name": "test-20200826-1",
                "Description": "",
                "IterationId": 0,
                "IssueStatusId": 4,
                "IssueStatusName": "未开始",
                "IssueStatusType": "TODO",
                "Priority": "3",
                "AssigneeId": 0,
                "StartDate": 0,
                "DueDate": 0,
                "WorkingHours": 0.0,
                "CreatorId": 1,
                "StoryPoint": "2.0",
                "CreatedAt": 1598517062000,
                "UpdatedAt": 1598851550000,
                "CompletedAt": 0
            },
            {
                "ParentType": "REQUIREMENT",
                "Code": 24,
                "Type": "REQUIREMENT",
                "Name": "test-20200826-1",
                "Description": "",
                "IterationId": 0,
                "IssueStatusId": 4,
                "IssueStatusName": "未开始",
                "IssueStatusType": "TODO",
                "Priority": "3",
                "AssigneeId": 0,
                "StartDate": 0,
                "DueDate": 0,
                "WorkingHours": 0.0,
                "CreatorId": 1,
                "StoryPoint": "",
                "CreatedAt": 1598511946000,
                "UpdatedAt": 1598511946000,
                "CompletedAt": 0
            }
        ]
    }
}
上一篇查询筛选器列表
最近更新
感谢反馈有用
感谢反馈没用