List Display

Function

This API is used to display lists.

Calling Method

For details, see Calling APIs.

Authorization Information

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

URI

POST /v3/workitem/issue-list

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
page_no	No	String	Definition: Page index. Constraints: N/A Value range: N/A Default value: N/A
page_size	No	String	Definition: Page size. Constraints: N/A Value range: N/A Default value: N/A
project_id	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
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

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
result	result object	Definition Returned result. Range N/A
status	String	Definition: Work item status. Value range: N/A

**Table 4** result
Parameter	Type	Description
total_count	Integer	Definition: Work item status. Value range: N/A
issues	Array of issues objects	Definition: Work item. Value range: N/A

**Table 5** issues
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	story_point 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
is_parent	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	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: Archived or not. 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** story_point
Parameter	Type	Description
id	Integer	Description: Story point ID. Value range: N/A
name	String	Description: 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
first_name	String	Definition: User's first name. Value range: N/A
last_name	String	Definition: User's last name. 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
assigned_nick_name	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** 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: trivial

**Table 11** author
Parameter	Type	Description
first_name	String	Definition: User's first name. Value range: N/A
last_name	String	Definition: User's last name. 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
assigned_nick_name	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 12** 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 13** 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

POST https://{endpoint}/v3/workitem/issue-list?_=1753241438364

{
  "page_no" : "1",
  "page_size" : "15",
  "project_id" : "5192de5eb435430c8cd41c6ae6028848",
  "tracker_id" : "7,2,3"
}

Example Responses

Status code: 200

{
  "result" : {
    "total_count" : 64,
    "issues" : [ {
      "updated_on" : "1753686505000",
      "story_point" : {
        "id" : 3,
        "name" : "1"
      },
      "subject" : "12111",
      "project" : {
        "identifier" : "5192de5eb435430c8cd41c6ae6028848",
        "name" : "DevOps Full-Process Sample Project XXXX",
        "id" : 35138974
      },
      "is_parent" : true,
      "done_ratio" : 0,
      "tracker" : {
        "name" : "Story",
        "id" : 7
      },
      "id" : 9185630,
      "start_date" : "1753660800000",
      "assigned_to" : {
        "assigned_nick_name" : "Sam 1",
        "name" : "devcloud_devcloud_s00404480_01",
        "last_name" : "devcloud_devcloud_s00404480_01",
        "id" : 4091,
        "image_id" : "photo01.png",
        "first_name" : "devcloud_devcloud_s00404480_01"
      },
      "status_attribute" : { },
      "severity" : {
        "name" : "Minor",
        "id" : 12
      },
      "author" : {
        "name" : "devcloud_devcloud_s00404480_01",
        "last_name" : "devcloud_devcloud_s00404480_01",
        "id" : 4091,
        "image_id" : "photo01.png",
        "first_name" : "devcloud_devcloud_s00404480_01"
      },
      "module" : { },
      "due_date" : "1753747200000",
      "expected_work_hours" : 0,
      "priority" : {
        "name" : "Medium",
        "id" : 2
      },
      "actual_work_hours" : 1,
      "is_watcher" : false,
      "deleted" : false,
      "fixed_version" : { },
      "is_archived" : false,
      "created_on" : "1753410626000",
      "domain" : { },
      "developer" : { },
      "closeder" : { },
      "position" : "9185630.0000000000",
      "closed_flag" : 0,
      "assigned_cc_user" : [ ],
      "custom_value_new" : { },
      "status" : {
        "name" : "New",
        "id" : 1
      }
    }, {
      "updated_on" : "1753325447000",
      "subject" : "User management - Cannot set membership level",
      "project" : {
        "identifier" : "5192de5eb435430c8cd41c6ae6028848",
        "name" : "DevOps Full-Process Sample Project XXXX",
        "id" : 35138974
      },
      "is_parent" : false,
      "done_ratio" : 0,
      "find_release_dev" : "",
      "tracker" : {
        "name" : "Bug",
        "id" : 3
      },
      "id" : 9184263,
      "assigned_to" : {
        "assigned_nick_name" : "Sam 1",
        "name" : "devcloud_devcloud_s00404480_01",
        "last_name" : "devcloud_devcloud_s00404480_01",
        "id" : 4091,
        "image_id" : "photo01.png",
        "first_name" : "devcloud_devcloud_s00404480_01"
      },
      "status_attribute" : { },
      "severity" : {
        "name" : "Minor",
        "id" : 12
      },
      "author" : {
        "name" : "devcloud_devcloud_s00404480_01",
        "last_name" : "devcloud_devcloud_s00404480_01",
        "id" : 4091,
        "image_id" : "photo01.png",
        "first_name" : "devcloud_devcloud_s00404480_01"
      },
      "module" : { },
      "expected_work_hours" : 0,
      "priority" : {
        "name" : "Medium",
        "id" : 2
      },
      "actual_work_hours" : 0,
      "is_watcher" : false,
      "deleted" : false,
      "fixed_version" : { },
      "is_archived" : false,
      "created_on" : "1753084464000",
      "domain" : { },
      "developer" : { },
      "closeder" : { },
      "position" : "9179047.0000000000",
      "closed_flag" : 0,
      "assigned_cc_user" : [ ],
      "custom_value_new" : { },
      "status" : {
        "name" : "New",
        "id" : 1
      }
    } ]
  },
  "status" : "success"
}