LeadAPIHelperOOB – Umfang

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

    • Die LeadAPIHelperOOB Die Skripteinbindung stellt Hilfsmethoden bereit, die vom aufgerufen werden Lead REST-API zum Ausführen verschiedener Funktionen, z. B. zum Konvertieren einer Reihe von Lead-Datensätzen aus einem GlideRecord-Objekt in ein JSON-Array oder JSON-Objekt und zum Transformieren von Feldern innerhalb eines Lead-Objekts.

    Wenn Sie diese Hilfsfunktionen anpassen möchten, überschreiben Sie die Methoden in dieser Skripteinbindung in LeadAPIHelper Skripteinbindung. Die Namen der Methoden, die Sie in überschreiben LeadAPIHelper Die Skripteinbindung muss mit denen in übereinstimmen LeadAPIHelperOOB 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.

    LeadAPIHelperOOB – getJSONFromGR(GlideRecord gr, Array-Felder)

    Konvertiert ein GlideRecord-Objekt in ein JSON-Objekt. Diese Methode iteriert über die Felder des GlideRecord, überprüft ihre Typen und formatiert ihre Werte entsprechend in einer JSON-kompatiblen Struktur.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    gr GlideRecord GlideRecord-Objekt, das in ein JSON-Objekt konvertiert werden soll.
    Felder Array Optional. Kommagetrennte Feldnamen, die in das JSON-Objekt aufgenommen werden sollen. Diese Namen müssen genau mit den Namen im Lead-Datensatz übereinstimmen.
    Beispiel:  ["Account", "first_Name", "do_not_call", "Lead_line_items"]
    Hinweis:

    Wenn fieldsParameter ist null oder enthält den Wert „Lead_line_items“ , Die Methode ruft jeden zugehörigen Einzelposten-Datensatz ab, einschließlich aller Felder der Position.

    Diese Methode unterstützt nur die Konvertierung einzelner Felder aus der Tabelle „Lead“ [sn_Lead_mgmt_Core_Lead], nicht aus der Tabelle „Lead-Positionselement“ [sn_Lead_mgmt_Core_Lead_line_item]. Wenn Sie ein bestimmtes Feld aus der Tabelle „Lead-Positionselement“ angeben, wird es ignoriert.

    Standard: Alle Lead-Datensatzfelder sind im JSON-Objekt enthalten.
    Tabelle : 2. Rückgaben
    Typ Beschreibung
    JSON-Objekt JSON-Objekt, das die Felder aus dem angegebenen GlideRecord enthält.

    Jedes Feld im GlideRecord wird in ein Schlüssel-Wert-Paar konvertiert. Für Referenzfelder, Auswahlfelder, Datums-/Uhrzeitfelder und andere spezifische Datentypen wird eine spezielle Behandlung angewendet, um sicherzustellen, dass sie korrekt formatiert sind.

    Das folgende Codebeispiel zeigt, wo Sie Ihren anwenderdefinierten Code für hinzufügen können GetJsonFromGR() Methode in LeadAPIHelper Skripteinbindung.

    var LeadAPIHelper = Class.create(); 
LeadAPIHelper.prototype = Object.extendsObject(LeadAPIHelperOOB, {

// Define overriding functions here
getJSONFromGR: function(gr, fields) {

// Add your custom code here
},

type: 'LeadAPIHelper'
});

    LeadAPIHelperOOB – getLeadsJSON(GlideRecord LeadsGr, Array-Felder)

    Konvertiert eine Reihe von Lead-Datensätzen aus einem GlideRecord-Objekt in ein JSON-Array. Sie müssen die Lead-Datensatzfelder angeben, die im JSON-Array enthalten sein sollen.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    LeadsGr GlideRecord GlideRecord-Objekt mit den Lead-Datensätzen, die in JSON konvertiert werden sollen.

    Tabelle: Lead [sn_Lead_mgmt-Core_Lead]
    Felder Array Kommagetrennte Feldnamen, die in das JSON-Objekt aufgenommen werden sollen. Diese Namen müssen genau mit den Namen im Lead-Datensatz übereinstimmen.
    Beispiel:  ["Account", "first_Name", "do_not_call", "Lead_line_items"]
    Hinweis:

    Wenn fieldsParameter ist null oder enthält den Wert „Lead_line_items“ , Die Methode ruft jeden zugehörigen Einzelposten-Datensatz ab, einschließlich aller Felder der Position.

    Diese Methode unterstützt nur die Konvertierung einzelner Felder aus der Tabelle „Lead“ [sn_Lead_mgmt_Core_Lead], nicht aus der Tabelle „Lead-Positionselement“ [sn_Lead_mgmt_Core_Lead_line_item]. Wenn Sie ein bestimmtes Feld aus der Tabelle „Lead-Positionselement“ angeben, wird es ignoriert.
    Tabelle : 4. Rückgaben
    Typ Beschreibung
    Array von JSON-Objekten Jedes Objekt stellt einen Lead dar, der die angegebenen Felder enthält. Falls zutreffend, enthält es auch ein Array von Lead-Positionselementobjekten für jeden Lead.

    Jedes Feld im GlideRecord wird in ein Schlüssel-Wert-Paar konvertiert. Für Referenzfelder, Auswahlfelder, Datums-/Uhrzeitfelder und andere spezifische Datentypen wird eine spezielle Behandlung angewendet, um sicherzustellen, dass sie korrekt formatiert sind.

    Das folgende Codebeispiel zeigt, wo Sie Ihren anwenderdefinierten Code für hinzufügen können GetLeadsJson() Methode in LeadAPIHelper Skripteinbindung.

    var LeadAPIHelper = Class.create();
LeadAPIHelper.prototype = Object.extendsObject(LeadAPIHelperOOB, { 

// Define overriding functions here 
getLeadsJson: function(leadsGR, fields) {

// Add your custom code here
}, 

type: 'LeadAPIHelper' 
});

    LeadAPIHelperOOB – getTransformedLeadObject(Object leadObject)

    Transformiert das angegebene Lead-Objekt.

    Diese Transformation umfasst:
    • Ignorierte Felder werden entfernt.
    • Referenzfelder werden in ihre zugehörigen Werte konvertiert, z. B. eine sys_ID.
    • Kombinieren von Arbeitsnotiztexten in einer kommagetrennten Zeichenfolge.
    • Validiert die Felder „Account“, „Kontakt“ und „Verbraucher“. Die Werte von Account, Contact und Consumer werden ignoriert, wenn sowohl Account als auch Verbraucher Werte enthalten.
    Tabelle : 5. Parameter
    Name Typ Beschreibung
    Lead-Objekt Objekt Zu transformierendes Lead-Objekt. Dieses Objekt enthält Details zum Lead und den zugehörigen Lead-Positionselementen.
    Tabelle : 6. Rückgaben
    Typ Beschreibung
    Objekt Transformiertes Lead-Objekt.

    Das folgende Codebeispiel zeigt, wo Sie Ihren anwenderdefinierten Code für hinzufügen können GetTransformedLeadObject() Methode in LeadAPIHelper Skripteinbindung.

    var LeadAPIHelper = Class.create();

LeadAPIHelper.prototype = Object.extendsObject(LeadAPIHelperOOB, {

// Define overriding functions here 
getTransformedLeadObject: function(leadObject) { 

// Add your custom code here
}, 

type: 'LeadAPIHelper'
});