All Products
Search
Document Center

DataWorks:UpdateMetaEntityDef

Last Updated:Jun 05, 2026

Updates a meta entity definition. This operation supports both custom and extended table entity types.

Operation description

This operation requires DataWorks Professional Edition or a later version.

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

DisplayName

string

No

The new display name. The maximum length is 32 characters.

Business API

Description

string

No

The new description.

description

NewAttributeDefs

array

No

The new attribute definitions. New attributes must be optional.

[]

MetaEntityAttributeDef

No

The attribute definition.

UpdateAttributeDefs

array

No

The updates to existing attribute definitions. You can modify only the display name and description. You can also add enumerated values for attributes of the ENUM type.

[]

MetaEntityAttributeDef

No

The attribute definition.

Response elements

Element

Type

Description

Example

object

The returned data.

RequestId

string

The request ID.

E08F38AB-3BA0-5047-8E9E-9AA4839263EA

Success

boolean

Indicates whether the request was successful.

true

Examples

Success response

JSON format

{
  "RequestId": "E08F38AB-3BA0-5047-8E9E-9AA4839263EA",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.