---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# LeadAPIProcessUtilOOB -- Bereichsbezogen

# LeadAPIProcessUtilOOB -- Bereichsbezogen {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 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](https://servicenow-prod.fluidtopics.net/bsaLfSMgvToNREd~Bkp16A#lead-api "Die Lead Die API bietet Endpunkte, mit denen Sie Marketing-Leads und die zugehörigen Lead-Positionselemente aus einer Instanz erstellen, aktualisieren und abfragen/abrufen können.")Methoden werden aufgerufen. Überschreiben die Methoden in dieser Skripteinbindung in LeadAPIProzessUtil Skripteinbindung. Die Namen der Methoden, die Sie in überschreiben LeadAPIProzessUtil 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 sn_lead_mgmt_core.lead_integrator-Rolle verfügen.

Für zusätzliche Informationen zu Lead Management, Siehe [Using Lead Management](https://www.servicenow.com/docs/access?context=lead-management-using&version=yokohama&pubname=yokohama-order-management&ft:locale=en-US).

## LeadAPIProcessUtilOOB -- processCreateLead (Object requestBody) {#ariaid-title2}

Verarbeitet den Anforderungstext und erstellt einen Lead und alle zugehörigen Einzelposten basierend auf den übergebenen Parametern.
Datensätze werden in die folgenden Tabellen eingefügt:

* Lead \[sn_lead_mgmt_core_lead\]
* Lead-Positionselement \[sn_lead_mgmt_core_lead_line_item\]
{#LAPU-processCreateLead_O__table_sxx_crr_ydc__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| requestBody | Objekt | Anforderungstext des Leads und der zugehörigen zu erstellenden Lead-Positionselemente. Details zum Inhalt dieses Objekts finden Sie unter [Lead -- POSTEN /sn_lead_mgmt_core/Lead](https://servicenow-prod.fluidtopics.net/bsaLfSMgvToNREd~Bkp16A#lead-POST-lead "Erstellt einen Lead-Datensatz und die zugehörigen Lead-Positionselemente mit den angegebenen Parametern."). |
[Tabelle : 1. Parameter]

{#LAPU-processCreateLead_O__table_sxx_crr_ydc} {#LAPU-processCreateLead_O__table_txx_crr_ydc__entry__2}

| 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 -- POSTEN /sn_lead_mgmt_core/Lead](https://servicenow-prod.fluidtopics.net/bsaLfSMgvToNREd~Bkp16A#lead-POST-lead "Erstellt einen Lead-Datensatz und die zugehörigen Lead-Positionselemente mit den angegebenen Parametern."). 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 |
[Tabelle : 2. Rückgaben]

{#LAPU-processCreateLead_O__table_txx_crr_ydc}  
Das folgende Codebeispiel zeigt, wo Sie Ihren anwenderdefinierten Code für hinzufügen können ProcessCreateLead() Methode in LeadAPIProzessUtil 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) {#ariaid-title3}

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\]
{#LAPU-processGetAllLeads_O_S__table_igt_klr_ydc__entry__3}

| 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 werden [Lead: RUFT /sn_lead_mgmt_core/Lead AB](https://servicenow-prod.fluidtopics.net/bsaLfSMgvToNREd~Bkp16A#lead-GET-lead "Ruft alle Leads und zugehörigen Lead-Positionselemente basierend auf den in den Abfrageparametern übergebenen Filterkriterien ab.")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"] } |
| RequestUrl | 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 : 3. Parameter]

{#LAPU-processGetAllLeads_O_S__table_igt_klr_ydc} {#LAPU-processGetAllLeads_O_S__table_jgt_klr_ydc__entry__2}

| 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 `Textkörper `Und `Status `Parameter. |
| \<JSONobject\>.Textkörper | Antworttext. Erfolgreiche Antwort: Ein Array von Objekten, wobei jedes Objekt 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: RUFT /sn_lead_mgmt_core/Lead AB](https://servicenow-prod.fluidtopics.net/bsaLfSMgvToNREd~Bkp16A#lead-GET-lead "Ruft alle Leads und zugehörigen Lead-Positionselemente basierend auf den in den Abfrageparametern übergebenen Filterkriterien ab."). 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 kommagetrennte Links zu jeder Seite in der Antwort. 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) |
[Tabelle : 4. Rückgaben]

{#LAPU-processGetAllLeads_O_S__table_jgt_klr_ydc}  
Das folgende Codebeispiel zeigt, wo Sie Ihren anwenderdefinierten Code für hinzufügen können ProcessGetAllLeads() Methode in LeadAPIProzessUtil 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) {#ariaid-title4}

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\]
{#LAPU-processGetLeadById_S__table_fvz_qcl_ydc__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| ID | Zeichenfolge | SYS_ID des abzurufenden Lead-Datensatzes. Tabelle: Lead \[sn_lead_mgmt_core_lead\] |
[Tabelle : 5. Parameter]

{#LAPU-processGetLeadById_S__table_fvz_qcl_ydc} {#LAPU-processGetLeadById_S__table_gvz_qcl_ydc__entry__2}

| 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 -- RUFT /sn_lead_mgmt_core/Lead/{sys_ID} AB](https://servicenow-prod.fluidtopics.net/bsaLfSMgvToNREd~Bkp16A#lead-GET-lead-sys_id "Gibt den Lead-Datensatz und alle zugehörigen Lead-Positionselemente für die angegebene sys_ID zurück"). 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 |
[Tabelle : 6. Rückgaben]

{#LAPU-processGetLeadById_S__table_gvz_qcl_ydc}  
Das folgende Codebeispiel zeigt, wo Sie Ihren anwenderdefinierten Code für hinzufügen können ProcessGetLeadById() Methode in LeadAPIProzessUtil 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 (Object requestBody, Zeichenfolgen-ID) {#ariaid-title5}

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\]
{#LAPU-processUpdateLead_O_S__table_n24_k5r_ydc__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| requestBody | Objekt | Anforderungstext des Lead und der zugehörigen Lead-Positionselementfelder, die aktualisiert werden sollen. Details zum Inhalt dieses Objekts finden Sie unter [Lead -- PATCH /sn_lead_mgmt_core/Lead/{sys_ID}](https://servicenow-prod.fluidtopics.net/bsaLfSMgvToNREd~Bkp16A#lead-PATCH-lead "Aktualisiert den angegebenen Lead-Datensatz und die zugehörigen Lead-Positionselemente. Sie können diesen Endpunkt auch verwenden, um dem angegebenen Lead neue Lead-Positionselemente zuzuordnen."). |
| ID | Zeichenfolge | SYS_ID des zu aktualisierenden Lead-Datensatzes. Tabelle: Lead \[sn_lead_mgmt_core_lead\] |
[Tabelle : 7. Parameter]

{#LAPU-processUpdateLead_O_S__table_n24_k5r_ydc} {#LAPU-processUpdateLead_O_S__table_o24_k5r_ydc__entry__2}

| 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}](https://servicenow-prod.fluidtopics.net/bsaLfSMgvToNREd~Bkp16A#lead-PATCH-lead "Aktualisiert den angegebenen Lead-Datensatz und die zugehörigen Lead-Positionselemente. Sie können diesen Endpunkt auch verwenden, um dem angegebenen Lead neue Lead-Positionselemente zuzuordnen."). 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 |
[Tabelle : 8. Rückgaben]

{#LAPU-processUpdateLead_O_S__table_o24_k5r_ydc}  
Das folgende Codebeispiel zeigt, wo Sie Ihren anwenderdefinierten Code für hinzufügen können ProcessUpdateLead() Methode in LeadAPIProzessUtil 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' 

    }); 


