Querying Work Items of a Sprint

Function

This API is used to query work items of a sprint.

Calling Method

For details, see Calling APIs.

Authorization Information

No identity policy-based permission required for calling this API.

URI

POST /v2/version/query-scrum-version

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. Obtain a token by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Constraints N/A Range The value contains 10 to 32,768 characters. Default Value N/A

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
projectUUId	No	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
fixed_version_id	No	String	Definition: Sprint ID. You can obtain the sprint list of a project using the Obtaining the Sprint List of a Specified Project API. Constraints: N/A Value range: Minimum value: 0. Default value: N/A
issueQuery	No	String	Definition: Number of work items in a sprint. Constraints: N/A Value range: N/A Default value: N/A
subject	No	String	Definition Work item title. Constraints 1 to 200,000 characters. Range N/A Default Value N/A
tracker_id	No	String	Definition: Work item type. Constraints: N/A Value range: 2 (task) 3 (bug) 5 (epic) 6 (feature) 7 (story) Default value: N/A
displayMode	No	String	Definition: Display mode. Constraints: N/A Value range: N/A Default value: N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
result	result object	Definition: Returned result of the sprint work item query.
status	String	Definition: Returned status of the sprint work item query. Value range: success: Command execution succeeds. error: Command execution failed.

**Table 4** result
Parameter	Type	Description
issues	Array of issues objects	Definition: Work item list.

**Table 5** issues
Parameter	Type	Description
data	Array of data objects	Definition: Work item data.
expectedHours	String	Definition: Estimated workloads (unit: person-hour). Value range: N/A
time	String	Definition: Working time in timestamp format, for example, 1839340800000. Value range: N/A
user	user object	Definition: User.

**Table 6** data
Parameter	Type	Description
2025-07-11	Array of IssueNew objects	Definition: Work item data on July 11.

**Table 7** IssueNew
Parameter	Type	Description
updated_on	String	Definition: Date when a work item is updated. The value is in timestamp format, for example, 1839340800000. Value range: N/A
story_point	StoryPoint object	Definition: Story point of a work item. Value range: N/A
subject	String	Definition: Owner of a work item. Value range: N/A
project	Project object	Definition: Project. Value range: N/A
isParent	Boolean	Definition: Whether there are child work items. Value range: true (with child work items) false (no child work items)
done_ratio	Integer	Definition: Work item completion rate. Value range: N/A
findReleaseDev	String	Definition: Releaser. Value range: N/A
tracker	Tracker object	Definition: Work item type. Value range: N/A
id	Integer	Definition: Work item list ID. Value range: N/A
start_date	String	Definition: Start date of a work item. The value is in timestamp format, for example, 1839340800000. Value range: N/A
assigned_to	assigned_to object	Definition: Work item owner. Value range: N/A
status_attribute	StatusAttributeVO object	Definition: Work item status. Value range: N/A
severity	Severity object	Definition: Severity. Value range: N/A
releaseDev	String	Definition: Release version of a work item. Value range: N/A
author	author object	Definition: Work item owner. Value range: N/A
module	Object	Definition: Module of a work item. Value range: N/A
due_date	String	Definition: End date of a work item, in timestamp format, for example, 1839340800000. Value range: N/A
expected_work_hours	Integer	Definition: Estimated workloads of a work item (unit: person-hour). Value range: N/A
priority	Priority object	Definition: Priority. Value range: N/A
actual_work_hours	Integer	Definition: Actual workloads of a work item (unit: person-hour). Value range: N/A
is_watcher	Boolean	Definition: Favorited or not. Value range: true: yes false: no
deleted	Boolean	Definition: Deleted or not. Value range: true: yes false: no
fixed_version	Object	Definition: Version where the issue is resolved. Value range: N/A
is_archived	Boolean	Definition: Whether the work item has been archived. Value range: true: yes false: no
created_on	String	Definition: Work item creation time, in timestamp format, for example, 1839340800000. Value range: N/A
domain	Object	Definition: Domain of a work item. Value range: N/A
developer	Object	Definition: Developer of a work item. Value range: N/A
closeder	Object	Definition: Closing personnel. Value range: N/A
position	String	Definition: Position of a work item in the list. Value range: N/A
closed_flag	Integer	Definition: Closing flag. Value range: 0: (not closed) 1: (closed)
assigned_cc_user	String	Definition: Cc recipient of a work item. Value range: N/A
custom_value_new	Object	Definition: Custom field. Value range: N/A
status	Status object	Definition: Work item status. Value range: N/A

**Table 8** StoryPoint
Parameter	Type	Description
id	Integer	Definition: Story point ID. Value range: N/A
name	String	Definition: Story point name. Value range: N/A

**Table 9** Project
Parameter	Type	Description
identifier	String	Definition: Project UUID. Value range: N/A
name	String	Definition: Project name. Value range: N/A
id	Integer	Definition: Digital ID of a project. Value range: N/A
type	String	Definition: Project type. Value range: Scrum

**Table 10** Tracker
Parameter	Type	Description
name	String	Definition Type name. Range Task Bug Epic Feature Story
id	Integer	Definition: Type ID. Value range: 2 (task) 3 (bug) 5 (epic) 6 (feature) 7 (story)

**Table 11** assigned_to
Parameter	Type	Description
firstName	String	Definition: Username. Value range: N/A
lastName	String	Definition: Username. Value range: N/A
identifier	String	Definition: 32–character UUID of a user. Value range: N/A
image_id	String	Definition: User avatar ID. Value range: N/A
assignedNickName	String	Definition: User alias. Value range: N/A
name	String	Definition: Username. Value range: N/A
id	Integer	Definition: Digital ID of a user. Value range: N/A

**Table 12** StatusAttributeVO
Parameter	Type	Description
id	String	Definition: Project ID. Value range: N/A
name	String	Definition: Name. Value range: N/A

**Table 13** Severity
Parameter	Type	Description
name	String	Definition Work item severity. Range Critical Major Minor Informational
id	Integer	Definition: Severity ID. Value range: 10: critical 11: major 12: minor 13: information

**Table 14** author
Parameter	Type	Description
firstName	String	Definition: Username. Value range: N/A
lastName	String	Definition: Username. Value range: N/A
identifier	String	Definition: Unique ID of the author. Value range: N/A
image_id	String	Definition: User avatar ID. Value range: N/A
authorNickName	String	Definition: User alias. Value range: N/A
name	String	Definition: Username with tenant information, in the format of Tenant name_Username. Value range: N/A
id	Integer	Definition: User ID. Value range: N/A

**Table 15** Priority
Parameter	Type	Description
name	String	Definition Work item priority. Range Low Medium High
id	Integer	Definition: Priority ID. Value range: 1: low 2: medium 3: high

**Table 16** Status
Parameter	Type	Description
name	String	Definition: Status name. Value range: New Developing Resolved Testing Closed Rejected
id	Integer	Definition: Status ID. Value range: 1: new 2: developing 3: resolved 4: testing 5: closed 6: rejected

**Table 17** user
Parameter	Type	Description
firstName	String	Definition: Username. Value range: N/A
lastName	String	Definition: Username. Value range: N/A
imageId	String	Definition: User avatar ID. Value range: N/A
assignedNickName	String	Definition: User alias. Value range: N/A
name	String	Definition: Username. Value range: N/A
id	Integer	Definition: Digital ID of a user. Value range: N/A

Example Requests

POST https://{endpoint}/v2/version/query-scrum-version

{
  "projectUUId" : "5192de5eb435430c8cd41c6ae6028848",
  "fixed_version_id" : "26664788",
  "issueQuery" : "7",
  "subject" : "",
  "tracker_id" : "7,2,3",
  "displayMode" : "member"
}

Example Responses

Status code: 200

{
  "result" : {
    "issues" : [ {
      "data" : [ {
        "2025-07-11" : [ {
          "subject" : "Database design and implementation of the bonus point function",
          "project" : {
            "identifier" : "381fcca9c056482d92da3e8b9da71db5",
            "name" : "DevOps Full-Process Sample Project XXXX"
          },
          "findReleaseDev" : "",
          "tracker" : {
            "name" : "Task",
            "id" : 2
          },
          "id" : 69782376,
          "releaseDev" : "",
          "assigned_to" : {
            "firstName" : "hw_008618814464665_01",
            "lastName" : "hw19145027",
            "assignedNickName" : "asdf4",
            "name" : "hw19145027",
            "id" : 233087
          },
          "status_attribute" : { },
          "severity" : {
            "name" : "Minor",
            "id" : 12
          },
          "author" : {
            "firstName" : "hw_008618814464665_01",
            "lastName" : "hw19145027",
            "name" : "hw19145027",
            "id" : 233087,
            "authorNickName" : "asdf4"
          },
          "module" : {
            "path" : "5939806",
            "name" : "Membership management",
            "id" : 5939806,
            "path_name" : "Membership management"
          },
          "due_date" : "1752249600000",
          "expected_work_hours" : 8,
          "priority" : {
            "name" : "Medium",
            "id" : 2
          },
          "actual_work_hours" : 0,
          "is_watcher" : false,
          "deleted" : false,
          "fixed_version" : {
            "name" : "Sprint 3",
            "id" : 21723087
          },
          "domain" : { },
          "developer" : { },
          "closeder" : { },
          "assigned_cc_user" : [ ],
          "status" : {
            "name" : "Closed",
            "id" : 5
          }
        }, {
          "subject" : "Design of bonus points earning rules",
          "project" : {
            "identifier" : "381fcca9c056482d92da3e8b9da71db5",
            "name" : "DevOps Full-Process Sample Project XXXX"
          },
          "findReleaseDev" : "",
          "tracker" : {
            "name" : "Task",
            "id" : 2
          },
          "id" : 69782377,
          "releaseDev" : "",
          "assigned_to" : {
            "firstName" : "hw_008618814464665_01",
            "lastName" : "hw19145027",
            "assignedNickName" : "asdf4",
            "name" : "hw19145027",
            "id" : 233087
          },
          "status_attribute" : { },
          "severity" : {
            "name" : "Minor",
            "id" : 12
          },
          "author" : {
            "firstName" : "hw_008618814464665_01",
            "lastName" : "hw19145027",
            "name" : "hw19145027",
            "id" : 233087,
            "authorNickName" : "asdf4"
          },
          "module" : {
            "path" : "5939806",
            "name" : "Membership management",
            "id" : 5939806,
            "path_name" : "Membership management"
          },
          "due_date" : "1752422400000",
          "expected_work_hours" : 16,
          "priority" : {
            "name" : "Medium",
            "id" : 2
          },
          "actual_work_hours" : 0,
          "is_watcher" : false,
          "deleted" : false,
          "fixed_version" : {
            "name" : "Sprint 3",
            "id" : 21723087
          },
          "domain" : { },
          "developer" : { },
          "closeder" : { },
          "assigned_cc_user" : [ ],
          "status" : {
            "name" : "Closed",
            "id" : 5
          }
        }, {
          "subject" : "Accessory database design",
          "project" : {
            "identifier" : "381fcca9c056482d92da3e8b9da71db5",
            "name" : "DevOps Full-Process Sample Project XXXX"
          },
          "findReleaseDev" : "",
          "tracker" : {
            "name" : "Task",
            "id" : 2
          },
          "id" : 69782399,
          "releaseDev" : "",
          "assigned_to" : {
            "firstName" : "hw_008618814464665_01",
            "lastName" : "hw19145027",
            "assignedNickName" : "asdf4",
            "name" : "hw19145027",
            "id" : 233087
          },
          "status_attribute" : { },
          "severity" : {
            "name" : "Minor",
            "id" : 12
          },
          "author" : {
            "firstName" : "hw_008618814464665_01",
            "lastName" : "hw19145027",
            "name" : "hw19145027",
            "id" : 233087,
            "authorNickName" : "asdf4"
          },
          "module" : { },
          "due_date" : "1752768000000",
          "expected_work_hours" : 8,
          "priority" : {
            "name" : "Medium",
            "id" : 2
          },
          "actual_work_hours" : 0,
          "is_watcher" : false,
          "deleted" : false,
          "fixed_version" : {
            "name" : "Sprint 3",
            "id" : 21723087
          },
          "domain" : { },
          "developer" : { },
          "closeder" : { },
          "assigned_cc_user" : [ ],
          "status" : {
            "name" : "Closed",
            "id" : 5
          }
        }, {
          "subject" : "Frontend development of the accessory management page",
          "project" : {
            "identifier" : "381fcca9c056482d92da3e8b9da71db5",
            "name" : "DevOps Full-Process Sample Project XXXX"
          },
          "findReleaseDev" : "",
          "tracker" : {
            "name" : "Task",
            "id" : 2
          },
          "id" : 69782400,
          "releaseDev" : "",
          "assigned_to" : {
            "firstName" : "hw_008618814464665_01",
            "lastName" : "hw19145027",
            "assignedNickName" : "asdf4",
            "name" : "hw19145027",
            "id" : 233087
          },
          "status_attribute" : { },
          "severity" : {
            "name" : "Minor",
            "id" : 12
          },
          "author" : {
            "firstName" : "hw_008618814464665_01",
            "lastName" : "hw19145027",
            "name" : "hw19145027",
            "id" : 233087,
            "authorNickName" : "asdf4"
          },
          "module" : { },
          "due_date" : "1752940800000",
          "expected_work_hours" : 12,
          "priority" : {
            "name" : "Medium",
            "id" : 2
          },
          "actual_work_hours" : 0,
          "is_watcher" : false,
          "deleted" : false,
          "fixed_version" : {
            "name" : "Sprint 3",
            "id" : 21723087
          },
          "domain" : { },
          "developer" : { },
          "closeder" : { },
          "assigned_cc_user" : [ ],
          "status" : {
            "name" : "Closed",
            "id" : 5
          }
        }, {
          "subject" : "Accessory report structure design",
          "project" : {
            "identifier" : "381fcca9c056482d92da3e8b9da71db5",
            "name" : "DevOps Full-Process Sample Project XXXX"
          },
          "findReleaseDev" : "",
          "tracker" : {
            "name" : "Task",
            "id" : 2
          },
          "id" : 69782401,
          "releaseDev" : "",
          "assigned_to" : {
            "firstName" : "hw_008618814464665_01",
            "lastName" : "hw19145027",
            "assignedNickName" : "asdf4",
            "name" : "hw19145027",
            "id" : 233087
          },
          "status_attribute" : { },
          "severity" : {
            "name" : "Minor",
            "id" : 12
          },
          "author" : {
            "firstName" : "hw_008618814464665_01",
            "lastName" : "hw19145027",
            "name" : "hw19145027",
            "id" : 233087,
            "authorNickName" : "asdf4"
          },
          "module" : { },
          "due_date" : "1753113600000",
          "expected_work_hours" : 26,
          "priority" : {
            "name" : "Medium",
            "id" : 2
          },
          "actual_work_hours" : 0,
          "is_watcher" : false,
          "deleted" : false,
          "fixed_version" : {
            "name" : "Sprint 3",
            "id" : 21723087
          },
          "domain" : { },
          "developer" : { },
          "closeder" : { },
          "assigned_cc_user" : [ ],
          "status" : {
            "name" : "Closed",
            "id" : 5
          }
        }, {
          "subject" : "Search for functions under development",
          "project" : {
            "identifier" : "381fcca9c056482d92da3e8b9da71db5",
            "name" : "DevOps Full-Process Sample Project XXXX"
          },
          "findReleaseDev" : "",
          "tracker" : {
            "name" : "Task",
            "id" : 2
          },
          "id" : 69782418,
          "releaseDev" : "",
          "assigned_to" : {
            "firstName" : "hw_008618814464665_01",
            "lastName" : "hw19145027",
            "assignedNickName" : "asdf4",
            "name" : "hw19145027",
            "id" : 233087
          },
          "status_attribute" : { },
          "severity" : {
            "name" : "Minor",
            "id" : 12
          },
          "author" : {
            "firstName" : "hw_008618814464665_01",
            "lastName" : "hw19145027",
            "name" : "hw19145027",
            "id" : 233087,
            "authorNickName" : "asdf4"
          },
          "module" : { },
          "due_date" : "1753459200000",
          "expected_work_hours" : 24,
          "priority" : {
            "name" : "Medium",
            "id" : 2
          },
          "actual_work_hours" : 0,
          "is_watcher" : false,
          "deleted" : false,
          "fixed_version" : {
            "name" : "Sprint 3",
            "id" : 21723087
          },
          "domain" : { },
          "developer" : { },
          "closeder" : { },
          "assigned_cc_user" : [ ],
          "status" : {
            "name" : "Resolved",
            "id" : 3
          }
        }, {
          "subject" : "Accessory report page development",
          "project" : {
            "identifier" : "381fcca9c056482d92da3e8b9da71db5",
            "name" : "DevOps Full-Process Sample Project XXXX"
          },
          "findReleaseDev" : "",
          "tracker" : {
            "name" : "Task",
            "id" : 2
          },
          "id" : 69782402,
          "releaseDev" : "",
          "assigned_to" : {
            "firstName" : "hw_008618814464665_01",
            "lastName" : "hw19145027",
            "assignedNickName" : "asdf4",
            "name" : "hw19145027",
            "id" : 233087
          },
          "status_attribute" : { },
          "severity" : {
            "name" : "Minor",
            "id" : 12
          },
          "author" : {
            "firstName" : "hw_008618814464665_01",
            "lastName" : "hw19145027",
            "name" : "hw19145027",
            "id" : 233087,
            "authorNickName" : "asdf4"
          },
          "module" : { },
          "due_date" : "1753286400000",
          "expected_work_hours" : 24,
          "priority" : {
            "name" : "Medium",
            "id" : 2
          },
          "actual_work_hours" : 0,
          "is_watcher" : false,
          "deleted" : false,
          "fixed_version" : {
            "name" : "Sprint 3",
            "id" : 21723087
          },
          "domain" : { },
          "developer" : { },
          "closeder" : { },
          "assigned_cc_user" : [ ],
          "status" : {
            "name" : "Closed",
            "id" : 5
          }
        }, {
          "subject" : "Bonus points - Rule page cannot be displayed",
          "project" : {
            "identifier" : "381fcca9c056482d92da3e8b9da71db5",
            "name" : "DevOps Full-Process Sample Project XXXX"
          },
          "findReleaseDev" : "",
          "tracker" : {
            "name" : "Bug",
            "id" : 3
          },
          "id" : 69782387,
          "releaseDev" : "",
          "assigned_to" : {
            "firstName" : "hw_008618814464665_01",
            "lastName" : "hw19145027",
            "assignedNickName" : "asdf4",
            "name" : "hw19145027",
            "id" : 233087
          },
          "status_attribute" : { },
          "severity" : {
            "name" : "Minor",
            "id" : 12
          },
          "author" : {
            "firstName" : "hw_008618814464665_01",
            "lastName" : "hw19145027",
            "name" : "hw19145027",
            "id" : 233087,
            "authorNickName" : "asdf4"
          },
          "module" : { },
          "due_date" : "1752595200000",
          "expected_work_hours" : 8,
          "priority" : {
            "name" : "Medium",
            "id" : 2
          },
          "actual_work_hours" : 0,
          "is_watcher" : false,
          "deleted" : false,
          "fixed_version" : {
            "name" : "Sprint 3",
            "id" : 21723087
          },
          "domain" : { },
          "developer" : { },
          "closeder" : { },
          "assigned_cc_user" : [ ],
          "status" : {
            "name" : "Closed",
            "id" : 5
          }
        } ]
      } ],
      "expectedHours" : "126.0",
      "time" : "1755482637394",
      "user" : {
        "firstName" : "hw_008618814464665_01",
        "lastName" : "hw19145027",
        "imageId" : "photo01.png",
        "assignedNickName" : "asdf4",
        "name" : "hw19145027",
        "id" : 233087
      }
    } ]
  },
  "status" : "success"
}