Help Center/ DataArts Insight/ API Reference/ User Tags/ Obtaining User Tag Values
Updated on 2025-02-25 GMT+08:00

Obtaining User Tag Values

Function

This API is used to obtain user tag values.

URI

GET /v1/{project_id}/tags/value

Table 1 URI parameter

Parameter

Mandatory

Type

Description

project_id

Yes

String

project_id

Table 2 Query parameters

Parameter

Mandatory

Type

Description

type

Yes

String

Explanation

Tag type, which can be user tag or user group tag.

Constraints

N/A

Value range

The enumerated values are:

  • user: user tag.
  • userGroup: user group tag.

Default value

N/A

offset

No

Integer

Start offset of returned items. The default value is 0.

limit

No

Integer

Number of returned records. The default value is 10.

Request Parameters

Table 3 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. Obtain a user token by calling IAM's "Obtaining a User Token" API. X-Subject-Token in the response header is the desired user token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

count

Integer

Total data volume.

page_data

Array of UserTagValueItemVO objects

Data.

Table 5 UserTagValueItemVO

Parameter

Type

Description

user_id

String

User ID.

account_name

String

Username.

type

String

Explanation

Tag type, which can be user tag or user group tag.

Constraints

N/A

Value range

The enumerated values are:

  • user: user tag.
  • userGroup: user group tag.

Default value

N/A

tag_values

Map<String,Array<String>>

User tag value.

tag_value_info

Map<String,UserTagValueVo>

Tag value information.

Table 6 UserTagValueVo

Parameter

Type

Description

user_id

String

User or user group ID.

account_name

String

Name of a user or user group.

type

String

Explanation

Tag type, which can be user tag or user group tag.

Constraints

N/A

Value range

The enumerated values are:

  • user: user tag.
  • userGroup: user group tag.

Default value

N/A

from_type

String

Source type. The options are:

  • IAM: IAM user or user group.
  • CUSTOM: Custom user group.
  • SELF-BUILT: custom user.

group_path

Array of strings

User group-level path.

create_date

Integer

Creation timestamp.

update_date

Integer

Update timestamp.

value_type

String

Default tag value type. The default value is NULL.

  • DEFAULT: Default value, which is the default tag value.
  • NULL: Null.
  • ALL: All values.
  • ENUM: Enumerated values. default_value must be set to an enumerated value.

value

Array of strings

Enumerated value.

Example Request

Obtain the values of user tags.

GET https://{endpoint}/v1/{project_id}/tags?type=user

Example Response

None

Status Codes

Status Code

Description

200

User tags are successfully listed.

Error Codes

See Error Codes.