Field

Description

The Field type holds the name and other information about a field in SBM. The field type parameters are listed below.

Parameters

Name	Type	Description
field	FieldIdentifier	Holds the identification information for a field.
fieldType	Field-Type	Describes the type of field.
attribute	integer	Indicates a field attribute. Used to describe types of text fields, numeric fields, date/time, and binary fields as described in the TS_FIELDS table in the Database Schema Reference guide.
properties	integer	Indicates field properties. Used to indicate read-only status, numeric field calculation settings, and whether or not to display field values as checkboxes as described in the TS_FIELDS table in the Database Schema Reference guide.

Usage

The Field type completely describes an available field in SBM. Use GetTables to retrieve a list of fields available for a specified table. The list of fields appears in the field element.

XML

The following XML snippet shows the Field type in the fieldList element of the GetTables response.

<ae:GetTablesResponse>
   <ae:return>
      <ae:table xsi:type="ae:TableIdentifier">
         <ae:displayName>Issues</ae:displayName>
         <ae:id>1000</ae:id>
         <ae:uuid>dc8cd329-b430-436f-bb75-bf90008e6a50</ae:uuid>
         <ae:dbName>UBG_ISSUES</ae:dbName>
      </ae:table>
      <ae:solution xsi:type="ae:SolutionIdentifier">
         <ae:displayName>Issue Defect Management</ae:displayName>
         <ae:id>1</ae:id>
         <ae:uuid>cea0a86c-5d74-4e12-b8d6-9d6b90186f1e</ae:uuid>
         <ae:uniqueName>ISSUE_DEFECT_MANAGEMENT</ae:uniqueName>
         <ae:tabName>IDM</ae:tabName>
      </ae:solution>
      <ae:type>PRIMARY-TABLE</ae:type>
      <ae:description/>
      <ae:field>
         <ae:field xsi:type="ae:FieldIdentifier">
            <ae:displayName>Type</ae:displayName>
            <ae:id>52</ae:id>
            <ae:uuid>7718fd10-ff7a-4fc9-9f8e-581820cb77bf</ae:uuid>
            <ae:dbName>ISSUETYPE</ae:dbName>
         </ae:field>
         <ae:fieldType>FLDTYPE-SELECTION</ae:fieldType>
         <ae:attribute>0</ae:attribute>
         <ae:properties>0</ae:properties>
      </ae:field>         
   </ae:return>
</ae:GetTablesResponse>