DocsICP FilingConsole
Documentation

DeleteMetaEntityDef

Updated at:
Copy as MD
Product
My Favorites

Deletes a metadata entity definition, including custom entity types and extension table types.

Operation description

DataWorks Professional Edition or a more advanced edition is required.

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
EntityType

string

Yes

The entity type.

custom_entity-customer_api
Force

boolean

No

Specifies whether to force delete the entity definition. Default value: false. Valid values:

  • true: Automatically deletes all entity objects created under this entity type.

  • false: Checks whether entity objects exist under this entity type. If objects exist, the deletion is failed.

true

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

Id of the request

3C1E755D-B606-57A4-9B9C-7B214E81354C
Success

boolean

Indicates whether the request was successful.

true

Examples

Success response

JSON format

{
  "RequestId": "3C1E755D-B606-57A4-9B9C-7B214E81354C",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.