Updated on 2025-05-22 GMT+08:00

Querying Work Item Details

Function

Querying Work Item Details

URI

GET /v4/projects/{project_id}/issues/{issue_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the 32-bit ID of the devcloud project.

Minimum: 32

Maximum: 32

issue_id

Yes

Integer

Identifies a work item.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Minimum: 10

Maximum: 32768

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

actual_work_hours

Double

Indicates the actual person-hours.

assigned_cc_user

Array of IssueUser objects

Copy To

assigned_user

IssueUser object

User Information.

begin_time

String

Estimated start time, in the format of year-month-day.

created_time

String

Creation time Year-Month-Day Hour:Minute:Second

creator

IssueUser object

Creator Information.

custom_fields

Array of CustomField objects

Customized attribute value, which is not recommended. You are advised to refer to the new_custom_fields field.

new_custom_fields

Array of IssueDetailCustomField objects

Attribute Value

developer

IssueUser object

Developer Information.

domain

domain object

ID, domain 14, 'Performance', 15, 'Function', 16, 'Reliability' 17,'Network security' 18, 'Maintainability' 19,'Other DFX' 20, 'Availability'

done_ratio

Integer

Work Item Progress Value

end_time

String

Estimated end time, in the format of year-month-day.

expected_work_hours

Double

Expected

id

Integer

Work Item ID

project

IssueProjectResponseV4 object

Project Information

iteration

iteration object

Iteration

story_point

story_point object

Story Point

module

module object

Module

name

String

Title

parent_issue

parent_issue object

Parent Work Item

priority

priority object

Work Item Priority

severity

severity object

Work Item Importance

status

status object

Work Item Statuses

release_dev

String

Release

find_release_dev

String

Release

env

env object

Environment

tracker

tracker object

Work item type. The options are as follows: 2: task; 3: defect /Bug,5Epic,6Feature,7Story.

updated_time

String

Update time (year-month-day hour:minute:second)

closed_time

String

Close Time Year-Month-Day Hour:Minute:Second

description

String

Description

order

IssueOrder object

Order Information

accessories

Array of IssueAccessory objects

Nearby List

Table 4 IssueUser

Parameter

Type

Description

user_id

String

User UUID

user_num_id

Integer

Digital ID of a user

id

Integer

Specifies the user ID.

name

String

User Name

nick_name

String

Nickname

Table 5 CustomField

Parameter

Type

Description

name

String

Custom Attribute

value

String

Value of a customized attribute.

new_name

String

Custom Attribute

Table 6 IssueDetailCustomField

Parameter

Type

Description

custom_field

String

Custom Parameter

field_name

String

Indicates the customized field name.

value

String

Value of a customized attribute. Use commas (,) to separate multiple values.

field_type

String

Customized field type. The options are textArea (multi-line text), text (single-line text), select drop-down list box, number, time_date, checkbox, and radio.

description

String

Customized Field Description

Table 7 domain

Parameter

Type

Description

id

Integer

Identifies a domain.

name

String

fields

Table 8 IssueProjectResponseV4

Parameter

Type

Description

project_id

String

Project ID

project_name

String

Project

project_num_id

Integer

Project ID

Table 9 iteration

Parameter

Type

Description

id

Integer

Identifies a sprint.

name

String

Iteration Name

Table 10 story_point

Parameter

Type

Description

id

Integer

Story point ID.

name

String

Story Point Name

Table 11 module

Parameter

Type

Description

id

Integer

Specifies the module ID.

name

String

Module

Table 12 parent_issue

Parameter

Type

Description

id

Integer

Parent Work Item ID

name

String

Parent Work Item

Table 13 priority

Parameter

Type

Description

id

Integer

Identifies a priority.

name

String

Priority

Table 14 severity

Parameter

Type

Description

id

Integer

Identifies a severity.

name

String

Indicates the level of severity.

Table 15 status

Parameter

Type

Description

id

Integer

Identifies a status.

name

String

Status Name

Table 16 env

Parameter

Type

Description

id

Integer

Environment Id

name

String

Environment Name

Table 17 tracker

Parameter

Type

Description

id

Integer

Type ID

name

String

Object

Table 18 IssueOrder

Parameter

Type

Description

id

Integer

Sequence ID

name

String

Sequence Value

Table 19 IssueAccessory

Parameter

Type

Description

attachment_id

Integer

Specifies the attachment ID.

issue_id

Integer

Work Shoes ID

creator_num_id

Integer

Creator ID.

created_date

String

Attachment Creation Time

file_name

String

File Name During Upload

container_type

String

Specifies the attachment ID.

disk_file_name

String

Attachment name.

digest

String

Specifies the attachment ID.

disk_directory

String

Attachment Path

creator_id

String

UUID of the created user.

Status code: 400

Table 20 Response body parameters

Parameter

Type

Description

error_msg

String

Description

error_code

String

Error Codes

Status code: 401

Table 21 Response body parameters

Parameter

Type

Description

error_msg

String

Description

error_code

String

Error Codes

Example Requests

GET https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/issues/4568921

GET https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/issues/4568921

Example Responses

Status code: 200

OK

{
  "actual_work_hours" : 0,
  "assigned_cc_user" : [ {
    "id" : 4091,
    "name" : "demo_user_name",
    "nick_name" : "bear1"
  } ],
  "assigned_user" : {
    "id" : 4091,
    "name" : "demo_user_name",
    "nick_name" : "bear1"
  },
  "begin_time" : "2020-09-12",
  "created_time" : "2020-09-13 14:40:11",
  "creator" : {
    "id" : 4091,
    "name" : "demo_user_name",
    "nick_name" : "bear1"
  },
  "custom_fields" : [ {
    "name" : "customField16",
    "value" : "value",
    "new_name" : "custom_field16"
  } ],
  "new_custom_fields" : [ {
    "custom_field" : "custom_field16",
    "field_name" : "bear1",
    "value" : "bear11,bear12",
    "field_type" : "textArea",
    "description" : "description"
  } ],
  "developer" : {
    "id" : 4091,
    "name" : "demo_user_name",
    "nick_name" : "bear1"
  },
  "domain" : {
    "id" : 14,
    "name" : "Performance"
  },
  "done_ratio" : 0,
  "end_time" : "2020-09-19",
  "expected_work_hours" : 9,
  "id" : 4567,
  "project" : {
    "project_id" : "526cefde62004de2b62b5e8dd2c2b3af",
    "project_name" : "testDemo",
    "project_num_id" : 78953
  },
  "iteration" : {
    "id" : 456,
    "name" : "iteeration1"
  },
  "story_point" : {
    "id" : 3,
    "name" : "1"
  },
  "module" : {
    "id" : 456,
    "name" : "Project"
  },
  "name" : "issueDemo",
  "parent_issue" : {
    "id" : 123,
    "name" : "parentDemo"
  },
  "priority" : {
    "id" : 1,
    "name" : "Low"
  },
  "severity" : {
    "id" : 12,
    "name" : "Minor"
  },
  "status" : {
    "id" : 1,
    "name" : "New"
  },
  "tracker" : {
    "id" : 7,
    "name" : "story"
  },
  "updated_time" : "2020-09-14 14:40:11",
  "closed_time" : "2020-09-15 14:40:11",
  "description" : "demo",
  "order" : {
    "id" : 1,
    "name" : "1"
  },
  "accessories" : [ {
    "attachment_id" : 123444,
    "issue_id" : 123444,
    "creator_num_id" : 123444,
    "created_date" : "2021-12-15 15:57:16",
    "file_name" : "res.jpg",
    "container_type" : "issue",
    "disk_file_name" : "f0ef7216-fd05-40d4-8dea-6e6057739bb7.jpg",
    "digest" : 123444,
    "disk_directory" : 123444,
    "creator_id" : "a360371833bf4c558f796fd707b44daf"
  } ]
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.