Estrutura FieldReadConfiguration - iOS

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 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.

    Tabela 1. Propriedades
    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 valoresde exibição, 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.

    FieldReadConfiguration init(includeFields: [FieldName] = [], opções: Opções = [])

    Configura os campos em um registro em uma tabela ServiceNow para passar de volta os resultados de retorno de uma chamada de endpoint REST.

    Tabela 2. Parâmetros
    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 valoresde exibição, 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.
    Tabela 3. Retorna
    Tipo Descrição
    Nenhum(a)

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