---
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


---

# LeadAPIValidationUtilOOB -- Umfang

# LeadAPIValidationUtilOOB -- Umfang {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 Minuten Lesedauer

Die LeadAPIValidationUtilOOB Die Skripteinbindung stellt Methoden bereit, die von aufgerufen werden Lead REST-API zum Validieren von Lead-Datensätzen und zugehörigen Lead-Positionselementdatensätzen, wenn sie erstellt (POST) oder aktualisiert (PATCH) werden.

Wenn Sie anpassen möchten, wie Lead-Datensätze validiert 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 LeadAPIValidationUtil Skripteinbindung. Die Namen der Methoden, die Sie in überschreiben LeadAPIValidationUtil Die Skripteinbindung muss mit denen in übereinstimmen LeadAPIValidationUtilOOB 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).

## LeadAPIValidationUtilOOB -- validateLeadObjectForPatchCall (Object leadObject) {#ariaid-title2}

Validiert die übergebenen Felder für einen angegebenen Lead und die zugehörigen Einzelposten, wenn ein Lead-Datensatz mit aktualisiert wird `PATCH `Endpunkt von Lead API.
Diese Methode wird durch ausgelöst ProcessUpdateLead() Methode in LeadAPIValidationUtilOOB Skripteinbindung. Diese Methode führt verschiedene Validierungen durch, z. B.:

* Überprüft auf Pflichtfelder
* Überprüft, ob Telefonnummer und E-Mail-Adresse das richtige Format haben.
* Überprüft Auswahl- und Referenzfelder, wobei ungültige Werte ignoriert werden.
* Validiert die Phase und löst einen Fehler aus, wenn der Anwender versucht, einen Lead zu qualifizieren.
{#LAVU-valLeadObjectForPatchCall_O__table_g1v_qls_ydc__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Lead-Objekt | Objekt | Felder, die im angegebenen Lead-Datensatz und den zugehörigen Lead-Positionselementdatensätzen aktualisiert werden sollen. Eine Liste der Felder, die übergeben werden können, und der zugehörigen Anforderungen 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."). |
[Tabelle : 1. Parameter]

{#LAVU-valLeadObjectForPatchCall_O__table_g1v_qls_ydc} {#LAVU-valLeadObjectForPatchCall_O__table_h1v_qls_ydc__entry__2}

| Typ | Beschreibung |
|-|-|
| \<JSON object\> | Ergebnisse der Validierung. { "errors": [Array], "indexesOfleadLineItemsForInsertion": [Array] } |
| \<JSON object\>.Fehler | Details der Fehler, die beim Validieren des übergebenen Lead- und Lead-Positionselementobjekts erkannt wurden. Gibt ein leeres Array zurück, wenn keine Fehler erkannt werden. Zum Beispiel: [ {"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."} ] Diese Fehlermeldungen befinden sich in LeadAPIKonstantenOOB Skripteinbindung. Datentyp: Array von Objekten |
| \<JSON object\>.indexesOfleadLineItemsForEinfügung | Indizes neuer Lead-Positionselemente, die in das leadObject eingefügt werden müssen. Datentyp: Array von Ganzzahlen |
[Tabelle : 2. Rückgaben]

{#LAVU-valLeadObjectForPatchCall_O__table_h1v_qls_ydc}  
Das folgende Codebeispiel zeigt, wo Sie Ihren anwenderdefinierten Code für hinzufügen können ValidateLeadObjectForPatchCall() Methode in LeadAPIValidationUtil Skripteinbindung.

    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 (Object leadObject) {#ariaid-title3}

Validiert die übergebenen Felder für einen angegebenen Lead und die zugehörigen Positionselemente beim Erstellen eines Lead-Datensatzes mit `VERÖFFENTLICHEN `Endpunkt von Lead API.
Diese Methode wird durch ausgelöst ProcessCreateLead() Methode in LeadAPIValidationUtilOOB Skripteinbindung. Diese Methode führt verschiedene Validierungen durch, z. B.:

* Sucht nach Pflichtfeldern.
* Überprüft, ob Telefonnummer und E-Mail-Adresse das richtige Format haben.
* Überprüft Auswahl- und Referenzfelder, wobei ungültige Werte ignoriert werden.
{#LAVU-valLeadObjectForPostCall_O__table_ggp_t1s_ydc__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Lead-Objekt | Objekt | Felder, die in den neuen Lead-Datensatz und die zugehörigen Lead-Positionselementdatensätze eingefügt werden sollen. Eine Liste der Felder, die übergeben werden können, und der zugehörigen Anforderungen 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 : 3. Parameter]

{#LAVU-valLeadObjectForPostCall_O__table_ggp_t1s_ydc} {#LAVU-valLeadObjectForPostCall_O__table_hgp_t1s_ydc__entry__2}

| Typ | Beschreibung |
|-|-|
| Array | Details der Fehler, die beim Validieren des übergebenen Lead- und Lead-Positionselementobjekts erkannt wurden. Gibt ein leeres Array zurück, wenn keine Fehler erkannt werden. Zum Beispiel: [ {"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."} ] Diese Fehlermeldungen befinden sich in LeadAPIKonstantenOOB Skripteinbindung. |
[Tabelle : 4. Rückgaben]

{#LAVU-valLeadObjectForPostCall_O__table_hgp_t1s_ydc}  
Das folgende Codebeispiel zeigt, wo Sie Ihren anwenderdefinierten Code für hinzufügen können ValidateLeadObjectForPostCall() Methode in LeadAPIValidationUtil Skripteinbindung.

    var LeadAPIValidationUtil = Class.create(); 

    LeadAPIValidationUtil.prototype = Object.extendsObject(LeadAPIValidationUtilOOB, { 

    // Define overriding functions here 

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

    type: 'LeadAPIValidationUtil' 

    }); 


