Structure FieldReadConfiguration : iOS

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 2 minutes de lecture
  • La structure FieldReadConfiguration vous permet de configurer les champs à extraire d’une table d’instance ServiceNow et dans quel format.

    Tableau 1. Propriétés
    Nom Type Description
    includeFields (en anglais seulement) Tableau Liste des champs à retransmettre dans les résultats renvoyés.
    options Tableau Liste des types de champs à renvoyer.
    Valeurs possibles :
    • actualValues : renvoie les valeurs réellement stockées dans chacun des champs, y compris les sys_ids des enregistrements référencés. Utilisez ce paramètre si les dates doivent être décodées dans des modèles codables à l’aide de la date.
    • description : renvoie la description du paramètre.
    • displayValues : renvoie les valeurs d’affichage des valeurs d’affichage, le cas échéant, pour les champs sélectionnés. Par exemple, les noms d’utilisateurs contiennent généralement un lien de référence (sys_id) vers l’enregistrement utilisateur. Si vous demandez la valeur d’affichage, le nom de la personne est renvoyé à la place du sys_id qui est stocké dans le champ associé.
      Remarque :
      Les valeurs d’affichage renvoyées par une ServiceNow instance sont formatées et internationalisées en fonction de la configuration du profil d’utilisateur de l’utilisateur authentifié. Cela peut différer des paramètres de langue et de paramètres régionaux de l’appareil.
    • excludeReferenceLink : ne renvoie aucune donnée définie comme des liens de référence dans la table.
    • rawValue : renvoie la valeur brute du paramètre.

    FieldReadConfiguration init(includeFields : [FieldName] = [], options : Options = [])

    Configure les champs d’un enregistrement d’une ServiceNow table pour transmettre les résultats renvoyés d’un appel de point de terminaison REST.

    Tableau 2. Paramètres
    Nom Type Description
    includeFields (en anglais seulement) Tableau Liste des champs à retransmettre dans les résultats renvoyés.
    options Tableau Liste des types de champs à renvoyer.
    Valeurs possibles :
    • actualValues : renvoie les valeurs réellement stockées dans chacun des champs, y compris les sys_ids des enregistrements référencés. Utilisez ce paramètre si les dates doivent être décodées dans des modèles codables à l’aide de la date.
    • description : renvoie la description du paramètre.
    • displayValues : renvoie les valeurs d’affichage des valeurs d’affichage, le cas échéant, pour les champs sélectionnés. Par exemple, les noms d’utilisateurs contiennent généralement un lien de référence (sys_id) vers l’enregistrement utilisateur. Si vous demandez la valeur d’affichage, le nom de la personne est renvoyé à la place du sys_id qui est stocké dans le champ associé.
      Remarque :
      Les valeurs d’affichage renvoyées par une ServiceNow instance sont formatées et internationalisées en fonction de la configuration du profil d’utilisateur de l’utilisateur authentifié. Cela peut différer des paramètres de langue et de paramètres régionaux de l’appareil.
    • excludeReferenceLink : ne renvoie aucune donnée définie comme des liens de référence dans la table.
    • rawValue : renvoie la valeur brute du paramètre.
    Tableau 3. Renvoie
    Type Description
    Aucun

    L’exemple de code suivant montre comment appeler cette fonction.

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