Help Center/ DataArts Studio/ API Reference/ DataArts Catalog APIs/ Data Map/ Displaying Search and Query Tags on Multiple Pages (Invitational Test)

Updated on 2025-11-17 GMT+08:00

View PDF

Displaying Search and Query Tags on Multiple Pages (Invitational Test)

Function

The search and query tags are displayed on multiple pages. The function of this API is in the invitation test phase and will be gradually available in the OBT.

Calling Method

For details, see Calling APIs.

URI

POST /v3/{project_id}/datamap/tags/search

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain it, see Project ID and Account ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. This parameter is mandatory when token authentication is used. You can obtain it from the value of X-Subject-Token in the response message header returned by the "Obtaining a User Token" API of the IAM service.
instance	Yes	String	Instance ID. For details about how to obtain the instance ID, see Instance ID and Workspace ID.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
tag_ids	No	Array of strings	Tag ID.
type	No	String	Type
name	No	String	Tag name, which is used as a search box for filtering.
create_user	No	String	Creator, which is used for filtering in the search box.
start	No	String	Start time.
end	No	String	End time.
offset	No	Integer	Page number.
limit	No	Integer	Page size.
sort_by	No	String	Sort by xx.
sort_order	No	String	Ascending/Descending order.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
limit	Integer	Page size.
offset	Integer	Page number.
count	Integer	Indicates the number of queried records.
quota	Integer	Specifies the maximum number of tags that can be created.
tags	Array of OpenTag objects	Tag entity
total	Integer	Total number of created tags.

**Table 5** OpenTag
Parameter	Type	Description
name	String	Tag name.
description	String	Tag description.
tag_id	String	Tag ID.
create_time	Long	Creation time.
update_time	Long	Modification time.
create_user	String	Creator
domain_id	String	User domain ID.
instance_id	String	Instance ID.
project_id	String	Project ID.
create_user_id	String	Creator ID.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 500

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests

{
  "offset" : 1,
  "limit" : 10,
  "sort_order" : "desc",
  "name" : "test11",
  "start" : 1685548800000,
  "end" : 1688313599999,
  "sort_by" : "createTime"
}

Example Responses

Status code: 200

OK.

{
  "limit" : 10,
  "offset" : 1,
  "count" : 1,
  "total" : 11,
  "quota" : 100,
  "tags" : [ {
    "name" : "test1123",
    "description" : "",
    "tag_id" : "8a94819c88a43c190188a4452ba40006",
    "create_time" : 1686383176612,
    "update_time" : 1686383176612,
    "create_user" : "username",
    "create_user_id" : "0833a573fe80d5401f6dc010a775569a",
    "domain_id" : "0833a5736980d53b0f22c0102ffcbfc0",
    "instance_id" : "dd97167b873d4a79b2aad54d4370a3bc",
    "project_id" : "0833a5737480d53b2f25c010dc1a7b88"
  } ]
}