LeadAPIValidationUtilOOB – Umfang

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

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

    Wenn Sie anpassen möchten, wie Lead-Datensätze validiert werden, wenn Lead-API Methoden werden aufgerufen. Überschreiben Sie 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 Rolle „sn_Lead_mgmt_Core.Lead_Integrator“ verfügen.

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

    LeadAPIValidationUtilOOB – validateLeadObjectForPatchCall (Object leadObject)

    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.:
    • 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.
    • Validiert die Phase und löst einen Fehler aus, wenn der Anwender versucht, einen Lead zu qualifizieren.
    Tabelle : 1. Parameter
    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}.
    Tabelle : 2. Rückgaben
    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 im LeadAPIKonstantenOOB Skripteinbindung.

    Datentyp: Array von Objekten
    <JSON object>.indexesNachzeileItemsForEinfügung Indizes neuer Lead-Positionselemente, die in das Lead-Objekt eingefügt werden müssen.

    Datentyp: Array von Ganzzahlen

    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)

    Validiert die übergebenen Felder für einen angegebenen Lead und die zugehörigen Einzelposten 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.
    Tabelle : 3. Parameter
    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 – POST /sn_Lead_mgmt_Core/Lead.
    Tabelle : 4. Rückgaben
    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 im LeadAPIKonstantenOOB Skripteinbindung.

    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' 

});