查询事项详情

文章内容

1. 接口描述
2. 输入参数
3. 输出参数
4. IssueDetail
5. UserSimple
6. ProjectModule
7. Label
8. ProjectFile
9. CustomField
10. ThirdLink
11. IssueSimple
12. Epic
13. SubTask
14. 示例

接口描述

中文：查询事项详情

英文：DescribeIssue

输入参数

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeIssue
ProjectName	是	String	项目名称
IssueCode	是	Integer	事项 Code

输出参数

参数名称	类型	描述
Issue	IssueDetail	事项信息。
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

IssueDetail

参数名称	类型	描述
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” - 紧急 “” - 未指定
Assignee	UserSimple	处理人，Assignee.Id 等于 0 时表示未指定。
StartDate	Long	开始日期时间戳
DueDate	Long	截止日期时间戳
WorkingHours	Double	工时（小时）
Creator	UserSimple	创建人
StoryPoint	String	故事点，例如：”0.5”、”0” 空字符串 “” 表示未指定。
CreatedAt	Long	创建时间
UpdatedAt	Long	修改时间
CompletedAt	Long	完成时间
ProjectModule	ProjectModule	项目模块，ProjectModule.Id 等于 0 时表示未指定。
Watchers	Array of UserSimple	关注人
Labels	Array of Label	标签列表
Files	Array of ProjectFile	附件列表
RequirementType		需求类型
DefectType	DefectType	缺陷类型
CustomFields	Array of CustomField	自定义字段列表
ThirdLinks	Array of ThirdLink	第三方链接列表
SubTasks	Array of SubTask	子任务列表
Parent	IssueSimple	父事项
Epic	Epic	所属迭代

UserSimple

参数名称	类型	描述
Id	Integer	用户 Id
Status	Integer	用户状态
Avatar	String	头像地址
Name	String	姓名
Email	String	邮箱

ProjectModule

参数名称	类型	描述
Id	Integer	用户 Id
Name	String	模块名称

Label

参数名称	类型	描述
Id	Integer	用户 Id
Name	String	名称
Color	String	颜色

ProjectFile

参数名称	类型	描述
FileId	Integer	文件 Id
Name	String	文件名称
Type	Integer	类型 0 - 文件夹 1 - 文本 2 - 图片 3 - 二进制 4 - SVG
Size	Long	大小（比特）
Url	String	下载地址

CustomField

参数名称	类型	描述
Id	Integer	自定义属性 Id
ValueString	String	自定义属性值，JSON 字符串 根据自定义属性的 ComponentType，返回不同类型的值，多选类型值为数组 另外：用户单选（SELECT_MEMBER_SINGLE）、用户多选（SELECT_MEMBER_MULTI）的自定义属性返回类型为 UserSimple 对象

ThirdLink

参数名称	类型	描述
Id	Integer	第三方链接 Id
ThirdType	Integer	第三方链接类型，MODAO - 墨刀
Link	String	链接地址
Title	String	名称

IssueSimple

参数名称	类型	描述
Code	Integer	事项 Code
Type	String	事项类型
Name	String	名称
IssueStatusId	Integer	迭代状态 Id
IssueStatusName	String	迭代状态名称
Priority	String	优先级
Assignee	UserSimple	处理人

Epic

参数名称	类型	描述
Code	Integer	事项 Code
Type	String	事项类型
Name	String	名称
IssueStatusId	Integer	迭代状态 Id
IssueStatusName	String	迭代状态名称
Priority	String	优先级
Assignee	UserSimple	处理人

SubTask

参数名称	类型	描述
Code	Integer	事项 Code
Type	String	事项类型
Name	String	名称
IssueStatusId	Integer	迭代状态 Id
IssueStatusName	String	迭代状态名称
Priority	String	优先级
Assignee	UserSimple	处理人

示例

输入示例

{
    "Action": "DescribeIssue",
    "ProjectName": "demo-project",
    "IssueCode": 1
}

输出示例

{
    "Response": {
        "RequestId": "d2e3c64c-99f8-1ef2-c148-36f7d6a81cfe",
        "Issue": {
            "ParentType": "REQUIREMENT",
            "Code": 1,
            "Type": "REQUIREMENT",
            "Name": "测试需求1",
            "Description": "# 标题1\n\n1. 列表1\n2. 列表2\n\n# 标题2\n\n1. 啦啦\n\n# 其他\n\n![图片](/api/project/1/files/11/imagePreview)\n123",
            "IterationId": 1,
            "IssueStatusId": 4,
            "IssueStatusName": "未开始",
            "IssueStatusType": "TODO",
            "Priority": "0",
            "Assignee": {
                "Id": 0,
                "Status": 0,
                "GlobalKey": "",
                "Avatar": "",
                "Media": "",
                "Name": "",
                "Email": ""
            },
            "StartDate": 0,
            "DueDate": 1596643199000,
            "WorkingHours": 0.0,
            "Creator": {
                "Id": 1,
                "Status": 2,
                "GlobalKey": "coding",
                "Avatar": "https://dn-coding-net-production-static.codehub.cn/512b2a62-956b-4ef8-8e84-b3c66e71468f.png?imageMogr2/auto-orient/format/png/crop/!300x300a0a0",
                "Media": "https://dn-coding-net-production-static.codehub.cn/512b2a62-956b-4ef8-8e84-b3c66e71468f.png?imageMogr2/auto-orient/format/png/crop/!300x300a0a0",
                "Name": "coding",
                "Email": ""
            },
            "StoryPoint": "",
            "CreatedAt": 1597384413000,
            "UpdatedAt": 1599035298000,
            "CompletedAt": 0,
            "ProjectModule": {
                "Id": 0,
                "Name": ""
            },
            "Watchers": [],
            "Labels": [],
            "Files": [],
            "RequirementType": {
                "Id": 0,
                "Name": ""
            },
            "DefectType": {
                "Id": 0,
                "Name": "",
                "IconUrl": ""
            },
            "CustomFields": [
                {
                    "Id": 16,
                    "ValueString": "[{\"Id\":1,\"Status\":2,\"GlobalKey\":\"coding\",\"Avatar\":\"https://dn-coding-net-production-static.codehub.cn/512b2a62-956b-4ef8-8e84-b3c66e71468f.png?imageMogr2/auto-orient/format/png/crop/!300x300a0a0\",\"Media\":\"https://dn-coding-net-production-static.codehub.cn/512b2a62-956b-4ef8-8e84-b3c66e71468f.png?imageMogr2/auto-orient/format/png/crop/!300x300a0a0\",\"Name\":\"coding\",\"Email\":\"coding@coding.com\",\"Name_pinyin\":\"\"}]"
                },
                {
                    "Id": 18,
                    "ValueString": "2020-08-06 02:02:00"
                },
                {
                    "Id": 19,
                    "ValueString": "123"
                }
            ],
            "ThirdLinks": [
                {
                    "Id": 1,
                    "ThirdType": "MODAO",
                    "Link": "https://modao.cc/app/7fb28d9af13827fd009f401579cbdc3cef2a456a/embed/v2",
                    "Title": "墨刀 1"
                }
            ],
            "SubTasks": [],
            "Parent": {
                "Code": 0,
                "Type": "",
                "Name": "",
                "IssueStatusId": 0,
                "IssueStatusName": "",
                "Priority": "",
                "Assignee": {
                    "Id": 0,
                    "Status": 0,
                    "GlobalKey": "",
                    "Avatar": "",
                    "Media": "",
                    "Name": "",
                    "Email": ""
                }
            },
            "Epic": {
                "Code": 0,
                "Type": "",
                "Name": "",
                "IssueStatusId": 0,
                "IssueStatusName": "",
                "Priority": "",
                "Assignee": {
                    "Id": 0,
                    "Status": 0,
                    "GlobalKey": "",
                    "Avatar": "",
                    "Media": "",
                    "Name": "",
                    "Email": ""
                }
            }
        }
    }
}

上一篇查询事项列表下一篇查询属性设置

最近更新

感谢反馈有用

感谢反馈没用

在阅读中是否遇到以下问题？

内容找不到

内容没更新

描述不清楚

链接有错误

步骤不完整

代码或图片缺失

您希望我们如何改进？

提交取消