LeadAPIValidationUtilOOB : Bereichsbezogen

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

    • Die LeadAPIValidationUtilOOB -Skripteinbindung stellt Methoden bereit, die von der Lead- REST-API aufgerufen werden, um Lead-Datensätze und zugehörige Lead-Positionselement-Datensätze zu validieren, wenn sie erstellt (POST) oder aktualisiert werden (PATCH).

    Wenn Sie anpassen möchten, wie Lead-Datensätze beim Aufruf der Lead-API -Methoden validiert werden, überschreiben Sie die Methoden in dieser Skripteinbindung in der LeadAPIValidationUtil -Skripteinbindung. Die Namen der Methoden, die Sie in der LeadAPIValidationUtil -Skripteinbindung überschreiben, müssen mit denen in der LeadAPIValidationUtilOOB -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.

    LeadAPIValidationUtilOOB - validLeadObjectForPatchCall (Objekt LeadObject)

    Validiert die übergebenen Felder für einen angegebenen Lead und die zugehörigen Positionen, wenn ein Lead-Datensatz mit dem PATCH -Endpunkt der Lead- API aktualisiert wird.

    Diese Methode wird von der Methode processUpdateLead() in der Skripteinbindung LeadAPIValidationUtilOOB ausgelöst. Diese Methode führt verschiedene Validierungen durch, z. B.:
    • Prüft auf Pflichtfelder
    • Überprüft, ob die Telefonnummer und E-Mail-Adresse das richtige Format haben.
    • Überprüft Auswahl- und Referenzfelder und ignoriert ungültige Werte.
    • Validiert die Phase und löst einen Fehler aus, wenn der Anwender versucht, einen Lead zu qualifizieren.
    Tabelle : 1. Parameter
    Name Typ Beschreibung
    LeadObject Objekt Felder, die im angegebenen Lead-Datensatz und in den zugehörigen Lead-Positionselement-Datensätzen aktualisiert werden sollen. Eine Liste der Felder, die bestanden werden können, und die 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 bei der Validierung des übergebenen Lead- und Lead-Positionselement-Objekts 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 der Skripteinbindung LeadAPIConstantsOOB.

    Datentyp: Array von Objekten
    <JSON object>.indexesOfleadLineItemsForInsertion Indexe neuer Lead-Positionselemente, die in das LeadObject eingefügt werden müssen

    Datentyp: Array von Ganzzahlen

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

    var LeadAPIValidationUtil = Class.create(); 

LeadAPIValidationUtil.prototype = Object.extendsObject(LeadAPIValidationUtilOOB, { 

// Define overriding functions here

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

type: 'LeadAPIValidationUtil' 

});

    LeadAPIValidationUtilOOB - validLeadObjectForPostCall (Objekt LeadObject)

    Validiert die übergebenen Felder für einen angegebenen Lead und die zugehörigen Positionen, wenn ein Lead-Datensatz mit dem POST- Endpunkt der Lead- API erstellt wird.

    Diese Methode wird von der Methode processCreateLead() in der Skripteinbindung LeadAPIValidationUtilOOB ausgelöst. Diese Methode führt verschiedene Validierungen durch, z. B.:
    • Prüft auf Pflichtfelder.
    • Überprüft, ob die Telefonnummer und E-Mail-Adresse das richtige Format haben.
    • Überprüft Auswahl- und Referenzfelder und ignoriert ungültige Werte.
    Tabelle : 3. Parameter
    Name Typ Beschreibung
    LeadObject Objekt Felder, die in den neuen Lead-Datensatz und die zugehörigen Lead-Positionselement-Datensätze eingefügt werden sollen. Eine Liste der Felder, die bestanden werden können, und die zugehörigen Anforderungen finden Sie unter Lead: POST /sn_lead_mgmt_core/lead.
    Tabelle : 4. Rückgaben
    Typ Beschreibung
    Array Details der Fehler, die bei der Validierung des übergebenen Lead- und Lead-Positionselement-Objekts 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 der Skripteinbindung LeadAPIConstantsOOB.

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

    var LeadAPIValidationUtil = Class.create(); 

LeadAPIValidationUtil.prototype = Object.extendsObject(LeadAPIValidationUtilOOB, { 

// Define overriding functions here 

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

type: 'LeadAPIValidationUtil' 

});