---
sourceDocument: Xanadu API Reference
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - en-US

ft:publication_title :

    - Xanadu API Reference

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# FieldReadConfiguration structure - iOS

# FieldReadConfiguration structure - iOS {#ariaid-title1}

* Release version: Xanadu
* 
* Updated August 1, 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 minutes to read

The FieldReadConfiguration structure enables you to configure which
fields to fetch from a ServiceNow instance table and in which format.  
{#FieldReadConfigurationiOSStruct__table_vx2_klw_5pb__entry__3}{#FieldReadConfigurationiOSStruct__mobile_sdk_ios-includeFields-entry}{#FieldReadConfigurationiOSStruct__mobile_sdk_ios-options-entry}

| Name | Type | Description |
|-|-|-|
| includeFields | Array | List of fields to pass back in the return results. |
| options | Array | List of the types of fields to return. Possible values: * actualValues: Returns the values actually stored in each of the fields, including the sys_ids for referenced records. Use this setting if dates need to be decoded in Codable models using Date. * description: Returns the description of the parameter. * displayValues: Returns the [display values](https://www.servicenow.com/docs/access?context=c_DisplayValues&version=xanadu&pubname=xanadu-platform-administration&ft:locale=en-US), if available, for the selected fields. For example, user names typically contain a reference link (sys_id) to the user record. If you request the display value, the person's name is returned instead of the sys_id that is stored in the associated field. Note: Display values returned by a ServiceNow instance are formatted and internationalized based on the user profile configuration of the authenticated user. This may differ from the device language and locale settings on the device. * excludeReferenceLink: Does not return any data that is defined as reference links within the table. * rawValue: Returns the raw value of the parameter. {#FieldReadConfigurationiOSStruct__ul_rml_dvr_xqb} |
[Table 1. Properties]

{#FieldReadConfigurationiOSStruct__table_vx2_klw_5pb}

## FieldReadConfiguration init(includeFields: \[FieldName\] = \[\], options: Options = \[\]) {#ariaid-title2}

Configures the fields within a record in a ServiceNow table to
pass back in the return results of a REST endpoint call.
{#FldReadConfig-init_A_A__table_b5w_5sp_kqb__entry__3}{#FldReadConfig-init_A_A__mobile_sdk_ios-includeFields-entry}{#FldReadConfig-init_A_A__mobile_sdk_ios-options-entry}

| Name | Type | Description |
|-|-|-|
| includeFields | Array | List of fields to pass back in the return results. |
| options | Array | List of the types of fields to return. Possible values: * actualValues: Returns the values actually stored in each of the fields, including the sys_ids for referenced records. Use this setting if dates need to be decoded in Codable models using Date. * description: Returns the description of the parameter. * displayValues: Returns the [display values](https://www.servicenow.com/docs/access?context=c_DisplayValues&version=xanadu&pubname=xanadu-platform-administration&ft:locale=en-US), if available, for the selected fields. For example, user names typically contain a reference link (sys_id) to the user record. If you request the display value, the person's name is returned instead of the sys_id that is stored in the associated field. Note: Display values returned by a ServiceNow instance are formatted and internationalized based on the user profile configuration of the authenticated user. This may differ from the device language and locale settings on the device. * excludeReferenceLink: Does not return any data that is defined as reference links within the table. * rawValue: Returns the raw value of the parameter. {#FldReadConfig-init_A_A__ul_rml_dvr_xqb} |
[Table 2. Parameters]

{#FldReadConfig-init_A_A__table_b5w_5sp_kqb} {#FldReadConfig-init_A_A__table_c5w_5sp_kqb__entry__2}

| Type | Description |
|-|-|
| None |   |
[Table 3. Returns]

{#FldReadConfig-init_A_A__table_c5w_5sp_kqb}  
The following code example shows how to call this function.

    /// The configuration for what to fetch from the Table API.
    lazy var fetchConfiguration: FetchConfiguration = {
      let includeFields = [
        // Case details
        "number",
        "short_description",
        "priority",
        "state",
        "opened_at",
                
        // Account details
        "account.name",
        "account.number",
        "contact.name",
        "contact.email",
        "contact_type",

        // Assignment
        "assignment_group.name",
        "assigned_to.name"
      ]
      let readConfiguration = FieldReadConfiguration(includeFields: includeFields, options: .actualValues)
      let filter = Filter(criteria: [], sortBy: [.desc("opened_at")], queryCategory: nil)
      return FetchConfiguration(filter: filter, limit: 10, readConfiguration: readConfiguration)
    }()