Querying a Plan

Function

This API is used to query a plan.

Calling Method

For details, see Calling APIs.

Authorization Information

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

URI

GET /v2/workitem/plan

**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
page_size	No	Integer	Definition: Page size. Constraints: N/A Value range: Minimum value: 0. Maximum value: 9,999,999,999. Default value: N/A
page_no	No	Integer	Definition: Page index. Constraints: N/A Value range: Minimum value: 0. Maximum value: 9,999,999,999. Default value: N/A
status_id	No	String	Definition: Work item status ID. Constraints: N/A Value range: 1: new 2: developing 3: resolved 4: testing 5: closed 6: rejected Default value: N/A
plan_id	No	String	Definition: Plan ID, which can be obtained by calling the Querying All Plans Visible to the Current User in Pagination Mode API. The value of id in the response message body is the plan ID. Constraints: The value must contain 32 characters. Digits and letters are allowed. Value range: N/A 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 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

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
result	result object	Definition: Returned result of querying the plan. Value range: N/A
status	String	Definition: Returned status of querying the plan. Value range: success: Command execution succeeds. error: Command execution failed.

**Table 4** result
Parameter	Type	Description
total	Integer	Definition: Total number of work items. Value range: N/A
total_count	Integer	Definition: Number of work items. Value range: N/A
issues	Array of IssueNew objects	Definition: Work item information. Value range: N/A

**Table 5** 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 6** 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 7** 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 8** 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 9** 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 10** StatusAttributeVO
Parameter	Type	Description
id	String	Definition: Project ID. Value range: N/A
name	String	Definition: Name. Value range: N/A

**Table 11** 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 12** 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 13** 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 14** 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

Example Requests

{endpoint}/v2/workitem/plan

Example Responses

Status code: 200

{
  "result" : {
    "total" : 1,
    "total_count" : 1,
    "issues" : [ {
      "subject" : "Test",
      "project" : { },
      "findReleaseDev" : "",
      "tracker" : {
        "name" : "Epic",
        "id" : 5
      },
      "id" : 69824084,
      "releaseDev" : "",
      "start_date" : "2025-07-28",
      "assigned_to" : {
        "firstName" : "hw_008618814464665_01",
        "assignedNickName" : "asdf4",
        "name" : "hw19145027",
        "id" : 233087
      },
      "status_attribute" : {
        "name" : "To Do",
        "id" : 31845847
      },
      "severity" : { },
      "author" : {
        "firstName" : "hw_008618814464665_01",
        "name" : "hw19145027",
        "id" : 233087,
        "authorNickName" : "asdf4"
      },
      "module" : { },
      "due_date" : "2025-07-29",
      "priority" : {
        "name" : "Medium",
        "id" : 2
      },
      "deleted" : false,
      "fixed_version" : { },
      "is_archived" : false,
      "domain" : { },
      "developer" : { },
      "closeder" : { },
      "position" : "69824084.0000000000",
      "closed_flag" : 0,
      "assigned_cc_user" : [ ],
      "status" : {
        "name" : "New",
        "id" : 1
      }
    } ]
  },
  "status" : "success"
}

Status Codes

Status Code	Description
200	Response to a successful request for querying plans.

Error Codes

See Error Codes.

Parent topic: Scrum Project Plans

Previous topic: Scrum Project Plans

Next topic: Establishing an Association Between a Work Item and a Gantt Chart