Help Center> Service Tickets> API Reference> API v2 (Recommended)> Service Ticket Management> Exporting a Service Ticket
View PDF

Exporting a Service Ticket

Function Description

To export a service ticket.

Debugging

You can debug this API in API Explorer.

URI

GET /v2/servicerequest/cases/export

Table 1 Query parameters

Parameter

Mandatory

Type

Description

language

Yes

String

Specifies the language.

Minimum length: 1

Maximum length: 32

timezone

Yes

String

Specifies the time zone.

Minimum length: 1

Maximum length: 64

incident_id

No

String

Specifies the service ticket ID.

Minimum length: 0

Maximum length: 64

query_start_time

No

String

Indicates the start time of the query.

Minimum length: 0

Maximum length: 32

query_end_time

No

String

Indicates the end time of the query.

Minimum length: 0

Maximum length: 32

x_customer_name

No

String

Specifies the sub-user name.

Minimum length: 0

Maximum length: 64

search_key

No

String

Specifies the keyword entered for search.

Minimum length: 0

Maximum length: 32

status

No

Integer

Specifies the status. The values include: 0 (To be processed), 1 (Processing), 2 (To be confirmed), 3 (Completed), 4 (Canceled), 12 (Invalid), and 17 (Pending feedback).

Minimum value: 0

Maximum value: 20

customer_id

No

String

Specifies the user ID.

Minimum length: 0

Maximum length: 64

tenant_source_id_list

No

Array

Specifies the source ID.

sub_customer_id

No

String

Specifies the sub-user ID.

Minimum length: 0

Maximum length: 64

offset

No

Integer

Specifies the query offset.

Minimum value: 0

Maximum value: 65535

limit

No

Integer

Specifies the number of records to be queried.

Minimum value: 0

Maximum value: 100

Request Parameters

Table 2 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 3 Response body parameters

Parameter

Type

Description

-

File

Code 200 is returned.

Request Example

GET https://{endpoint}/v2/servicerequest/cases/export?language=zh-cn&timezone=GMT%2B8

null

Response Example

None

Status Code

Status Code

Description

200

Code 200 is returned.

Error Code

See here.