Creates a custom attribute definition.
Try it now
Test
RAM authorization
Request syntax
POST HTTP/1.1Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Id |
string |
Yes |
The custom attribute ID. The ID must match |
custom-attribute:biz_owner |
| DisplayName |
string |
Yes |
The display name of the custom attribute. The name must be less than 128 characters in length. |
Business Owner |
| Type |
string |
Yes |
The type of the custom attribute. Valid values: ENUM, TEXT, and HYPERLINK. |
TEXT |
| EntityTypes |
array |
Yes |
The list of applicable entity types. Exact entity types and wildcard patterns such as
|
|
|
string |
No |
The entity type. |
maxcompute-table |
|
| ValueEnums |
array |
No |
The enumeration values. This parameter is required when type is set to ENUM. This parameter is not supported for the TEXT and HYPERLINK types. |
|
|
string |
No |
The enumeration value. |
VALUE_1 |
|
| DisplayEnabled |
boolean |
No |
Specifies whether the custom attribute is displayed on the details page. Default value: true. |
true |
| SearchFilterEnabled |
boolean |
No |
Specifies whether the custom attribute can be used as a filter on the Data Map search page. Default value: false. Currently, only the ENUM type supports setting this parameter to true. |
false |
| Comment |
string |
No |
The description of the custom attribute. The description must be less than 256 characters in length. |
test comment |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
The request ID. |
5A1E9EBB-FEA6-5BBB-B7BE-BFC0FB3F8C71 |
| Success |
boolean |
Indicates whether the request was successful. |
true |
| Result |
boolean |
The creation result. |
true |
Examples
Success response
JSON format
{
"RequestId": "5A1E9EBB-FEA6-5BBB-B7BE-BFC0FB3F8C71",
"Success": true,
"Result": true
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.