SchemaAttribute
SuperType: SchemaElement
Status: ACTIVE_TYPEDEF
Category: ENTITY_DEF
Version: 3
Valid Element Status List:
- ACTIVE
- DELETED
Attribute Definitions:
| Name | Type | Status | Indexable | Unique | Cardinality | Description |
|---|---|---|---|---|---|---|
| aliases | array<string> | ACTIVE_ATTRIBUTE | True | False | AT_MOST_ONE | List of aliases for attribute. |
| defaultValueOverride | string | ACTIVE_ATTRIBUTE | True | False | AT_MOST_ONE | Initial value for the attribute (overriding the default value of its type. |
| minimumLength | int | ACTIVE_ATTRIBUTE | True | False | AT_MOST_ONE | Minimum length of the data value (zero means unlimited). |
| precision | string | ACTIVE_ATTRIBUTE | True | False | AT_MOST_ONE | Number of digits after the decimal point. |
| length | int | ACTIVE_ATTRIBUTE | True | False | AT_MOST_ONE | Length of the data field (zero means unlimited). |
| orderedValues | boolean | ACTIVE_ATTRIBUTE | True | False | AT_MOST_ONE | When multiple occurrences are allowed, indicates whether the values are ordered or not. |
| allowsDuplicateValues | boolean | ACTIVE_ATTRIBUTE | True | False | AT_MOST_ONE | When multiple occurrences are allowed, indicates whether duplicates of the same value are allowed or not. |
| significantDigits | int | ACTIVE_ATTRIBUTE | True | False | AT_MOST_ONE | Number of significant digits before the decimal point (zero means it is an integer). |
| maxCardinality | int | ACTIVE_ATTRIBUTE | True | False | AT_MOST_ONE | Maximum number of occurrences of this attribute allowed (-1 = infinite). |
| cardinality | string | DEPRECATED_ATTRIBUTE | True | False | AT_MOST_ONE | Number of occurrences of this attribute allowed (deprecated). |
| minCardinality | int | ACTIVE_ATTRIBUTE | True | False | AT_MOST_ONE | Minimum number of occurrences of this attribute allowed (0 = optional, 1+ = mandatory). |
| nativeClass | string | ACTIVE_ATTRIBUTE | True | False | AT_MOST_ONE | Native class used by the client to represent this element. |
| sortOrder | DataItemSortOrder | ACTIVE_ATTRIBUTE | True | False | AT_MOST_ONE | Suggested ordering of values in this attribute. |
| isNullable | boolean | ACTIVE_ATTRIBUTE | True | False | AT_MOST_ONE | Accepts null values or not. |
| name | string | DEPRECATED_ATTRIBUTE | True | False | AT_MOST_ONE | Short name that the element is known as - not necessarily unique. |
| position | int | ACTIVE_ATTRIBUTE | True | False | AT_MOST_ONE | Location of the attribute in the parent schema's list of attributes, starting at zero. |
Description:
A schema element that nests another schema type in its parent.