Sign in
label

List labels according to the query strings.

This endpoint let user list labels by name, scope and project_id

get/labels

Query parameters

qstring

Query string to query resources. Supported query patterns are "exact match(k=v)", "fuzzy match(k=v)", "range(k=[minmax])", "list with union releationship(k={v1 v2 v3})" and "list with intersetion relationship(k=(v1 v2 v3))". The value of range and list can be string(enclosed by " or '), integer or time(in format "2020-04-09 02:36:00"). All of these query patterns should be put in the query string "q=xxx" and splitted by ",". e.g. q=k1=v1,k2=v2,k3=[minmax]

sortstring

Sort the resource list in ascending or descending order. e.g. sort by field1 in ascending order and field2 in descending order with "sort=field1,-field2"

pageinteger

The page number

page_sizeinteger

The size of per page

namestring

The label name.

scopestring

The label scope. Valid values are g and p. g for global labels and p for project labels.

project_idinteger

Relevant project ID, required when scope is p.

Headers

X-Request-Idstring

An unique ID for the request

Response

Get successfully.

idinteger

The ID of the label

namestring

The name the label

descriptionstring

The description the label

colorstring

The color the label

scopestring

The scope the label

project_idinteger

The ID of project that the label belongs to

creation_timestring date-time

The creation time the label

update_timestring date-time

The update time of the label

Changes