Upload a file to the issue

POST 
https://your-domain/openapi/v2/project/issues/:issueID/attachments

Upload a file to the issue.

caution

The attachment upload only supports local storage, and does not support methods such as Qiniu, S3, etc.

History

Version	Changes
v3.14.117, v3.15.26	Added in: v3.14.117, v3.15.26

Request

Path Parameters

issueID stringrequired

The issue ID

Query Parameters

teamID stringrequired

The team ID

multipart/form-data

Body

required

name stringrequired

Possible values: <= 64 characters

The name of file

description string

Possible values: <= 64 characters

The description of file

file binaryrequired

The file to upload

Responses

200

Request is successful

application/json

Schema

Schema

data

object

The result of this request.

id string

The file ID

name string

The name of file

hash string

The hash of file

mime string

The mime of file

sizeByte integer

The size of file with byte

url string

The url of file

version integer

The version of file

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

errorData object

Error meta data for this request.

Example (from schema)

[
  {
    "result": "SUCCESS",
    "data": {
      "id": "5f1b0a3b",
      "name": "1.png",
      "hash": "5f1b0a3b5b3b4e0001a3b3b4",
      "mime": "image/png",
      "sizeByte": 123456,
      "url": "https://xxx.com/1.png",
      "version": 1
    }
  }
]

401

Returned if the authentication credentials are incorrect or missing.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Unauthorized",
  "errorMsg": "Access token is invalid"
}

403

Returns if the scope check fails.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Forbidden",
  "errorMsg": "Scope is invalid"
}

404

Returned if the resource object was not found.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "NotFound",
  "errorMsg": "Not Found"
}

500

Internal Server Error.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Internal Server Error",
  "errorMsg": "Internal Server Error"
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X POST 'https://your-domain/openapi/v2/project/issues/:issueID/attachments' \
-H 'Content-Type: multipart/form-data' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d ''

Request Collapse all

Base URL

https://your-domain/openapi/v2

Auth

Bearer Token

Parameters

issueID — pathrequired

teamID — queryrequired

Body required

ResponseClear

Click the Send API Request button above and see the response here!