Help Center/ CodeArts Req/ API Reference/ API/ IPD Attachment Management/ Downloading an Image in the Work Item Description
Updated on 2025-09-10 GMT+08:00

Downloading an Image in the Work Item Description

Function

This API is used to download an image from the work item description.

Calling Method

For details, see Calling APIs.

URI

GET /v2/ipdprojectservice/projects/{project_id}/images

Table 1 Path 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:

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

Options:

N/A

Default value:

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

issue_id

Yes

String

Description: unique ID of a work item. You can obtain the value from the Querying Work Items or Querying Tree-shaped Work Items API. The value is id in the response body.

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

Default value: N/A

file_name

Yes

String

Definition:

Name of the image in the work item description.

Constraints:

Regular expression: [A-Za-z0-9]{32}(.png|.jpg|.jpeg|.gif|.bmp|.tiff|.svg)

Options:

N/A

Default value:

N/A

field_code

No

String

Definition:

Rich text field code.

Constraints:

N/A

Options:

Maximum length: 64 characters.

Default value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

-

File

Image content.

Example Requests

/v2/ipdprojectservice/projects/e2569a971657464f810949e839ec5640/images?issue_id=1071125987320569856&file_name=f401ab8826b1426285910e6c5da80d07.png

Example Responses

None

Status Codes

Status Code

Description

200

Image content.

Error Codes

See Error Codes.