MetaEntityAttributeDef-DataWorks(DataWorks)-阿里云帮助中心

Parameter	Type	Description	Example
	object	Custom entity attribute definition
Name	string	Attribute identifier. Can contain letters, digits, and underscores (_). Must start with a letter or digit. Maximum length: 64 characters.	apiCode
DisplayName	string	Display name. Maximum length: 32 characters.	API Code
Type	string	Attribute type. Valid values: STRING, TEXT, INT, FLOAT, BOOLEAN, DATE, ARRAY, ENUM, and JSON.	STRING
IsOptional	boolean	Whether the attribute value is optional. Default value: true. Important Validation is performed when you create an entity. If this parameter is set to false and the attribute value is not provided during entity creation, a validation error is returned.	true
SearchFilterEnabled	boolean	Whether the attribute can be used as a filter on the search page. Default value: false. Only the STRING, DATE, ENUM, ARRAY, INT, and BOOLEAN types support this feature.	false
DisplayEnabled	boolean	Whether the attribute is displayed on the details page. Default value: true.	true
AllowedValues	array	Allowed enumeration values. Required when Type is set to ENUM.
	string	Allowed value.	LABEL_1
Description	string	The description of the attribute.	Level description

object

Custom entity attribute definition

Name

string

Attribute identifier. Can contain letters, digits, and underscores (_). Must start with a letter or digit. Maximum length: 64 characters.

apiCode

DisplayName

string

Display name. Maximum length: 32 characters.

API Code

Type

string

Attribute type. Valid values: STRING, TEXT, INT, FLOAT, BOOLEAN, DATE, ARRAY, ENUM, and JSON.

STRING

IsOptional

boolean

Whether the attribute value is optional. Default value: true.

Important Validation is performed when you create an entity. If this parameter is set to false and the attribute value is not provided during entity creation, a validation error is returned.

true

SearchFilterEnabled

boolean

Whether the attribute can be used as a filter on the search page. Default value: false.

Only the STRING, DATE, ENUM, ARRAY, INT, and BOOLEAN types support this feature.

false

DisplayEnabled

boolean

Whether the attribute is displayed on the details page. Default value: true.

true

AllowedValues

array

Allowed enumeration values. Required when Type is set to ENUM.

string

Allowed value.

LABEL_1

Description

string

The description of the attribute.

Level description