All Products
Search
Document Center

DataWorks:BatchDeleteMetaEntities

Last Updated:Jun 05, 2026

Deletes multiple meta entities in a batch. This operation deletes custom meta entities and extended table-based objects, such as databases and tables. You cannot delete a column individually. Instead, you must delete the entire table to remove its associated columns.

Operation description

This operation requires DataWorks Professional Edition or higher.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

Ids

array

Yes

An array of IDs for the meta entities to delete. You can specify up to 10 IDs in a single request. All entities in the batch must have the same EntityType.

string

No

The ID of the meta entity.

custom_entity-demo:entity_01

Response elements

Element

Type

Description

Example

object

The response object.

RequestId

string

The unique identifier of the request.

1FC02D76-4A94-5D97-B52C-00A031B95359

Success

boolean

Indicates whether the request was successful. This parameter returns true even if the deletion of some entities fails. To check the status of each individual deletion, see the Success and ErrorMessage fields in the Results array.

[]

Results

array

An array of deletion results, one for each requested entity. Each result indicates whether the deletion was successful and includes an error message upon failure.

MetaEntityWriteResult

The deletion result for a single entity.

Examples

Success response

JSON format

{
  "RequestId": "1FC02D76-4A94-5D97-B52C-00A031B95359",
  "Success": true,
  "Results": [
    {
      "Name": "",
      "EntityType": "",
      "Id": "",
      "Success": false,
      "ErrorMessage": ""
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.