Updated on 2025-07-02 GMT+08:00

Querying Work Item Details

Function

This API is used to query work item details.

Calling Method

For details, see Calling APIs.

URI

GET /v1/ipdprojectservice/projects/{project_id}/issues/{issue_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Description: 32-bit UUID of a project, which uniquely identifies a project. You can obtain the project ID by calling the API for querying the project list. The value of project_id in the response body is the project ID.

Constraints: regular expression, ^[A-Za-z0-9]{32}$

Default value: N/A

issue_id

Yes

String

Description: unique ID of a work item.

Constraints: regular expression, ^([0-9]{18,19})$

Default value: N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

issue_type

Yes

String

Definition:

Work item type.

Constraints:

Minimum length: 1 character. Maximum length: 32 characters.

Range:

Epic, FE, SF, IR, RR, SR, US, AR, Bug, and Task

Default value:

N/A

domain_id

No

String

Definition:

Domain ID of the project.

Constraints:

Regular expression: ^[A-Za-z0-9]{32}$

Options:

N/A

Default value:

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

Definition:

User token. Obtain the token by calling theObtaining a User TokenIAM API. In the returned response header, X-Subject-Token is the desired user token.

Constraints:

Mandatory.

Range:

Minimum length: 10 character. Maximum length: 32,768 characters.

Default value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

status

String

Definition:

Status

Options:

N/A

message

String

Definition:

Information.

Options:

N/A

result

Array of Map<String,> objects

Definition:

Query result.

Example Requests

/v1/ipdprojectservice/projects/e4b0424709934bd1a54753e70336564d/issues/981935538274476033?issue_type=RR

Example Responses

Status code: 200

Success response

{
  "status" : "success",
  "message" : null,
  "result" : [ {
    "id" : "1135239465657217024",
    "number" : "BUG20250530487304",
    "title" : "Test_bug_Key Issue",
    "type" : "bug",
    "stay_days" : 1,
    "tenant_id" : "4e919d73499648e3b0292cd3cbef806a",
    "created_date" : "1748591780337"
  } ]
}

Status Codes

Status Code

Description

200

Success response

Error Codes

See Error Codes.