LeadAPIProcessUtilOOB – Bereichsbezogen

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 4 Minuten Lesedauer

    • Die LeadAPIProcessUtilOOB Die Skripteinbindung stellt Methoden bereit, die von aufgerufen werden Lead REST-API zum Abrufen von Lead-Datensätzen und den zugehörigen Lead-Positionselementdatensätzen.

    Wenn Sie anpassen möchten, wie Lead-Datensätze abgerufen werden, wenn Lead-API Methoden werden aufgerufen. Überschreiben Sie die Methoden in dieser Skripteinbindung in LeadAPIProcessUtil Skripteinbindung. Die Namen der Methoden, die Sie in überschreiben LeadAPIProcessUtil Die Skripteinbindung muss mit denen in übereinstimmen LeadAPIProcessUtilOOB Skripteinbindungsdatei.

    Diese API wird in bereitgestellt sn_Lead_mgmt_Core Namespace. Um auf die API zuzugreifen, muss das Plugin „Lead-Management-Datenmodell“ (sn_Lead_mgmt_Core) in der Instanz aktiviert sein, und der aufrufende Anwender muss über die Rolle „sn_Lead_mgmt_Core.Lead_Integrator“ verfügen.

    Für zusätzliche Informationen zu Lead Management, Siehe Using Lead Management.

    LeadAPIProcessUtilOOB – processCreateLead (Object requestBody)

    Verarbeitet den Anforderungstext und erstellt basierend auf den übergebenen Parametern einen Lead und alle zugehörigen Einzelposten.

    Datensätze werden in die folgenden Tabellen eingefügt:
    • Lead [sn_Lead_mgmt_Core_Lead]
    • Lead-Positionselement [sn_Lead_mgmt_Core_Lead_line_item]
    Tabelle : 1. Parameter
    Name Typ Beschreibung
    requestBody Objekt Anforderungstext des Leads und der zugehörigen zu erstellenden Lead-Positionselemente.

    Weitere Informationen zum Inhalt dieses Objekts finden Sie unter Lead – POST /sn_Lead_mgmt_Core/Lead.
    Tabelle : 2. Rückgaben
    Typ Beschreibung
    JSON-Objekt Details der gespeicherten Lead- und Lead-Positionselementdatensätze.

    Datentyp: Objekt

    {
  "body": {Object},
  "status": "String"
}
    <JSONobject>.Textkörper Antworttext.

    Erfolgreiche Antwort: Alle Felder im angeforderten Lead-Datensatz und alle Felder in den zugehörigen Lead-Positionselementdatensätzen. Eine Beschreibung der zurückgegebenen Felder finden Sie unter Lead – POST /sn_Lead_mgmt_Core/Lead.

    Fehlerantwort: Liste der Fehler, die beim Versuch, die Anforderung zu verarbeiten, erkannt wurden. Diese Fehlermeldungen sind in definiert LeadAPIKonstanten Skripteinbindung.

    Datentyp: Objekt
    <JSONobject>.Status Antwortstatuscode.

    Diese Statuscodes sind in definiert LeadAPIKonstanten Skripteinbindung.

    Datentyp: Zeichenfolge

    Das folgende Codebeispiel zeigt, wo Sie Ihren anwenderdefinierten Code für hinzufügen können ProcessCreateLead() Methode in LeadAPIProcessUtil Skripteinbindung.

    var LeadAPIProcessUtil = Class.create(); 

LeadAPIProcessUtil.prototype = Object.extendsObject(LeadAPIProcessUtilOOB, { 

// Define overriding functions here 

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

type: 'LeadAPIProcessUtil' 

});

    LeadAPIProcessUtilOOB – processGetAllLeads (Object queryParams, String requestUrl)

    Ruft alle Lead-Datensätze und zugehörigen Einzelposten-Datensätze basierend auf den übergebenen Filterkriterien ab. Diese Methode gibt alle Felder in den zugehörigen Datensätzen zurück.

    Datensatzdetails werden aus den folgenden Tabellen abgerufen:
    • Lead [sn_Lead_mgmt_Core_Lead]
    • Lead-Positionselement [sn_Lead_mgmt_Core_Lead_line_item]
    Tabelle : 3. Parameter
    Name Typ Beschreibung
    queryParams Objekt Objekt mit den Abfrageparametern, die beim Abrufen der Lead-Datensätze angewendet werden sollen. Dies sind die Abfrageparameter, die in übergeben wurden Lead – GET /sn_Lead_mgmt_Core/Lead Endpunkt.
    Zum Beispiel: 
    {
  "sysparm_fields":["first_name,last_name,sys_id,lead_line_items"],
  "sysparm_query":["lead_type=new_business"],
  "sysparm_offset":["2"],"sysparm_limit":["25"]
}
    Anforderungs-Url Zeichenfolge Anforderungs-URL. Übergeben Sie diese URL, wenn Sie eine paginierte Antwort verarbeiten, damit die Methode Links zu allen Seiten in der Antwort enthält.
    Tabelle : 4. Rückgaben
    Typ Beschreibung
    JSON-Objekt Details der angeforderten Lead- und Lead-Positionselementdatensätze.

    Datentyp: Objekt

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

    Wenn bei der Verarbeitung der Anforderung ein Fehler auftritt, enthält das JSON-Objekt nur den Textkörper Und Status Parameter.
    <JSONobject>.Textkörper Antworttext.

    Erfolgreiche Antwort: Ein Array von Objekten mit jedem Objekt, das einen Lead-Datensatz und alle zugehörigen Lead-Positionselementdatensätze enthält. Alle Felder im angeforderten Lead-Datensatz und alle Felder in den zugehörigen Lead-Positionselementdatensätzen werden zurückgegeben. Eine Beschreibung der zurückgegebenen Felder finden Sie unter Lead – GET /sn_Lead_mgmt_Core/Lead.

    Fehlerantwort: Liste der Fehler, die beim Versuch, die Anforderung zu verarbeiten, erkannt wurden. Diese Fehlermeldungen sind in definiert LeadAPIKonstanten Skripteinbindung.

    Datentyp: Array von Objekten
    <JSONobject>.ContentRange Bereich des in einem paginierten Aufruf zurückgegebenen Inhalts.

    Beispiel: Wenn Offset=2 und Grenzwert=3, ist der Wert dieses Parameters die Elemente 3–5.

    Datentyp: Zeichenfolge
    <JSONobject>.Links Im Falle einer paginierten Antwort werden kommagetrennte Links zu jeder Seite in der Antwort angezeigt.
    Zum Beispiel:
    <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"

    Datentyp: Zeichenfolge
    <JSONobject>.Status Antwortstatuscode.

    Diese Statuscodes sind in definiert LeadAPIKonstanten Skripteinbindung.

    Datentyp: Zeichenfolge
    <JSONobject>.Gesamtanzahl Gesamtanzahl der von der Methode zurückgegebenen Lead-Datensätze.

    Datentyp: Zahl (Ganzzahl)

    Das folgende Codebeispiel zeigt, wo Sie Ihren anwenderdefinierten Code für hinzufügen können ProcessGetAllLeads() Methode in LeadAPIProcessUtil Skripteinbindung.

    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 (Zeichenfolgen-ID)

    Ruft den angegebenen Lead-Datensatz und die zugehörigen Einzelposten-Datensätze ab. Diese Methode gibt alle Felder in den zugehörigen Datensätzen zurück.

    Datensatzdetails werden aus den folgenden Tabellen abgerufen:
    • Lead [sn_Lead_mgmt_Core_Lead]
    • Lead-Positionselement [sn_Lead_mgmt_Core_Lead_line_item]
    Tabelle : 5. Parameter
    Name Typ Beschreibung
    id Zeichenfolge SYS_ID des abzurufenden Lead-Datensatzes.

    Tabelle: Lead [sn_Lead_mgmt_Core_Lead]
    Tabelle : 6. Rückgaben
    Typ Beschreibung
    JSON-Objekt Details der angeforderten Lead- und Lead-Positionselementdatensätze.

    Datentyp: Objekt

    {
  "body": {Object},
  "status": "String"
}
    <JSONobject>.Textkörper Antworttext.

    Erfolgreiche Antwort: Alle Felder im angeforderten Lead-Datensatz und alle Felder in den zugehörigen Lead-Positionselementdatensätzen. Eine Beschreibung der zurückgegebenen Felder finden Sie unter Lead – GET /sn_Lead_mgmt_Core/Lead/{sys_ID}.

    Fehlerantwort: Liste der Fehler, die beim Versuch, die Anforderung zu verarbeiten, erkannt wurden. Diese Fehlermeldungen sind in definiert LeadAPIKonstanten Skripteinbindung.

    Datentyp: Objekt
    <JSONobject>.Status Antwortstatuscode.

    Diese Statuscodes sind in definiert LeadAPIKonstanten Skripteinbindung.

    Datentyp: Zeichenfolge

    Das folgende Codebeispiel zeigt, wo Sie Ihren anwenderdefinierten Code für hinzufügen können ProcessGetLeadById() Methode in LeadAPIProcessUtil Skripteinbindung.

    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 (Objekt requestBody, Zeichenfolgen-ID)

    Verarbeitet den Anforderungstext und aktualisiert den angegebenen Lead und alle zugehörigen Einzelposten basierend auf den übergebenen Parametern.

    Datensätze werden in den folgenden Tabellen aktualisiert:
    • Lead [sn_Lead_mgmt_Core_Lead]
    • Lead-Positionselement [sn_Lead_mgmt_Core_Lead_line_item]
    Tabelle : 7. Parameter
    Name Typ Beschreibung
    requestBody Objekt Anforderungstext des Lead und der zugehörigen Felder für Lead-Positionselemente, die aktualisiert werden sollen.

    Weitere Informationen zum Inhalt dieses Objekts finden Sie unter Lead: PATCH /sn_Lead_mgmt_Core/Lead/{sys_ID}.
    id Zeichenfolge SYS_ID des zu aktualisierenden Lead-Datensatzes.

    Tabelle: Lead [sn_Lead_mgmt_Core_Lead]
    Tabelle : 8. Rückgaben
    Typ Beschreibung
    JSON-Objekt Details der gespeicherten Lead- und Lead-Positionselementdatensätze.

    Datentyp: Objekt

    {
  "body": {Object},
  "status": "String"
}
    <JSONobject>.Textkörper Antworttext.

    Erfolgreiche Antwort: Alle Felder des aktualisierten Lead-Datensatzes und alle Felder in den zugehörigen Lead-Positionselementdatensätzen (aktualisiert oder nicht). Eine Beschreibung der zurückgegebenen Felder finden Sie unter Lead: PATCH /sn_Lead_mgmt_Core/Lead/{sys_ID}.

    Fehlerantwort: Liste der Fehler, die beim Versuch, die Anforderung zu verarbeiten, erkannt wurden. Diese Fehlermeldungen sind in definiert LeadAPIKonstanten Skripteinbindung.

    Datentyp: Objekt
    <JSONobject>.Status Antwortstatuscode.

    Diese Statuscodes sind in definiert LeadAPIKonstanten Skripteinbindung.

    Datentyp: Zeichenfolge

    Das folgende Codebeispiel zeigt, wo Sie Ihren anwenderdefinierten Code für hinzufügen können ProcessUpdateLead() Methode in LeadAPIProcessUtil Skripteinbindung.

    var LeadAPIProcessUtil = Class.create();

LeadAPIProcessUtil.prototype = Object.extendsObject(LeadAPIProcessUtilOOB, {

// Define overriding functions here 

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

type: 'LeadAPIProcessUtil' 

});