Help Center/ CodeArts Req/ API Reference/ API/ Scrum Project Statuses/ Querying All Statuses of a Transaction

Updated on 2025-09-10 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying All Statuses of a Transaction

Function

This API is used to query the all statuses of a transaction.

Calling Method

For details, see Calling APIs.

URI

GET /v2/issue-status/all

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: 32-character UUID of a project, which uniquely identifies a project. Obtain the value of this parameter from the project_id field in the response body of the Querying the Project List API. Constraints: The value must contain 32 characters. Digits and letters are allowed. Value range: N/A Default value: N/A
tracker_id	Yes	Integer	Definition: Work item type ID. Constraints: N/A Value range: 2 (task) 3 (bug) 5 (epic) 6 (feature) 7 (story) Default value: N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition: User token. Obtain a token by calling the IAM API forobtaining a user token. The value of X-Subject-Token in the response header is the user token. Constraints: Mandatory. Value range: Minimum length: 10 characters. Maximum length: 32,768 characters. Default value: N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
result	result object	Work item status information.
status	String	Definition: Returned status. Constraints: success: Command execution succeeds. error: Command execution failed.

**Table 4** result
Parameter	Type	Description
2	Array of IssueStatusV2 objects	Task status list.
3	Array of IssueStatusV2 objects	Bug status list.
5	Array of IssueStatusV2 objects	Epic status list.
6	Array of IssueStatusV2 objects	Feature status list.
7	Array of IssueStatusV2 objects	Story status list.
issue_statuses	Array of IssueStatusV2 objects	List of all statuses.

**Table 5** IssueStatusV2
Parameter	Type	Description
id	Integer	Definition: Primary key ID. Value range: N/A
status_id	String	Definition: Work item status ID. Value range: N/A
name	String	Definition: Work item status name. Value range: N/A
is_closed	Integer	Definition: Whether a work item status is the done status. Value range: 1 (done status) 0 (not done status)
position	Integer	Definition: Position of a work item status in the status list. Value range: N/A
default_done_ratio	Integer	Definition: Default completion rate. Value range: N/A
is_initial	Integer	Definition: Whether a work item is initialized. Value range: 1 (initiated) 0 (not initialized)
issue_field_configs	Array of IssueFieldConfig objects	Work item fields.
flag	Integer	Definition: Whether a work item status is deleted. Value range: 1 (deleted) 0 (not deleted)
status_attribute	Integer	Definition: Status attribute ID. Value range: N/A
issue_status_attribute	IssueStatusAttribute object	Work item status.

**Table 6** IssueFieldConfig
Parameter	Type	Description
custom	Boolean	Definition: Whether the status is custom. Value range: true (custom) false (not custom)
default_option	Array of OptionVOV2 objects	Definition: Use the default.
default_options	Array of OptionVOV2 objects	Definition: Use the default.
default_value	String	Definition: Default value of a field. Value range: N/A
field	String	Definition: Field. Value range: N/A
field_type	String	Description: Field value type. Value range: textArea: multi-line text, containing letters, digits, underscore (), and hyphen (-). The length cannot exceed 500 characters. text: single-line text, containing letters, digits, underscore (), and hyphen (-). The length cannot exceed 500 characters. select: drop-down list, containing letters, digits, underscore (), and hyphen (-). An option contains a maximum of 40 characters. A maximum of 60 options can be customized. number: number whose value range is set by users during custom field creation. date: date which is accurate to year, month, and day. time_date: date which is accurate to hour, minute, and second. The value is a timestamp of the long integer type.) checkbox: check box, containing letters, digits, underscore (), and hyphen (-). An option contains a maximum of 40 characters and a maximum of 60 options can be customized. radio: radio box, containing letters, digits, underscore (_), and hyphen (-). An option contains a maximum of 40 characters. A maximum of 60 options can be customized.
is_required	Integer	Definition: Whether the status is mandatory. Value range: 0 (not mandatory) 1 (mandatory)
is_visible	Boolean	Definition: Whether the status is visible. Value range: true (visible) false (invisible)
last	Boolean	Definition: Whether the status is at the end. Value range: true (at the end) false (not at the end)
name	String	Definition: Field name. Options: N/A
option	Array of OptionVOV2 objects	Definition: Field options.
options	String	Definition: Field configuration. Value range: N/A
position	Integer	Definition: Position ID of the status on the page. Value range: N/A
project_id	String	Definition: 32-character ID of a project, which uniquely identifies a project. Obtain the value of this parameter from the project_id field in the response body of the Querying the Project List API. Value range: N/A
tracker_list	Array of integers	Definition: Work item type list.
type_options	String	Description: Field value type. Value range: select (multiple values available for selection) fixed_value (fixed value)

**Table 7** OptionVOV2
Parameter	Type	Description
id	String	Definition: Option ID. Options: N/A
name	String	Definition: Option name. Options: N/A

**Table 8** IssueStatusAttribute
Parameter	Type	Description
project_id	String	Definition: 32-character UUID of a project, which uniquely identifies a project. Obtain the value of this parameter from the project_id field in the response body of the Querying the Project List API. Value range: N/A
name	String	Definition: Status name. Value range: N/A
type	String	Definition: State type. Value range: To Do Doing Done

Example Requests

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

Example Responses

Status code: 200

Response to the success of the interface for querying all statuses of a transaction.

{
  "result" : {
    "2" : [ {
      "id" : 1,
      "status_id" : "58435fff2a3c451aaf91cda38fdc80c1",
      "name" : "New",
      "is_closed" : 0,
      "is_initial" : 1,
      "issue_field_configs" : [ {
        "custom" : false,
        "field" : "assigned_to_id",
        "name" : "Handler",
        "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" : "Comment",
        "field_type" : "text",
        "type_options" : "fixed_value",
        "default_value" : "",
        "is_visible" : true,
        "position" : 2,
        "is_required" : 0,
        "last" : false
      } ],
      "issue_status_attribute" : {
        "name" : "To Do",
        "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" : "Handler",
        "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" : "Comment",
        "field_type" : "text",
        "type_options" : "fixed_value",
        "default_value" : "",
        "is_visible" : true,
        "position" : 2,
        "is_required" : 0,
        "last" : false
      } ],
      "issue_status_attribute" : {
        "name" : "To Do",
        "type" : "START_STATUS"
      }
    } ],
    "3" : [ {
      "id" : 1,
      "status_id" : "58435fff2a3c451aaf91cda38fdc80c1",
      "name" : "New",
      "is_closed" : 0,
      "is_initial" : 1,
      "issue_field_configs" : [ {
        "custom" : false,
        "field" : "assigned_to_id",
        "name" : "Handler",
        "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" : "Comment",
        "field_type" : "text",
        "type_options" : "fixed_value",
        "default_value" : "",
        "is_visible" : true,
        "position" : 2,
        "is_required" : 0,
        "last" : false
      } ],
      "issue_status_attribute" : {
        "name" : "To Do",
        "type" : "START_STATUS"
      }
    } ],
    "issue_statuses" : [ {
      "id" : 1,
      "status_id" : "58435fff2a3c451aaf91cda38fdc80c1",
      "name" : "New",
      "is_closed" : 0,
      "position" : 1,
      "is_initial" : 1,
      "flag" : 1,
      "issue_status_attribute" : {
        "name" : "To Do",
        "type" : "START_STATUS"
      }
    }, {
      "id" : 7,
      "status_id" : "34193c2555eb404f92d088c084257825",
      "name" : "aaa",
      "is_closed" : 0,
      "position" : 2,
      "is_initial" : 1,
      "flag" : 1,
      "issue_status_attribute" : {
        "name" : "To Do",
        "type" : "START_STATUS"
      }
    }, {
      "id" : 2,
      "status_id" : "6de47eb5f35f442680a9f26994784246",
      "name" : "Doing",
      "is_closed" : 0,
      "position" : 3,
      "is_initial" : 0,
      "flag" : 1,
      "issue_status_attribute" : {
        "name" : "Doing",
        "type" : "PROCESS_STATUS"
      }
    }, {
      "id" : 3,
      "status_id" : "71e2810154c743b69c804414a5d525bd",
      "name" : "Resolved",
      "is_closed" : 0,
      "position" : 4,
      "is_initial" : 0,
      "flag" : 1,
      "issue_status_attribute" : {
        "name" : "Doing",
        "type" : "PROCESS_STATUS"
      }
    }, {
      "id" : 4,
      "status_id" : "8d540bcba87d451f9d9d80f8b1f7e7ad",
      "name" : "Testing",
      "is_closed" : 0,
      "position" : 5,
      "is_initial" : 0,
      "flag" : 1,
      "issue_status_attribute" : {
        "name" : "Doing",
        "type" : "PROCESS_STATUS"
      }
    }, {
      "id" : 6,
      "status_id" : "176d8af2ea7f4486937ea703c11bf57d",
      "name" : "Rejected",
      "is_closed" : 1,
      "position" : 6,
      "is_initial" : 0,
      "flag" : 1,
      "issue_status_attribute" : {
        "name" : "Done",
        "type" : "DONE_STATUS"
      }
    }, {
      "id" : 5,
      "status_id" : "6759ae8357534ce28edaec4d242d4058",
      "name" : "Closed",
      "is_closed" : 1,
      "position" : 7,
      "is_initial" : 0,
      "flag" : 1,
      "issue_status_attribute" : {
        "name" : "Done",
        "type" : "DONE_STATUS"
      }
    } ]
  },
  "status" : "success"
}