Help Center/ Service Tickets/ API Reference/ API v2 (Recommended)/ Management of Associated Service Tickets/ Querying Associated Service Tickets
Updated on 2022-10-13 GMT+08:00
View PDF

Querying Associated Service Tickets

Function

Query associated service tickets. Brief information of these service tickets is returned.

URI

GET /v2/servicerequest/cases/{case_id}/relations

Table 1 Path parameters

Parameter

Mandatory

Type

Description

case_id

Yes

String

Specifies the ID of the service ticket to be associated.

Minimum length: 1

Maximum length: 64

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

case_relation_list

Array of CaseRealtionInfo objects

Specifies the list of associated service tickets.
Table 4 CaseRealtionInfo

Parameter

Type

Description

case_id

String

Specifies the service ticket ID.

Minimum length: 1

Maximum length: 64

simple_description

String

A brief description.

Minimum length: 1

Maximum length: 2000

user_name

String

Specifies the user who submits the service ticket, that is, username.

Minimum length: 1

Maximum length: 256

Request Example

None

Example Response

Status code: 200

Code 200 is returned if the operation is successful.

{
  "case_relation_list" : [ {
    "case_id" : "test",
    "simple_description" : "test",
    "user_name" : "test"
  } ]
}

Status Codes

Status Code

Description

200

Code 200 is returned if the operation is successful.

Error Codes

See Error Codes.