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

Uploading an Attachment for SDK

Function

Upload attachments for SDK. The attachments to be uploaded must meet the restrictions, such as those on the attachment size, returned by the API for querying attachment restrictions.

URI

POST /v2/servicerequest/accessorys/json-format-content

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token.

It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Minimum length: 1

Maximum length: 5000

X-Language

No

String

Specifies the language environment. The value is a common language description character string, for example, zh-cn. It is zh-cn by default.

Some internationalization information, such as the service ticket type and name, is displayed based on the language environment.

Minimum length: 1

Maximum length: 32

X-Time-Zone

No

String

Specifies the time zone. The value is a common time zone description character string, for example, GMT+8. It is GMT+8 by default.

Time-related data is processed based on the time zone of the environment.

Minimum length: 1

Maximum length: 32

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

accessory_name

Yes

String

Specifies the file name.

Minimum length: 1

Maximum length: 512

accessory_from

Yes

String

Specifies the file source. The options are incident (for service ticket creation) and message (for messages).

Minimum length: 1

Maximum length: 32

upload_type

No

Integer

Specifies the upload type. The default value is 0, and the value 1 indicates the markdown mode.

Minimum value: 0

Maximum value: 1

accessory_data

Yes

String

Specifies the file content in Base64 format.

Minimum length: 1

Maximum length: 9223372036854775807

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

accessory_id

String

Specifies the attachment ID.

Minimum length: 1

Maximum length: 64

Request Example

POST https://{endpoint}/v2/servicerequest/accessorys/json-format-content

{
  "accessory_name" : "test",
  "accessory_from" : "message",
  "upload_type" : 1,
  "accessory_data" : "Base64"
}

Response Example

Status code: 200

The ID of the attachment is returned if the upload is successful.

{
  "accessory_id" : "123456"
}

Status Codes

Status Code

Description

200

The ID of the attachment is returned if the upload is successful.

Error Codes

See Error Codes.