查询事务的所有状态

功能介绍

查询事务的所有状态。

调用方法

请参见如何调用API。

URI

GET /v2/issue-status/all

表1 Query参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：项目的32位uuid，项目唯一标识，通过查询项目列表接口获取，响应消息体中的project_id字段的值就是项目ID。约束限制： 32位的数字和字母组成的字符串。取值范围：不涉及。默认取值：不涉及。
tracker_id	是	Integer	参数解释：工作项类型id。约束限制：不涉及。取值范围： 2（任务/Task） 3（缺陷/Bug） 5（Epic） 6（Feature） 7（Story）默认取值：不涉及。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。约束限制：必传。取值范围：最小长度：10，最大长度：32768。默认取值：不涉及。

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
result	result object	工作项状态信息
status	String	参数解释：返回状态。约束限制： success：返回成功。 error：返回失败。

表4 result
参数	参数类型	描述
2	Array of IssueStatusV2 objects	任务对应的状态列表
3	Array of IssueStatusV2 objects	缺陷对应的状态列表
5	Array of IssueStatusV2 objects	Epic对应的状态列表
6	Array of IssueStatusV2 objects	Feature对应的状态列表
7	Array of IssueStatusV2 objects	Story对应的状态列表
issue_statuses	Array of IssueStatusV2 objects	所有的状态列表

表5 IssueStatusV2
参数	参数类型	描述
id	Integer	参数解释：主键id。取值范围：不涉及。
status_id	String	参数解释：工作项状态id。取值范围：不涉及。
name	String	参数解释：工作项状态名称。取值范围：不涉及。
is_closed	Integer	参数解释：工作项状态是否结束态。取值范围： 1（是结束态） 0（不是结束态）
position	Integer	参数解释：工作项状态列表位置。取值范围：不涉及。
default_done_ratio	Integer	参数解释：默认完成率。取值范围：不涉及。
is_initial	Integer	参数解释：工作项状态是否为初始化。取值范围： 1（是初始化） 0（不是初始化）
issue_field_configs	Array of IssueFieldConfig objects	工作项字段配置
flag	Integer	参数解释：工作项状态是否删除标识。取值范围： 1（已删除） 0（未删除）
status_attribute	Integer	参数解释：状态属性id 。取值范围：不涉及。
issue_status_attribute	IssueStatusAttribute object	工作项状态属性

表6 IssueFieldConfig
参数	参数类型	描述
custom	Boolean	参数解释：是否自定义状态。取值范围： true（是自定义状态） false（不是自定义状态）
default_option	Array of OptionVOV2 objects	参数解释：默认配置。
default_options	Array of OptionVOV2 objects	参数解释：默认配置。
default_value	String	参数解释：字段的默认值。取值范围：不涉及。
field	String	参数解释：字段。取值范围：不涉及。
field_type	String	参数解释：字段值设置类型。取值范围： textArea（多行文本，只能包含汉字、英文大小写字母、数字、下划线和连接符，不能超过500字符） text（单行文本，只能包含汉字、英文大小写字母、数字、下划线和连接符，不能超过500字符） select（下拉框，只能包含汉字、英文大小写字母、数字、下划线和连接符，每个选项最大长度40个字符，最多可定义60个选项） number（数字，取值范围由用户创建自定义字段时设置） date（日期，精确到年月日） time_date，时间戳格式（示例：1839340800000）（日期精确到时分秒，长整型时间戳） checkbox（多选框，只能包含汉字、英文大小写字母、数字、下划线和连接符，每个选项最大长度40个字符，最多可定义60个选项） radio（单选框，只能包含汉字、英文大小写字母、数字、下划线和连接符，每个选项最大长度40个字符，最多可定义60个选项）
is_required	Integer	参数解释：状态是否必选状态。取值范围： 0（不是必选状态） 1（是必选状态）
is_visible	Boolean	参数解释：状态是否可见。取值范围： true（可见） false（不可见）
last	Boolean	参数解释：状态是否处于最后位置。取值范围： true（最后） false（不是最后）
name	String	参数解释：字段名称。取值范围：不涉及。
option	Array of OptionVOV2 objects	参数解释：配置。
options	String	参数解释：字段配置。取值范围：不涉及。
position	Integer	参数解释：状态在页面的位置id 取值范围：不涉及。
project_id	String	参数解释：项目32位id，项目唯一标识，通过查询项目列表接口获取，响应消息体中的project_id字段的值就是项目ID。取值范围：不涉及。
tracker_list	Array of integers	参数解释：工作项类型列表。
type_options	String	参数解释：字段值设置类型。取值范围： select（可选值） fixed_value（固定值）

表7 OptionVOV2
参数	参数类型	描述
id	String	参数解释：选项Id。取值范围：不涉及。
name	String	参数解释：选项名称。取值范围：不涉及。

表8 IssueStatusAttribute
参数	参数类型	描述
project_id	String	参数解释：项目32位UUID，项目唯一标识，通过查询项目列表接口获取，响应消息体中的project_id字段的值就是项目ID。取值范围：不涉及。
name	String	参数解释：状态名称。取值范围：不涉及。
type	String	参数解释：状态类型。取值范围：开始态进行态结束态

请求示例

{endpoint}/v2/issue-status/all?project_id=21f161ddf28942ac90c7762be8a455ee&tracker_id=7

响应示例

状态码：200

查询事务的所有状态接口成功的响应。

{
  "result" : {
    "2" : [ {
      "id" : 1,
      "status_id" : "58435fff2a3c451aaf91cda38fdc80c1",
      "name" : "新建",
      "is_closed" : 0,
      "is_initial" : 1,
      "issue_field_configs" : [ {
        "custom" : false,
        "field" : "assigned_to_id",
        "name" : "处理人",
        "field_type" : "fixed_value",
        "type_options" : "select,fixed_value",
        "default_value" : "",
        "is_visible" : true,
        "position" : 1,
        "is_required" : 2,
        "last" : true,
        "options" : ""
      }, {
        "custom" : false,
        "field" : "notes",
        "name" : "评论",
        "field_type" : "text",
        "type_options" : "fixed_value",
        "default_value" : "",
        "is_visible" : true,
        "position" : 2,
        "is_required" : 0,
        "last" : false
      } ],
      "issue_status_attribute" : {
        "name" : "开始态",
        "type" : "START_STATUS"
      }
    }, {
      "id" : 7,
      "status_id" : "34193c2555eb404f92d088c084257825",
      "name" : "aaa",
      "is_closed" : 0,
      "is_initial" : 1,
      "issue_field_configs" : [ {
        "custom" : false,
        "field" : "assigned_to_id",
        "name" : "处理人",
        "field_type" : "fixed_value",
        "type_options" : "select,fixed_value",
        "default_value" : "",
        "is_visible" : true,
        "position" : 1,
        "is_required" : 2,
        "last" : true,
        "options" : ""
      }, {
        "custom" : false,
        "field" : "notes",
        "name" : "评论",
        "field_type" : "text",
        "type_options" : "fixed_value",
        "default_value" : "",
        "is_visible" : true,
        "position" : 2,
        "is_required" : 0,
        "last" : false
      } ],
      "issue_status_attribute" : {
        "name" : "开始态",
        "type" : "START_STATUS"
      }
    } ],
    "3" : [ {
      "id" : 1,
      "status_id" : "58435fff2a3c451aaf91cda38fdc80c1",
      "name" : "新建",
      "is_closed" : 0,
      "is_initial" : 1,
      "issue_field_configs" : [ {
        "custom" : false,
        "field" : "assigned_to_id",
        "name" : "处理人",
        "field_type" : "fixed_value",
        "type_options" : "select,fixed_value",
        "default_value" : "",
        "is_visible" : true,
        "position" : 1,
        "is_required" : 2,
        "last" : true,
        "options" : ""
      }, {
        "custom" : false,
        "field" : "notes",
        "name" : "评论",
        "field_type" : "text",
        "type_options" : "fixed_value",
        "default_value" : "",
        "is_visible" : true,
        "position" : 2,
        "is_required" : 0,
        "last" : false
      } ],
      "issue_status_attribute" : {
        "name" : "开始态",
        "type" : "START_STATUS"
      }
    } ],
    "issue_statuses" : [ {
      "id" : 1,
      "status_id" : "58435fff2a3c451aaf91cda38fdc80c1",
      "name" : "新建",
      "is_closed" : 0,
      "position" : 1,
      "is_initial" : 1,
      "flag" : 1,
      "issue_status_attribute" : {
        "name" : "开始态",
        "type" : "START_STATUS"
      }
    }, {
      "id" : 7,
      "status_id" : "34193c2555eb404f92d088c084257825",
      "name" : "aaa",
      "is_closed" : 0,
      "position" : 2,
      "is_initial" : 1,
      "flag" : 1,
      "issue_status_attribute" : {
        "name" : "开始态",
        "type" : "START_STATUS"
      }
    }, {
      "id" : 2,
      "status_id" : "6de47eb5f35f442680a9f26994784246",
      "name" : "进行中",
      "is_closed" : 0,
      "position" : 3,
      "is_initial" : 0,
      "flag" : 1,
      "issue_status_attribute" : {
        "name" : "进行态",
        "type" : "PROCESS_STATUS"
      }
    }, {
      "id" : 3,
      "status_id" : "71e2810154c743b69c804414a5d525bd",
      "name" : "已解决",
      "is_closed" : 0,
      "position" : 4,
      "is_initial" : 0,
      "flag" : 1,
      "issue_status_attribute" : {
        "name" : "进行态",
        "type" : "PROCESS_STATUS"
      }
    }, {
      "id" : 4,
      "status_id" : "8d540bcba87d451f9d9d80f8b1f7e7ad",
      "name" : "测试中",
      "is_closed" : 0,
      "position" : 5,
      "is_initial" : 0,
      "flag" : 1,
      "issue_status_attribute" : {
        "name" : "进行态",
        "type" : "PROCESS_STATUS"
      }
    }, {
      "id" : 6,
      "status_id" : "176d8af2ea7f4486937ea703c11bf57d",
      "name" : "已拒绝",
      "is_closed" : 1,
      "position" : 6,
      "is_initial" : 0,
      "flag" : 1,
      "issue_status_attribute" : {
        "name" : "结束态",
        "type" : "DONE_STATUS"
      }
    }, {
      "id" : 5,
      "status_id" : "6759ae8357534ce28edaec4d242d4058",
      "name" : "已关闭",
      "is_closed" : 1,
      "position" : 7,
      "is_initial" : 0,
      "flag" : 1,
      "issue_status_attribute" : {
        "name" : "结束态",
        "type" : "DONE_STATUS"
      }
    } ]
  },
  "status" : "success"
}

状态码

状态码	描述
200	查询事务的所有状态接口成功的响应。

错误码

请参见错误码。

父主题： Scrum项目的状态

上一篇：查询项目的状态列表

下一篇：Scrum项目的规划

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消