Help Center/ CodeArts Req/ API Reference/ APIs/ Scrum Project Statuses/ Querying the Project Status List

Updated on 2023-06-12 GMT+08:00

View PDF

Querying the Project Status List

Function

Queries the project status list.

URI

GET /v4/projects/{project_id}/statuses

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	32-bit ID of a DevCloud project

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Queries the offset. Default: 0
limit	No	Integer	Number of data records returned at a time. The value ranges from 1 to 100. Minimum: 1 Maximum: 100 Default: 10
tracker_id	No	Integer	Work item types supported by custom fields: 2 indicates a task, 3 indicates a bug,5 indicates an epic, 6 indicates a feature, and 7 indicates a story.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. Call IAM to obtain the user token (value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	Total number of statuses
issue_statuses	Array of IssueStatus objects	Status list

**Table 5** IssueStatus
Parameter	Type	Description
id	String	Status UUID
status_id	Integer	Status ID
name	String	Status name
tracker_ids	Array of integers	List of associated work items
status_attribute	StatusAttribute object	Status attribute type. The value can be started, ongoing, and closed.

**Table 6** StatusAttribute
Parameter	Type	Description
id	Integer	Status attribute ID
name	String	Status attribute name

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_msg	String	Description
error_code	String	Error Codes

Status code: 401

**Table 8** Response body parameters
Parameter	Type	Description
error_msg	String	Description
error_code	String	Error Codes

Example Requests

Get https://{endpoint}/v4/projects/0792b7d26cb74bd799cbae80063dc74a/statuses

Example Responses

Status code: 200

{
  "total" : 1,
  "issue_statuses" : [ {
    "id" : "123cefde62004de2b62b5e8dd2c2b3af",
    "status_id" : 1,
    "name" : "",
    "tracker_ids" : [ 0 ],
    "status_attribute" : {
      "id" : 1,
      "name" : "string"
    }
  } ]
}