Help Center/ DataArts Studio/ API Reference/ DataArts Architecture APIs/ Tag API/ Delete a tag.
Updated on 2025-11-17 GMT+08:00
View PDF

Delete a tag.

Function

This API is used to delete an asset tag based on the ID of an asset (table or attribute).

Calling Method

For details, see Calling APIs.

URI

DELETE /v2/{project_id}/design/{entity_id}/tags

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Project ID and Account ID.

entity_id

Yes

String

Table ID, which is a string
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

attr_id

No

String

Attribute ID, which is a string

tag

Yes

String

Label name

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

IAM token, which is obtained by calling the IAM API for obtaining a user token (value of X-Subject-Token in the response header).

This field is mandatory for authentication using tokens.

workspace

Yes

String

Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID.

X-Project-Id

No

String

Project ID. For details about how to obtain the project ID, see Project ID and Account ID.

This parameter is mandatory for API requests that use AK/SK authentication in multi-project scenarios.

Content-Type

No

String

Default value: application/json;charset=UTF-8

This parameter is optional. If the body is available, this parameter is mandatory. If the body is unavailable, you do not need to set this parameter or verify it.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

data

data object

Returned data information.
Table 5 data

Parameter

Type

Description

value

String

This parameter is returned by the API for adding a tag to a table or attribute or deleting a tag. If the value of vale is null, the operation is successful.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.6000, indicating that the request fails to be processed.

error_msg

String

Error message

data

Object

Returned data information.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.6000, indicating that the request fails to be processed.

error_msg

String

Error message

data

Object

Returned data information.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.6000, indicating that the request fails to be processed.

error_msg

String

Error message

data

Object

Returned data information.

Example Requests

  • Remove the tag ddd from the table whose ID is 1217123755210469378.

    DELETE https://{endpoint}/v2/{project_id}/design/1217123755210469378/tags?tag=ddd

  • Remove the tag ccc from the attribute whose ID is 1217123755214663680 in the table whose ID is 1217123755210469378.

    DELETE https://{endpoint}/v2/{project_id}/design/1217123755210469378/tags?attr_id=1217123755214663680&tag=ccc

Example Responses

Status code: 200

Success: indicates whether the data is successfully returned.

{
  "data" : {
    "value" : null
  }
}

Status code: 400

BadRequest

{
  "error_code" : "DS.60xx",
  "error_msg" : "The user request is illegal."
}

Status code: 401

Unauthorized

{
  "error_code" : "DS.60xx",
  "error_msg" : "User authentication failed."
}

Status code: 403

Forbidden

{
  "error_code" : "DS.60xx",
  "error_msg" : "The user does not have permission to call this API."
}

Status Codes

Status Code

Description

200

Success: indicates whether the data is successfully returned.

400

BadRequest

401

Unauthorized

403

Forbidden
Parent Topic: Tag API