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

Querying a Label

Function

Query a label.

URI

GET /v2/servicerequest/labels

Table 1 Query parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Specifies the query offset. The default value is 0.

Minimum value: 0

Maximum value: 2147483647

limit

No

Integer

Specifies the number of records to be queried. The default value is 10 and the maximum value is 100.

Minimum value: 0

Maximum value: 100

name

No

String

Specifies the label name. The maximum value is 64. Fuzzy query is supported.

Minimum length: 0

Maximum length: 64

label_id

No

Integer

Specifies the label identifier.

Minimum value: 0

Maximum value: 2147483647

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

total_count

Integer

Specifies the total number.

Minimum value: 0

Maximum value: 2147483647

label_list

Array of CaseLabelInfo objects

Specifies the label list.

Table 4 CaseLabelInfo

Parameter

Type

Description

label_id

Integer

Specifies the label identifier.

Minimum value: 0

Maximum value: 2147483647

name

String

Specifies the label name.

Minimum length: 1

Maximum length: 64

color

String

Specifies the label color.

Minimum length: 1

Maximum length: 7

Request Example

GET https://{endpoint}/v2/servicerequest/labels?offset=0&limit=10

null

Response Example

Status code: 200

Returned successfully.

{
  "total_count" : 1,
  "label_list" : [ {
    "label_id" : 1,
    "name" : "test",
    "color" : "#000000"
  } ]
}

Status Codes

Status Code

Description

200

Code 200 is returned if the operation is successful.

Error Codes

See Error Codes.