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

查询具体事项类型的属性列表

接口描述

中文:查询具体事项类型的属性列表

英文:DescribeProjectIssueFieldList

输入参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeProjectIssueFieldList
ProjectName String 项目名称
IssueType String 事项类型
DEFECT - 缺陷
REQUIREMENT - 需求
MISSION - 任务
EPIC - 史诗
SUB_TASK - 子任务

输出参数

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

ProjectIssueField

参数名称 类型 描述
IssueFieldId Integer 关联属性 Id
NeedDefault String 是否有默认值
ValueString String 默认值, JSON 字符串。例如:{“type”:”VARIABLE”,”value”:”CREATOR”}
type:默认值类型,VARIABLE - 变量值(如创建者为 CREATOR) | CONSTANT - 常量值
value:默认值,根据 IssueField.ComponentType,可能为不同类型的值:数值、字符串、数组等
IssueType String 事项类型
Required String 是否必填
IssueField IssueField 关联属性
CreatedAt Long 创建时间
UpdatedAt Long 修改时间

IssueField

参数名称 类型 描述
Id Integer 属性 Id
Name String 名称
IconUrl String 图标地址
Type String 字段类型
ComponentType String 字段空间类型
TEXT_SINGLE_LINE - 单行文本
TEXT_MULTI_LINE - 多行文本
SELECT_SINGLE - 单选列表
SELECT_MULTI - 多选列表
RADIO - 单选框
CHECKBOX - 多选框
SELECT_MEMBER_SINGLE - 用户单选列表
SELECT_MEMBER_MULTI - 用户多选列表
TEXT_DATETIME - 日期时间选择框
TEXT_DATE - 日期选择框
TEXT_INTEGER - 整数输入框
TEXT_DECIMAL - 小数输入框
Description String 事项类型
Options Array of IssueFieldOption 选项列表
Unit String 单位
Selectable Boolean 项目中属性可选
Required Boolean 是否比天
Editable Boolean 是否可修改
Deletable Boolean 是否可删除
Sortable Boolean 是否可排序
CreatedBy Integer 创建者
CreatedAt Long 创建时间
UpdatedAt Long 修改时间

IssueFieldOption

参数名称 类型 描述
Icon String 选项图标地址
Sort String 排序
Title String 选项标题
Value String 选项值

示例

输入示例

{
    "Action": "DescribeProjectIssueFieldList",
    "ProjectName": "demo-project",
    "IssueType": "REQUIREMENT"
}

输出示例

{
    "Response": {
        "RequestId": "b2f77ca4-a34c-efde-29aa-389940fc8673",
        "ProjectIssueFieldList": [
            {
                "IssueFieldId": 1,
                "NeedDefault": false,
                "ValueString": "",
                "IssueType": "REQUIREMENT",
                "Required": false,
                "IssueField": {
                    "Id": 1,
                    "TeamId": 1,
                    "Name": "处理人",
                    "IconUrl": "",
                    "Type": "ASSIGNEE",
                    "ComponentType": "SELECT_MEMBER_SINGLE",
                    "Description": "",
                    "Options": [],
                    "Unit": "",
                    "Selectable": false,
                    "Required": false,
                    "Editable": false,
                    "Deletable": false,
                    "Sortable": true,
                    "CreatedBy": 0,
                    "CreatedAt": 1597283395000,
                    "UpdatedAt": 1597283395000
                },
                "CreatedAt": 1597283400000,
                "UpdatedAt": 1597283400000
            },
            {
                "IssueFieldId": 8,
                "NeedDefault": true,
                "ValueString": "{\"type\":\"VARIABLE\",\"value\":\"CREATOR\"}",
                "IssueType": "REQUIREMENT",
                "Required": false,
                "IssueField": {
                    "Id": 8,
                    "TeamId": 1,
                    "Name": "关注者",
                    "IconUrl": "",
                    "Type": "WATCHER",
                    "ComponentType": "SELECT_MEMBER_MULTI",
                    "Description": "",
                    "Options": [],
                    "Unit": "",
                    "Selectable": false,
                    "Required": false,
                    "Editable": false,
                    "Deletable": false,
                    "Sortable": true,
                    "CreatedBy": 0,
                    "CreatedAt": 1597283395000,
                    "UpdatedAt": 1597283395000
                },
                "CreatedAt": 1597283400000,
                "UpdatedAt": 1598513658000
            },
            {
                "IssueFieldId": 11,
                "NeedDefault": false,
                "ValueString": "",
                "IssueType": "REQUIREMENT",
                "Required": false,
                "IssueField": {
                    "Id": 11,
                    "TeamId": 1,
                    "Name": "多选菜单",
                    "IconUrl": "",
                    "Type": "CUSTOM",
                    "ComponentType": "SELECT_MULTI",
                    "Description": "我的属性描述",
                    "Options": [
                        {
                            "Icon": "",
                            "Sort": "0",
                            "Title": "选项1",
                            "Value": "1"
                        },
                        {
                            "Icon": "",
                            "Sort": "1",
                            "Title": "选项2",
                            "Value": "2"
                        }
                    ],
                    "Unit": "",
                    "Selectable": true,
                    "Required": false,
                    "Editable": true,
                    "Deletable": true,
                    "Sortable": true,
                    "CreatedBy": 1,
                    "CreatedAt": 1598254806000,
                    "UpdatedAt": 1598594036000
                },
                "CreatedAt": 1598254851000,
                "UpdatedAt": 1598428656000
            },
            {
                "IssueFieldId": 13,
                "NeedDefault": false,
                "ValueString": "",
                "IssueType": "REQUIREMENT",
                "Required": false,
                "IssueField": {
                    "Id": 13,
                    "TeamId": 1,
                    "Name": "单行文本",
                    "IconUrl": "",
                    "Type": "CUSTOM",
                    "ComponentType": "TEXT_SINGLE_LINE",
                    "Description": "",
                    "Options": [],
                    "Unit": "",
                    "Selectable": true,
                    "Required": false,
                    "Editable": true,
                    "Deletable": true,
                    "Sortable": true,
                    "CreatedBy": 1,
                    "CreatedAt": 1598513276000,
                    "UpdatedAt": 1598513276000
                },
                "CreatedAt": 1598513658000,
                "UpdatedAt": 1598513658000
            }
        ]
    }
}
上一篇查询事项详情
最近更新
感谢反馈有用
感谢反馈没用