Retrieves the details of a specified tag categorization.
Service Endpoints and Authorization Information
- Obtain service endpoints: Replace {domain} in the API request syntax.
- Obtain personal access tokens.
|
Product |
Resource |
Required Permissions |
|
Pipeline |
Tag |
Read-only |
Request Syntax
Region edition
GET https://{domain}/oapi/v1/flow/tagGroups/{id}
Request Headers
|
Parameter |
Type |
Required |
Description |
Example Value |
|
x-yunxiao-token |
string |
Yes |
Personal access token. |
pt-0fh3****0fbG_35af****0484 |
Request Parameters
|
Parameter |
Type |
Location |
Required |
Description |
Example Value |
|
id |
integer |
path |
Yes |
Tag categorization ID. |
111 |
Request Examples
Region edition
curl -X 'GET' \
'https://{domain}/oapi/v1/flow/tagGroups/111' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'
Response Parameters
|
Parameter |
Type |
Description |
Example Value |
| - |
object |
|
|
| creatorAccountId |
string |
Creator. |
1111111111111 |
| flowTagList |
array |
|
|
| - |
object |
|
|
| color |
string |
Tag color. |
#1F9AEF |
| creatorAccountId |
string |
Creator. |
1111111111111 |
| id |
integer |
Tag ID. |
111 |
| modifierAccountId |
string |
Modifier. |
1111111111111 |
| name |
string |
Tag name. |
Tag name |
| id |
integer |
Tag categorization ID. |
1111 |
| modifierAccountId |
string |
Modifier. |
1111111111111 |
| name |
string |
Tag categorization name. |
Tag categorization name |
Response Examples
{
"creatorAccountId": "1111111111111",
"flowTagList": [
{
"color": "#1F9AEF",
"creatorAccountId": "1111111111111",
"id": 111,
"modifierAccountId": "1111111111111",
"name": "Tag name"
}
],
"id": 1111,
"modifierAccountId": "1111111111111",
"name": "Tag categorization name"
}
Error Codes
For API error codes, see the Error Code Center.