---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Estrutura FieldReadConfiguration - iOS

# Estrutura FieldReadConfiguration - iOS {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 min. de leitura

A estrutura FieldReadConfiguration permite que você configure quais campos buscar de uma tabela de instância ServiceNow e em qual formato.  
{#FieldReadConfigurationiOSStruct__table_vx2_klw_5pb__entry__3}{#FieldReadConfigurationiOSStruct__mobile_sdk_ios-includeFields-entry}{#FieldReadConfigurationiOSStruct__mobile_sdk_ios-options-entry}

| Nome | Tipo | Descrição |
|-|-|-|
| includeFields | Matriz | Lista de campos a serem retornados nos resultados de retorno. |
| opções | Matriz | Lista dos tipos de campos a serem retornados. Valores possíveis: * actualValues: retorna os valores realmente armazenados em cada um dos campos, incluindo os sys_ids dos registros referenciados. Use esta configuração se as datas precisarem ser decodificadas em modelos codáveis usando data. * description: retorna a descrição do parâmetro. * displayValues: retorna os [valores](https://www.servicenow.com/docs/access?context=c_DisplayValues&version=xanadu&pubname=xanadu-platform-administration&ft:locale=en-US)[de exibição](https://www.servicenow.com/docs/access?context=c_DisplayValues&version=xanadu&pubname=xanadu-platform-administration&ft:locale=en-US), se disponíveis, para os campos selecionados. Por exemplo, os nomes de usuário normalmente contêm um link de referência (sys_id) para o registro do usuário. Se você solicitar o valor de exibição, o nome da pessoa será retornado em vez do sys_id que está armazenado no campo associado. Nota: Os valores de exibição retornados por uma instância ServiceNow são formatados e internacionalizados com base na configuração do perfil do usuário autenticado. Isso pode ser diferente das configurações de idioma e localidade do dispositivo. * excludeReferenceLink: não retorna nenhum dado definido como links de referência na tabela. * RAWValue: retorna o valor bruto do parâmetro. {#FieldReadConfigurationiOSStruct__ul_rml_dvr_xqb} |
[Tabela 1. Propriedades]

{#FieldReadConfigurationiOSStruct__table_vx2_klw_5pb}

## FieldReadConfiguration init(includeFields: \[FieldName\] = \[\], opções: Opções = \[\]) {#ariaid-title2}

Configura os campos em um registro em uma tabela ServiceNow para passar de volta os resultados de retorno de uma chamada de endpoint REST.
{#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}

| Nome | Tipo | Descrição |
|-|-|-|
| includeFields | Matriz | Lista de campos a serem retornados nos resultados de retorno. |
| opções | Matriz | Lista dos tipos de campos a serem retornados. Valores possíveis: * actualValues: retorna os valores realmente armazenados em cada um dos campos, incluindo os sys_ids dos registros referenciados. Use esta configuração se as datas precisarem ser decodificadas em modelos codáveis usando data. * description: retorna a descrição do parâmetro. * displayValues: retorna os [valores](https://www.servicenow.com/docs/access?context=c_DisplayValues&version=xanadu&pubname=xanadu-platform-administration&ft:locale=en-US)[de exibição](https://www.servicenow.com/docs/access?context=c_DisplayValues&version=xanadu&pubname=xanadu-platform-administration&ft:locale=en-US), se disponíveis, para os campos selecionados. Por exemplo, os nomes de usuário normalmente contêm um link de referência (sys_id) para o registro do usuário. Se você solicitar o valor de exibição, o nome da pessoa será retornado em vez do sys_id que está armazenado no campo associado. Nota: Os valores de exibição retornados por uma instância ServiceNow são formatados e internacionalizados com base na configuração do perfil do usuário autenticado. Isso pode ser diferente das configurações de idioma e localidade do dispositivo. * excludeReferenceLink: não retorna nenhum dado definido como links de referência na tabela. * RAWValue: retorna o valor bruto do parâmetro. {#FldReadConfig-init_A_A__ul_rml_dvr_xqb} |
[Tabela 2. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 3. Retorna]

{#FldReadConfig-init_A_A__table_c5w_5sp_kqb}  
O exemplo de código a seguir mostra como chamar esta função.

    /// 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)
    }()