LeadAPIValidationUtilOOB : dans le champ d’application

  • Rversion finale: Zurich
  • Mis à jour 31 juil. 2025
  • 3 minutes de lecture

    • L’include de script LeadAPIValidationUtilOOB fournit des méthodes appelées par l’API REST de prospect pour valider les enregistrements de pistes et les enregistrements d’éléments de ligne de pistes associés lorsqu’ils sont créés (POST) ou mis à jour (PATCH).

    Si vous souhaitez personnaliser la façon dont les enregistrements de pistes sont validés lorsque les API de piste méthodes sont appelées, remplacez les méthodes de cet include de script dans l’include de script LeadAPIValidationUtil . Les noms des méthodes que vous remplacez dans l’include de script LeadAPIValidationUtil doivent être les mêmes que ceux du fichier d’include de script LeadAPIValidationUtilOOB .

    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 leadsUsing Lead Management.

    LeadAPIValidationUtilOOB : validateLeadObjectForPatchCall (objet leadObject)

    Valide les champs transmis pour une piste spécifiée et ses éléments de ligne associés lors de la mise à jour d’un enregistrement de piste à l’aide du point de terminaison PATCH de l’API de piste .

    Cette méthode est déclenchée par la méthode processUpdateLead() dans l’include de script LeadAPIValidationUtilOOB . Cette méthode effectue diverses validations, telles que :
    • Vérifie les champs obligatoires
    • Vérifie que le numéro de téléphone et l’adresse e-mail ont le format approprié.
    • Vérifie les champs de choix et de référence, en ignorant les valeurs non valides.
    • Valide l’étape et génère une erreur si l’utilisateur tente de qualifier une piste.
    Tableau 1. Paramètres
    Nom Type Description
    Objet principal Objet Champs à mettre à jour dans l’enregistrement de piste spécifié et les enregistrements d’éléments de ligne de piste associés. Pour obtenir la liste des champs transmissibles et des exigences associées, reportez-vous à la section responsable : correctif /sn_lead_mgmt_core/lead/{sys_id}.
    Tableau 2. Renvoie
    Type Description
    <objet JSON> Résultats de la validation.
    {
  "errors": [Array],
  "indexesOfleadLineItemsForInsertion": [Array] 
}
    <objet JSON>.errors Détails des erreurs détectées lors de la validation de la piste et de l’objet d’élément de ligne de piste réussis. Renvoie un tableau vide si aucune erreur n’est détectée.
    Par exemple :
    [
  {"email":"Invalid email address."},
  {"last_name":"Mandatory field is either missing or invalid."},
  {"lead_line_items[0]/product_offering":"Mandatory field is either missing or invalid."}
]

    Ces messages d’erreur se trouvent dans l’include de script LeadAPIConstantsOOB .

    Type de données : tableau d’objets
    <objet JSON>.indexesOfleadLineItemsForInsertion Index des nouveaux éléments de ligne de piste qui doivent être insérés dans leadObject.

    Type de données : tableau de nombres entiers

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

    var LeadAPIValidationUtil = Class.create(); 

LeadAPIValidationUtil.prototype = Object.extendsObject(LeadAPIValidationUtilOOB, { 

// Define overriding functions here

validateLeadObjectForPatchCall: function(leadObject) { 
// Add your custom code here
}, 

type: 'LeadAPIValidationUtil' 

});

    LeadAPIValidationUtilOOB : validateLeadObjectForPostCall (objet leadObject)

    Valide les champs transmis pour une piste spécifiée et ses éléments de ligne associés lors de la création d’un enregistrement de piste à l’aide du point de terminaison POST de l’API de prospect .

    Cette méthode est déclenchée par la méthode processCreateLead() dans l’include de script LeadAPIValidationUtilOOB . Cette méthode effectue diverses validations, telles que :
    • Recherche les champs obligatoires.
    • Vérifie que le numéro de téléphone et l’adresse e-mail ont le format approprié.
    • Vérifie les champs de choix et de référence, en ignorant les valeurs non valides.
    Tableau 3. Paramètres
    Nom Type Description
    Objet principal Objet Champs à insérer dans le nouvel enregistrement de piste et les enregistrements d’éléments de ligne de piste associés. Pour obtenir la liste des champs transmissibles et des exigences associées, reportez-vous à la section piste : POST /sn_lead_mgmt_core/lead.
    Tableau 4. Renvoie
    Type Description
    Tableau Détails des erreurs détectées lors de la validation de la piste et de l’objet d’élément de ligne de piste réussis. Renvoie un tableau vide si aucune erreur n’est détectée.
    Par exemple :
    [
  {"email":"Invalid email address."},
  {"last_name":"Mandatory field is either missing or invalid."},
  {"lead_line_items[0]/product_offering":"Mandatory field is either missing or invalid."}
]

    Ces messages d’erreur se trouvent dans l’include de script LeadAPIConstantsOOB .

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

    var LeadAPIValidationUtil = Class.create(); 

LeadAPIValidationUtil.prototype = Object.extendsObject(LeadAPIValidationUtilOOB, { 

// Define overriding functions here 

validateLeadObjectForPostCall: function(leadObject) { 
// Add your custom code
}, 

type: 'LeadAPIValidationUtil' 

});