Description
Characteristics of entity fields.
Elements
| Element | Description |
|---|---|
| Active | A value of true indicates that the field can be displayed in the User Interface. |
| Editable | A value of true indicates that the field value can be changed by users. This is for UI use. The REST API does not enforce editing permissions. |
| Field | Characteristics of an entity field. |
| Fields | A collection of entity fields. |
| Filterable | A value of true indicates that the user can use the field for filtering and sorting. |
| Groupable | A value of true indicates that a user can group the results by values of this field. |
| History | A value of true indicates that change records are kept on this field. |
| List-Id | If Verify is true,indicating that the field value must be an element of a list, then List-Id is the ID of the list. |
| References | Links that use this field. |
| RelationReference | A relation that uses this field. See the Relations schema and the relations resource. |
| Required | A value of true indicates an entity cannot be created without a value for this field. |
| Size | The maximum size of the data in bytes. |
| SupportsMultivalue | Indicates whether the field can contain multiple values. |
| System | A value of true indicates a field used by uncustomized installations of ALM. false indicates a user-defined field. |
| Type | The data type. One of: String, UsersList, LookupList, Date, DateTime, Memo, Number, Reference. A Reference field contains the foreign key of the record that contains related information. |
| Verify | A value of true indicates that the field value must be an item in a list. |
| VersionControlled | A value of true indicates that this field is version controlled in projects where versioning is enabled. A value of true does not mean that versioning is enabled for the project. |
| Virtual | A value of true indicates that the field does not have a physical representation in the database. |
| Visible | If false, for the current user, this field is not returned in the server response to queries and is not displayed in the ALM user interface. |