LeadAPIProcessUtilOOB – Bereichsbezogen

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 4 Minuten Lesedauer

    • Die LeadAPIProcessUtilOOB- Skripteinbindung stellt Methoden bereit, die von der Lead- REST-API aufgerufen werden, um Lead-Datensätze und die zugehörigen Lead-Positionselement-Datensätze abzurufen.

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

    Diese API wird im Namespace sn_lead_mgmt_core bereitgestellt. Für den Zugriff auf die API muss das Plugin „Lead Management Data Model“ (sn_lead_mgmt_core) in der Instanz aktiviert sein, und der aufrufende Benutzer muss über die Rolle sn_lead_mgmt_core.lead_integrator verfügen.

    Weitere Informationen zu Lead Managementfinden Sie unter Using Lead Management.

    LeadAPIProcessUtilOOB - processCreateLead (Objekt 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.

    Einzelheiten 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-Positionselement-Datensätze.

    Datentyp: Objekt

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

    Erfolgreiche Antwort: Alle Felder im angeforderten Lead-Datensatz und alle Felder in den zugehörigen Lead-Positionselement-Datensä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 der Skripteinbindung LeadAPIConstants definiert.

    Datentyp: Objekt
    <JSONobject>.status Antwortstatuscode.

    Diese Statuscodes sind in der Skripteinbindung LeadAPIConstants definiert.

    Datentyp: Zeichenfolge

    Das folgende Codebeispiel zeigt, wo Sie Ihren anwenderdefinierten Code für die Methode processCreateLead() in der Skripteinbindung LeadAPIProcessUtil hinzufügen.

    var LeadAPIProcessUtil = Class.create(); 

LeadAPIProcessUtil.prototype = Object.extendsObject(LeadAPIProcessUtilOOB, { 

// Define overriding functions here 

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

type: 'LeadAPIProcessUtil' 

});

    LeadAPIProcessUtilOOB – processGetAllLeads (Objekt queryParams, Zeichenfolge requestUrl)

    Ruft alle Lead-Datensätze und zugehörigen Einzelposten-Datensätze basierend auf den übergebenen Filterkriterien ab. Diese Methode gibt alle Felder innerhalb der zugeordneten Datensätze 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 im Endpunkt Lead: GET /sn_lead_mgmt_core/lead übergeben werden.
    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"]
}
    requestUrl Zeichenfolge Anforderungs-URL. Übergeben Sie diese URL, wenn Sie eine paginierte Antwort verarbeiten, damit die Methode über die Links zu allen Seiten in der Antwort verfügt.
    Tabelle : 4. Rückgaben
    Typ Beschreibung
    JSON-Objekt Details der angeforderten Lead- und Lead-Positionselement-Datensä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 die Parameter „text“ und „status“.
    <JSONobject>.body Antworttext.

    Erfolgreiche Antwort: Ein Array von Objekten, wobei jedes Objekt einen Lead-Datensatz und alle zugehörigen Lead-Positionselement-Datensätze enthält. Alle Felder innerhalb des angeforderten Lead-Datensatzes und alle Felder in den zugehörigen Datensätzen des Lead-Positionselements 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 der Skripteinbindung LeadAPIConstants definiert.

    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 Elemente 3 bis 5.

    Datentyp: Zeichenfolge
    <JSONobject>.links Im Falle einer paginierten Antwort durch Kommas getrennte Links zu jeder Seite, die in der Antwort enthalten ist.
    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 der Skripteinbindung LeadAPIConstants definiert.

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

    Datentyp: Zahl (Ganzzahl)

    Das folgende Codebeispiel zeigt, wo Sie Ihren anwenderdefinierten Code für die Methode processGetAllLeads() in der Skripteinbindung LeadAPIProcessUtil hinzufügen.

    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 innerhalb der zugeordneten Datensätze 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-Positionselement-Datensätze.

    Datentyp: Objekt

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

    Erfolgreiche Antwort: Alle Felder im angeforderten Lead-Datensatz und alle Felder in den zugehörigen Lead-Positionselement-Datensä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 der Skripteinbindung LeadAPIConstants definiert.

    Datentyp: Objekt
    <JSONobject>.status Antwortstatuscode.

    Diese Statuscodes sind in der Skripteinbindung LeadAPIConstants definiert.

    Datentyp: Zeichenfolge

    Das folgende Codebeispiel zeigt, wo Sie Ihren anwenderdefinierten Code für die Methode processGetLeadById() in der Skripteinbindung LeadAPIProcessUtil hinzufügen.

    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 Leads und die zugehörigen Felder des Lead-Positionselements, die aktualisiert werden sollen.

    Einzelheiten 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-Positionselement-Datensätze.

    Datentyp: Objekt

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

    Erfolgreiche Antwort: Alle Felder des aktualisierten Lead-Datensatzes und alle Felder in den zugehörigen Lead-Positionselement-Datensä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 der Skripteinbindung LeadAPIConstants definiert.

    Datentyp: Objekt
    <JSONobject>.status Antwortstatuscode.

    Diese Statuscodes sind in der Skripteinbindung LeadAPIConstants definiert.

    Datentyp: Zeichenfolge

    Das folgende Codebeispiel zeigt, wo Sie Ihren anwenderdefinierten Code für die Methode processUpdateLead() in der Skripteinbindung LeadAPIProcessUtil hinzufügen.

    var LeadAPIProcessUtil = Class.create();

LeadAPIProcessUtil.prototype = Object.extendsObject(LeadAPIProcessUtilOOB, {

// Define overriding functions here 

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

type: 'LeadAPIProcessUtil' 

});