Help Center/ DataArts Studio/ API Reference/ DataArts Catalog APIs/ Data Map/ Tagging Assets (Invitational Test)
Updated on 2025-11-17 GMT+08:00
View PDF

Tagging Assets (Invitational Test)

Function

This API is used to tag assets.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/datamap/entities/guids/tags

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 it, see Instance ID and Workspace ID.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

recommendations

No

Array of Recommendation objects

Tag information

guids

No

Array of strings

Asset GUID

add_type

No

String

Addition type. The value can be cover or append. The default value is append.
Table 4 Recommendation

Parameter

Mandatory

Type

Description

name

No

String

Tag name

Response Parameters

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

{
  "guids" : [ "3e74c3d7-c5b7-4e7c-827e-40adb1b5ecbf", "90c3b725-27db-45cc-aa88-3dc6eba93d46" ],
  "recommendations" : [ {
    "name" : "MTa"
  }, {
    "name" : "JnB"
  } ],
  "add_type" : "append"
}

Example Responses

None

Status Codes

Status Code

Description

200

OK.

400

Bad request.

401

Unauthorized.

403

Forbidden.

404

Not found.

500

Internal server error.
Parent Topic: Data Map