LeadAPIProcessUtilOOB : dans le champ d’application

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

    • L’include de script LeadAPIProcessUtilOOB fournit des méthodes appelées par l’API REST de prospect pour récupérer les enregistrements de piste et leurs enregistrements d’élément de ligne de piste associés.

    Si vous souhaitez personnaliser la façon dont les enregistrements de pistes sont récupéré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 LeadAPIProcessUtil . Les noms des méthodes que vous remplacez dans l’include de script LeadAPIProcessUtil doivent être les mêmes que ceux du fichier d’include de script LeadAPIProcessUtilOOB .

    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.

    LeadAPIProcessUtilOOB : processCreateLead (objet requestBody)

    Traite le corps de la demande et crée une piste et tous ses éléments de ligne associés, en fonction des paramètres transmis.

    Les enregistrements sont insérés dans les tables suivantes :
    • Piste [sn_lead_mgmt_core_lead]
    • Élément de ligne de la piste [sn_lead_mgmt_core_lead_line_item]
    Tableau 1. Paramètres
    Nom Type Description
    requestBody Objet Corps de la demande de la piste et de ses éléments de ligne de piste connexes à créer.

    Pour plus d’informations sur le contenu de cet objet, reportez-vous à la section piste : POST /sn_lead_mgmt_core/lead.
    Tableau 2. Renvoie
    Type Description
    Objet JSON Détails des enregistrements de piste et d’élément de ligne de piste enregistrés.

    Type de données : objet

    {
  "body": {Object},
  "status": "String"
}
    <JSONobject>.body Corps de la réponse.

    Réponse réussie : tous les champs de l’enregistrement de piste demandé et tous les champs des enregistrements d’éléments de ligne de piste associés. Pour obtenir une description des champs renvoyés, reportez-vous à .piste : POST /sn_lead_mgmt_core/lead

    Réponse d’erreur : liste des erreurs détectées lors de la tentative de traitement de la demande. Ces messages d’erreur sont définis dans l’include de script LeadAPIConstants .

    Type de données : objet
    <JSONobject>.status Code d’état de la réponse.

    Ces codes d’état sont définis dans l’include de script LeadAPIConstants .

    Type de données : chaîne

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

    var LeadAPIProcessUtil = Class.create(); 

LeadAPIProcessUtil.prototype = Object.extendsObject(LeadAPIProcessUtilOOB, { 

// Define overriding functions here 

processCreateLead: function(requestBody) { 
// Add your custom code 
}, 

type: 'LeadAPIProcessUtil' 

});

    LeadAPIProcessUtilOOB : processGetAllLeads (objet queryParams, chaîne requestUrl)

    Récupère tous les enregistrements de pistes et les enregistrements d’éléments de ligne associés en fonction des critères de filtre transmis. Cette méthode renvoie tous les champs dans les enregistrements associés.

    Les détails de l’enregistrement sont extraits des tables suivantes :
    • Piste [sn_lead_mgmt_core_lead]
    • Élément de ligne de la piste [sn_lead_mgmt_core_lead_line_item]
    Tableau 3. Paramètres
    Nom Type Description
    queryParams Objet Objet contenant les paramètres de requête à appliquer lors de la récupération des enregistrements de pistes. Il s’agit des paramètres de requête transmis au point de piste : GET /sn_lead_mgmt_core/lead terminaison.
    Par exemple : 
    {
  "sysparm_fields":["first_name,last_name,sys_id,lead_line_items"],
  "sysparm_query":["lead_type=new_business"],
  "sysparm_offset":["2"],"sysparm_limit":["25"]
}
    requestUrl Chaîne URL de la demande. Transmettez cette URL lorsque vous traitez une réponse paginée afin que la méthode ait les liens vers toutes les pages de la réponse.
    Tableau 4. Renvoie
    Type Description
    Objet JSON Détails des enregistrements de piste et d’élément de ligne de piste demandés.

    Type de données : objet

    {
  "body": [Array],
  "contentRange": "String",
  "links": "String", 
  "status": "String",
  "totalCount": "Number" 
}

    Si une erreur se produit lors du traitement de la demande, l’objet JSON ne contient que les paramètres de corps et d’état .
    <JSONobject>.body Corps de la réponse.

    Réponse réussie : tableau d’objets contenant chacun un enregistrement de piste et tous les enregistrements d’éléments de ligne de piste associés. Tous les champs de l’enregistrement de piste demandé et tous les champs des enregistrements d’éléments de ligne de piste associés sont renvoyés. Pour obtenir une description des champs renvoyés, reportez-vous à .piste : GET /sn_lead_mgmt_core/lead

    Réponse d’erreur : liste des erreurs détectées lors de la tentative de traitement de la demande. Ces messages d’erreur sont définis dans l’include de script LeadAPIConstants .

    Type de données : tableau d’objets
    <JSONobject>.contentRange Plage du contenu renvoyé dans un appel paginé.

    Par exemple : Si décalage=2 et limit=3, la valeur de ce paramètre est les éléments 3-5.

    Type de données : chaîne
    <JSONobject>.links Dans le cas d’une réponse paginée, liens séparés par des virgules vers chaque page contenue dans la réponse.
    Par exemple :
    <https://servicenow-instance/api/sn_lead_mgmt_core/lead?sysparm_offset=0&sysparm_limit=20>;rel="self",
<https://servicenow-instance/api/sn_lead_mgmt_core/lead?sysparm_offset=20&sysparm_limit=20>;rel="last",
<https://servicenow-instance/api/sn_lead_mgmt_core/lead?sysparm_offset=20&sysparm_limit=20>;rel="next"

    Type de données : chaîne
    <JSONobject>.status Code d’état de la réponse.

    Ces codes d’état sont définis dans l’include de script LeadAPIConstants .

    Type de données : chaîne
    <JSONobject>.totalCount Nombre total d’enregistrements de piste renvoyés par la méthode.

    Type de données : nombre (entier)

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

    var LeadAPIProcessUtil = Class.create(); 

LeadAPIProcessUtil.prototype = Object.extendsObject(LeadAPIProcessUtilOOB, { 

// Define overriding functions here 

processGetAllLeads: function(queryParams, requestUrl) { 
// Add your custom code here 
}, 

type: 'LeadAPIProcessUtil' 
});

    LeadAPIProcessUtilOOB : processGetLeadById (ID de chaîne)

    Récupère l’enregistrement de prospect spécifié et ses enregistrements d’éléments de ligne associés. Cette méthode renvoie tous les champs dans les enregistrements associés.

    Les détails de l’enregistrement sont extraits des tables suivantes :
    • Piste [sn_lead_mgmt_core_lead]
    • Élément de ligne de la piste [sn_lead_mgmt_core_lead_line_item]
    Tableau 5. Paramètres
    Nom Type Description
    id Chaîne Sys_id de l’enregistrement de piste à récupérer.

    Table : piste [sn_lead_mgmt_core_lead]
    Tableau 6. Renvoie
    Type Description
    Objet JSON Détails des enregistrements de piste et d’élément de ligne de piste demandés.

    Type de données : objet

    {
  "body": {Object},
  "status": "String"
}
    <JSONobject>.body Corps de la réponse.

    Réponse réussie : tous les champs de l’enregistrement de piste demandé et tous les champs des enregistrements d’éléments de ligne de piste associés. Pour obtenir une description des champs renvoyés, reportez-vous à .piste : GET /sn_lead_mgmt_core/lead/{sys_id}

    Réponse d’erreur : liste des erreurs détectées lors de la tentative de traitement de la demande. Ces messages d’erreur sont définis dans l’include de script LeadAPIConstants .

    Type de données : objet
    <JSONobject>.status Code d’état de la réponse.

    Ces codes d’état sont définis dans l’include de script LeadAPIConstants .

    Type de données : chaîne

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

    var LeadAPIProcessUtil = Class.create(); 

LeadAPIProcessUtil.prototype = Object.extendsObject(LeadAPIProcessUtilOOB, { 

// Define overriding functions here

processGetLeadById: function(id) { 
  // Add your custom code here
}, 

type: 'LeadAPIProcessUtil' 

});

    LeadAPIProcessUtilOOB : processUpdateLead (objet requestBody, ID de chaîne)

    Traite le corps de la demande et met à jour la piste spécifiée et tous ses éléments de ligne associés, en fonction des paramètres transmis.

    Les enregistrements sont mis à jour dans les tables suivantes :
    • Piste [sn_lead_mgmt_core_lead]
    • Élément de ligne de la piste [sn_lead_mgmt_core_lead_line_item]
    Tableau 7. Paramètres
    Nom Type Description
    requestBody Objet Corps de la demande du prospect et de ses champs d’élément de ligne de piste connexes à mettre à jour.

    Pour plus d’informations sur le contenu de cet objet, reportez-vous à la section responsable : correctif /sn_lead_mgmt_core/lead/{sys_id}.
    id Chaîne Sys_id de l’enregistrement de piste à mettre à jour.

    Table : piste [sn_lead_mgmt_core_lead]
    Tableau 8. Renvoie
    Type Description
    Objet JSON Détails des enregistrements de piste et d’élément de ligne de piste enregistrés.

    Type de données : objet

    {
  "body": {Object},
  "status": "String"
}
    <JSONobject>.body Corps de la réponse.

    Réponse réussie : tous les champs de l’enregistrement de piste mis à jour et tous les champs des enregistrements d’éléments de ligne de piste associés (mis à jour ou non). Pour obtenir une description des champs renvoyés, reportez-vous à .responsable : correctif /sn_lead_mgmt_core/lead/{sys_id}

    Réponse d’erreur : liste des erreurs détectées lors de la tentative de traitement de la demande. Ces messages d’erreur sont définis dans l’include de script LeadAPIConstants .

    Type de données : objet
    <JSONobject>.status Code d’état de la réponse.

    Ces codes d’état sont définis dans l’include de script LeadAPIConstants .

    Type de données : chaîne

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

    var LeadAPIProcessUtil = Class.create();

LeadAPIProcessUtil.prototype = Object.extendsObject(LeadAPIProcessUtilOOB, {

// Define overriding functions here 

processUpdateLead: function(requestBody, id) { 
// Add your custom code here
},

type: 'LeadAPIProcessUtil' 

});