LeadAPIHelperOOB : Bereichsbezogen

Die LeadAPIHelperOOB- Skripteinbindung bietet Hilfsmethoden, die von der Lead- REST-API aufgerufen werden, um verschiedene Funktionen auszuführen, z. B. das Konvertieren einer Reihe von Lead-Datensätzen aus einem GlideRecord-Objekt in ein JSON-Array oder JSON-Objekt und das Transformieren von Feldern in einem Lead-Objekt.

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

LeadAPIHelperOOB – getJSONFromGR(GlideRecord gr, Array-Felder)

Konvertiert ein GlideRecord-Objekt in ein JSON-Objekt. Diese Methode durchläuft die Felder von 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 der Parameter fields NULL ist oder den Wert „lead_line_items“enthält, ruft die Methode jeden zugehörigen Einzelposten-Datensatz ab, einschließlich aller Felder des Einzelpostens. 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. Referenzfelder, Auswahlfelder, Felder für Datum/Uhrzeit und andere spezifische Datentypen werden speziell behandelt, um sicherzustellen, dass sie richtig formatiert sind.

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

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 LeadGr, Array Fields)

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

Tabelle : 3. Parameter

Name	Typ	Beschreibung
LeadGr	GlideRecord	GlideRecord-Objekt, das die in JSON zu konvertierenden Lead-Datensätze enthält. 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 der Parameter fields NULL ist oder den Wert „lead_line_items“enthält, ruft die Methode jeden zugehörigen Einzelposten-Datensatz ab, einschließlich aller Felder des Einzelpostens. 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. Gegebenenfalls enthält sie auch ein Array von Lead-Positionselementen für jeden Lead. Jedes Feld im GlideRecord wird in ein Schlüssel-Wert-Paar konvertiert. Referenzfelder, Auswahlfelder, Felder für Datum/Uhrzeit und andere spezifische Datentypen werden speziell behandelt, um sicherzustellen, dass sie richtig formatiert sind.

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

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 die zugehörigen Werte konvertiert, z. B. eine sys_id.
• Arbeitsnotiztexte werden in einer durch Kommas getrennten Zeichenfolge kombiniert.
• Die Felder „Account“, „Kontakt“ und „Verbraucher“ werden validiert. Die Werte von Account, Kontakt und Verbraucher werden ignoriert, wenn sowohl Account als auch Verbraucher Werte enthalten.

Tabelle : 5. Parameter

Name	Typ	Beschreibung
LeadObject	Objekt	Zu transformierendes Lead-Objekt. Dieses Objekt enthält Details zum Lead und den zugehörigen Lead-Positionen.

Tabelle : 6. Rückgaben

Typ	Beschreibung
Objekt	Lead-Objekt transformiert

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

var LeadAPIHelper = Class.create();

LeadAPIHelper.prototype = Object.extendsObject(LeadAPIHelperOOB, {

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

// Add your custom code here
}, 

type: 'LeadAPIHelper'
});