fields Schema
Field Element
fields Schema : Field Element

Glossary Item Box

Description

Characteristics of an entity field.
Namespace (none)

Diagram

References Element SupportsMultivalue Element VersionControlled Element Groupable Element Filterable Element Editable Element Visible Element Active Element Virtual Element Verify Element Type Element System Element Required Element List-Id Element History Element Size Element All Field Element

Overview

Field
Characteristics of an entity field.
Label required
The display label text. Do not use as field identifier. Can be localized.
Name required xs:string
The field name.
PhysicalName required xs:string
The field name in the DB.
Mask required xs:string
The field input mask, for example, phone number or social security number.
All
Size xs:integer
The maximum size of the data in bytes.
History xs:boolean
A value of true indicates that change records are kept on this field.
List-Id optional xs:integer
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.
Required xs:boolean
A value of true indicates an entity cannot be created without a value for this field.
System xs:boolean
A value of true indicates a field used by uncustomized installations of ALM. false indicates a user-defined field.
Type xs:string
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 xs:boolean
A value of true indicates that the field value must be an item in a list.
Virtual xs:boolean
A value of true indicates that the field does not have a physical representation in the database.
Active xs:boolean
A value of true indicates that the field can be displayed in the User Interface.
Visible xs:boolean
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.
Editable xs:boolean
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.
Filterable xs:boolean
A value of true indicates that the user can use the field for filtering and sorting.
Groupable xs:boolean
A value of true indicates that a user can group the results by values of this field.
VersionControlled xs:boolean
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.
SupportsMultivalue xs:boolean
Indicates whether the field can contain multiple values.
References optional
Links that use this field.

Attributes

NameTypeUseDefaultFixedDescription
Label required  The display label text. Do not use as field identifier. Can be localized.
Namexs:stringrequired  The field name.
PhysicalNamexs:stringrequired  The field name in the DB.
Maskxs:stringrequired  The field input mask, for example, phone number or social security number.

Source

<xs:element name="Field" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>
            Characteristics of an entity field.
            </xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:all>
      <xs:element ref="Size" />
      <xs:element ref="History" />
      <xs:element ref="List-Id" minOccurs="0" />
      <xs:element ref="Required" />
      <xs:element ref="System" />
      <xs:element ref="Type" />
      <xs:element ref="Verify" />
      <xs:element ref="Virtual" />
      <xs:element ref="Active" />
      <xs:element ref="Visible" />
      <xs:element ref="Editable" />
      <xs:element ref="Filterable" />
      <xs:element ref="Groupable" />
      <xs:element ref="VersionControlled" />
      <xs:element ref="SupportsMultivalue" />
      <xs:element ref="References" minOccurs="0" />
    </xs:all>
    <xs:attribute name="Label" use="required">
      <xs:annotation>
        <xs:documentation>
                     The display label text. Do not use as field identifier. Can be localized.
                    </xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="Name" type="xs:string" use="required">
      <xs:annotation>
        <xs:documentation>
                    The field name.
                    </xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="PhysicalName" type="xs:string" use="required">
      <xs:annotation>
        <xs:documentation>
                    The field name in the DB.
                    </xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="Mask" type="xs:string" use="required">
      <xs:annotation>
        <xs:documentation>
                    The field input mask, for example, phone number or social security number.
                     </xs:documentation>
      </xs:annotation>
    </xs:attribute>
  </xs:complexType>
</xs:element>

See Also