Updated on 2022-12-12 GMT+08:00

Uploading an Attachment

Function

Upload attachments using form-data.

URI

POST /v2/servicerequest/accessorys

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 FormData parameters

Parameter

Mandatory

Type

Description

file

Yes

File

File content.

form_data

Yes

String

Information about the attachment, such as its source.

Minimum length: 1

Maximum length: 5000

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

{
  "form_data" : "{/'accessFrom/':/'message/'}",
  "file" : "file"
}

Example Response

Status code: 200

Upload succeeded. ID of the attachment is returned.

{
  "accessory_id" : "123456"
}

Status Codes

Status Code

Description

200

Upload succeeded. ID of the attachment is returned.

Error Codes

See Error Codes.