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


---

# LeadAPIHelperOOB -- Umfang

# LeadAPIHelperOOB -- Umfang {#ariaid-title1}

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

Die LeadAPIHelperOOB Die Skripteinbindung stellt Hilfsmethoden bereit, die von 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 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).

## LeadAPIHelperOOB -- getJSONFromGR(GlideRecord gr, Array-Felder) {#ariaid-title2}

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.
{#LAH-getJSONFromGR_GR_A__table_wfp_p1z_ydc__entry__3}

| 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 Lead-Tabelle \[sn_lead_mgmt_core_lead\], nicht aus der Lead-Positionstabelle \[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 : 1. Parameter]

{#LAH-getJSONFromGR_GR_A__table_wfp_p1z_ydc} {#LAH-getJSONFromGR_GR_A__table_xfp_p1z_ydc__entry__2}

| 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. |
[Tabelle : 2. Rückgaben]

{#LAH-getJSONFromGR_GR_A__table_xfp_p1z_ydc}  
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) {#ariaid-title3}

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.
{#LAH-getLeadsJSON_GR_A__table_d41_qvy_ydc__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| LeadsGr | GlideRecord | GlideRecord-Objekt, das die Lead-Datensätze enthält, 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 Lead-Tabelle \[sn_lead_mgmt_core_lead\], nicht aus der Lead-Positionstabelle \[sn_lead_mgmt_core_lead_line_item\]. Wenn Sie ein bestimmtes Feld aus der Tabelle „Lead-Positionselement" angeben, wird es ignoriert. |
[Tabelle : 3. Parameter]

{#LAH-getLeadsJSON_GR_A__table_d41_qvy_ydc} {#LAH-getLeadsJSON_GR_A__table_e41_qvy_ydc__entry__2}

| 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. |
[Tabelle : 4. Rückgaben]

{#LAH-getLeadsJSON_GR_A__table_e41_qvy_ydc}  
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) {#ariaid-title4}

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 zu einer kommagetrennten Zeichenfolge.
* Die Felder „Account", „Kontakt" und „Verbraucher" werden validiert. Die Werte von Account, Contact und Consumer werden ignoriert, wenn sowohl Account als auch Verbraucher Werte enthalten.
{#LAH-getTransformedLeadObject_O__ul_oyl_lxq_12c}
{#LAH-getTransformedLeadObject_O__table_vpc_l2z_ydc__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Lead-Objekt | Objekt | Zu transformierendes Lead-Objekt. Dieses Objekt enthält Details zum Lead und seinen zugehörigen Lead-Positionselementen. |
[Tabelle : 5. Parameter]

{#LAH-getTransformedLeadObject_O__table_vpc_l2z_ydc} {#LAH-getTransformedLeadObject_O__table_wpc_l2z_ydc__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | Transformiertes Lead-Objekt. |
[Tabelle : 6. Rückgaben]

{#LAH-getTransformedLeadObject_O__table_wpc_l2z_ydc}  
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'
    }); 


