LeadAPIHelperOOB : dans le champ d’application

  • Rversion finale: Yokohama
  • Mis à jour 30 janv. 2025
  • 4 minutes de lecture

    • L’include de script LeadAPIHelperOOB fournit des méthodes d’assistance appelées par l’API REST principale pour exécuter diverses fonctions, telles que la conversion d’un ensemble d’enregistrements de piste à partir d’un objet GlideRecord en un tableau JSON ou un objet JSON et la transformation de champs au sein d’un objet de piste.

    Si vous souhaitez personnaliser ces fonctions d’assistance, remplacez les méthodes de cet include de script dans l’include de script LeadAPIHelper . Les noms des méthodes que vous remplacez dans l’include de script LeadAPIHelper doivent être les mêmes que ceux du fichier d’include de script LeadAPIHelperOOB .

    Cette API est fournie dans l’espace de noms sn_lead_mgmt_core . Pour accéder à l’API, le module d’extension Lead Management Data Model (sn_lead_mgmt_core) doit être activé sur l’instance et l’utilisateur appelant doit disposer du rôle sn_lead_mgmt_core.lead_integrator.

    Pour plus d’informations sur , reportez-vous à Gestion des pistesUsing Lead Management.

    LeadAPIHelperOOB : getJSONFromGR(GlideRecord gr, champs de tableau)

    Convertit un objet GlideRecord en objet JSON. Cette méthode itère sur les champs du GlideRecord, vérifie leurs types et formate correctement leurs valeurs dans une structure compatible JSON.

    Tableau 1. Paramètres
    Nom Type Description
    gr GlideRecord Objet GlideRecord à convertir en objet JSON.
    champs Tableau Facultatif. Noms de champs séparés par des virgules à inclure dans l’objet JSON. Ces noms doivent correspondre exactement aux noms figurant dans l’enregistrement de piste.
    Par exemple : ["account », « first_name », « do_not_call », « lead_line_items"]
    Remarque :

    Si le fields paramètre est nul ou contient la valeur « lead_line_items », la méthode récupère chaque enregistrement d’élément de ligne associé, y compris tous les champs de l’élément de ligne.

    Cette méthode ne prend en charge que la conversion de champs individuels à partir de la table Piste [sn_lead_mgmt_core_lead], et non de la table Élément de ligne principal [sn_lead_mgmt_core_lead_line_item]. Si vous spécifiez un champ spécifique à partir de la table Élément de ligne de piste, il est ignoré.

    Par défaut : tous les champs d’enregistrement de piste sont inclus dans l’objet JSON.
    Tableau 2. Renvoie
    Type Description
    Objet JSON Objet JSON qui contient les champs du GlideRecord spécifié.

    Chaque champ de GlideRecord est converti en paire clé-valeur. Une gestion spéciale est appliquée aux champs de référence, de choix, de date et d’heure et à d’autres types de données spécifiques afin de s’assurer qu’ils sont correctement formatés.

    L’exemple de code suivant montre où ajouter votre code personnalisé pour la méthode getJsonFromGR() dans l’include de script LeadAPIHelper .

    var LeadAPIHelper = Class.create(); 
LeadAPIHelper.prototype = Object.extendsObject(LeadAPIHelperOOB, {

// Define overriding functions here
getJSONFromGR: function(gr, fields) {

// Add your custom code here
},

type: 'LeadAPIHelper'
});

    LeadAPIHelperOOB : getLeadsJSON (GlideRecord leadsGr, champs de tableau)

    Convertit un ensemble d’enregistrements de piste à partir d’un objet GlideRecord en tableau JSON. Vous devez spécifier les champs d’enregistrement de piste que vous souhaitez inclure dans le tableau JSON.

    Tableau 3. Paramètres
    Nom Type Description
    leadsGr GlideRecord Objet GlideRecord contenant les enregistrements principaux à convertir au format JSON.

    Table : Responsable [sn_lead_mgmt-core_lead]
    champs Tableau Noms de champs séparés par des virgules à inclure dans l’objet JSON. Ces noms doivent correspondre exactement aux noms figurant dans l’enregistrement de piste.
    Par exemple : ["account », « first_name », « do_not_call », « lead_line_items"]
    Remarque :

    Si le fields paramètre est nul ou contient la valeur « lead_line_items », la méthode récupère chaque enregistrement d’élément de ligne associé, y compris tous les champs de l’élément de ligne.

    Cette méthode ne prend en charge que la conversion de champs individuels à partir de la table Piste [sn_lead_mgmt_core_lead], et non de la table Élément de ligne principal [sn_lead_mgmt_core_lead_line_item]. Si vous spécifiez un champ spécifique à partir de la table Élément de ligne de piste, il est ignoré.
    Tableau 4. Renvoie
    Type Description
    Tableau d’objets JSON Chaque objet représente une piste contenant les champs spécifiés. Le cas échéant, il comprend également un tableau d’objets d’élément de ligne de piste pour chaque piste.

    Chaque champ de GlideRecord est converti en paire clé-valeur. Une gestion spéciale est appliquée aux champs de référence, de choix, de date et d’heure et à d’autres types de données spécifiques afin de s’assurer qu’ils sont correctement formatés.

    L’exemple de code suivant montre où ajouter votre code personnalisé pour la méthode getLeadsJson() dans l’include de script LeadAPIHelper .

    var LeadAPIHelper = Class.create();
LeadAPIHelper.prototype = Object.extendsObject(LeadAPIHelperOOB, { 

// Define overriding functions here 
getLeadsJson: function(leadsGR, fields) {

// Add your custom code here
}, 

type: 'LeadAPIHelper' 
});

    LeadAPIHelperOOB : getTransformedLeadObject(Objet leadObject)

    Transforme l’objet de piste spécifié.

    Cette transformation comprend :
    • Suppression des champs ignorés.
    • Conversion des champs de référence en leurs valeurs associées, telles qu’un sys_id.
    • Combinaison de textes de notes de travail en une chaîne séparée par des virgules.
    • Validation des champs compte, contact et consommateur. Les valeurs compte, contact et consommateur sont ignorées si le compte et le consommateur contiennent tous les deux des valeurs.
    Tableau 5. Paramètres
    Nom Type Description
    Objet principal Objet Objet de piste à transformer. Cet objet contient les détails de la piste et de ses éléments de ligne de piste connexes.
    Tableau 6. Renvoie
    Type Description
    Objet Objet de piste transformé.

    L’exemple de code suivant montre où ajouter votre code personnalisé pour la méthode getTransformedLeadObject() dans l’include de script LeadAPIHelper .

    var LeadAPIHelper = Class.create();

LeadAPIHelper.prototype = Object.extendsObject(LeadAPIHelperOOB, {

// Define overriding functions here 
getTransformedLeadObject: function(leadObject) { 

// Add your custom code here
}, 

type: 'LeadAPIHelper'
});