Help Center/ CodeArts Req/ API Reference/ API/ IPD Attachment Management/ Uploading Files and Associating Work Items
Updated on 2025-09-10 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Uploading Files and Associating Work Items

Function

This API is used to upload files and associate them with work items.

Calling Method

For details, see Calling APIs.

URI

POST /v1/ipdprojectservice/projects/{project_id}/issues/{issue_id}/attachments/upload

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

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

Request Parameters

Table 2 FormData parameters

Parameter

Mandatory

Type

Description

attachment

Yes

File

Definition:

Attachment.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

status

String

Definition:

Status.

Options:

N/A

message

String

Definition:

Failure information.

Options:

N/A

result

Array of AttachmentVoExt objects

Definition:

Attachment upload information.
Table 4 AttachmentVoExt

Parameter

Type

Description

progress

Integer

Definition:

Upload progress.

Options:

N/A

id

String

Definition:

Attachment ID.

Options:

N/A

workitem_id

String

Definition:

Work item ID.

Options:

N/A

filesize

Long

Definition:

File size.

Options:

N/A

store_filename

String

Definition:

File name.

Options:

N/A

title

String

Definition:

File name.

Options:

N/A

Example Requests

POST https://{endpoint}/v1/ipdprojectservice/projects/gdbdf969b32694524a949b5ef6b3e124a/issues/956239067176935400/attachments/upload

------WebKitFormBoundary1kuNerRnRVVybt65
Content-Disposition: form-data; name="attachment"; filename="demo.PNG"
Content-Type: image/png

Example Responses

Status code: 200

Upload success response.

{
  "status" : "success",
  "message" : null,
  "result" : null
}

Status Codes

Status Code

Description

200

Upload success response.

Error Codes

See Error Codes.