Service endpoint and authorization
- Get a service endpoint: Replace
{domain}in the API request syntax. - Get a personal access token.
|
Product |
Resource |
Required permissions |
|
Test Management |
test repository |
Read-only |
Request syntax
Region edition
GET https://{domain}/oapi/v1/testhub/testRepo/{id}/tagsRequest headers
|
Parameter |
Type |
Required |
Description |
Example |
|
x-yunxiao-token |
string |
Yes |
Your personal access token. |
pt-0fh3****0fbG_35af****0484 |
Request parameters
|
Parameter |
Type |
In |
Required |
Description |
Example |
|
id |
string |
path |
Yes |
The unique identifier of the test repository. |
|
|
page |
integer |
query |
No |
The page number. Default: 1. |
|
|
perPage |
integer |
query |
No |
The number of items per page. Default: 20. Maximum: 100. |
|
|
q |
string |
query |
No |
Filters results by a keyword in the name. |
|
Request examples
Region edition
curl -X 'GET' \
'https://{domain}/oapi/v1/testhub/testRepo/{id}/tags?page={page}&perPage={perPage}&q={q}' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'Response parameters
|
Parameter |
Type |
Description |
Example |
| - |
array |
A list of test repository tags. |
|
| - |
object |
A test repository tag. |
|
| color |
string |
The color of the tag. For example: #49AEAC. |
|
| id |
string |
The unique identifier of the tag. |
|
| name |
string |
The tag name. |
|
Response example
[
{
"color": "#49AEAC",
"id": "cll0rn4r100083b6389p77guz",
"name": "TagName"
}
]Response headers
|
Parameter |
Description |
Example |
|
x-next-page |
The next page number. On the last page, this value equals the current page number. |
|
|
x-page |
The current page number. |
|
|
x-per-page |
The number of items per page. |
|
|
x-prev-page |
The previous page number. |
|
|
x-total |
The total number of items. |
|
|
x-total-pages |
The total number of pages. |
|
Error codes
See the error code center for API-related error codes.