Help Center> Service Tickets> API Reference> API v2 (Recommended)> Attachment Functions> Attachment Restrictions
View PDF

Attachment Restrictions

Function Description

To query restrictions of an attachment, such as size, quantity, and file type.

Debugging

You can debug this API in API Explorer.

URI

GET /v2/servicerequest/accessorys/limits

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-Site

No

Integer

Specifies the site.

The value can be 0 (China site) or 1 (International site). If this parameter is left blank, it is 0 by default.

Minimum value: 0

Maximum value: 1

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

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

accessory_limit

AccessoryLimitVo object

Specifies the attachment restrictions.
Table 3 AccessoryLimitVo

Parameter

Type

Description

limit_count

String

Specifies the limited number of files.

Minimum length: 1

Maximum length: 2

limit_size

String

Specifies the limited file size in MB.

Minimum length: 1

Maximum length: 2

limit_file_type

String

Specifies the limited file types.

Minimum length: 1

Maximum length: 256

Request Example

GET https://{endpoint}/v2/servicerequest/accessorys/limits

null

Response Example

Status code: 200

OK

{
  "accessory_limit" : {
    "limit_count" : 5,
    "limit_size" : 4,
    "limit_file_type" : "jpg"
  }
}

Status Code

Status Code

Description

200

OK

Error Code

See here.

Parent topic: Attachment Functions