CreateMetaEntityDef - DataWorks - Alibaba Cloud Documentation Center

Operation description

This operation requires DataWorks Professional Edition or a higher edition.

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

POST  HTTP/1.1

Parameter	Type	Required	Description	Example
Name	string	Yes	The type definition name. For a pure custom type, the name must match `^[a-z0-9][a-z0-9_]$`. For an extended table type, the name must match `^[a-z0-9][a-z0-9_]-table$`.	biz_api
DisplayName	string	Yes	The display name. The maximum length is 32 characters.	Business API
Description	string	No	A description of the entity definition.	description
Extend	string	No	The extension mode. Valid values: `NONE`: The default value. Specifies a pure custom type with user-defined attributes. `TABLE`: Specifies an extended table type that references an existing table type in Data Map. Attribute definitions are not required for this type. You can create corresponding `Database` and `Table` objects for it.	NONE
AttributeDefs	array	No	A list of attribute definitions for the pure custom type. Do not specify this parameter if the `Extend` parameter is set to `TABLE`.	[]
	MetaEntityAttributeDef	No	An object that defines a single attribute for the entity.

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	0A04C673-BEFA-5803-94E5-89E2D9F8C567
Success	boolean	Indicates whether the request was successful.	true
EntityType	string	The unique identifier of the created entity type.	custom_entity-biz_api

Success response

JSON format

{
  "RequestId": "0A04C673-BEFA-5803-94E5-89E2D9F8C567",
  "Success": true,
  "EntityType": "custom_entity-biz_api"
}

See Error Codes for a complete list.

See Release Notes for a complete list.