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


---

# api: UI Builder

# api: UI Builder {#ariaid-title1}

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

Die API Die API bietet Methoden, die Sie bei der Entwicklung von Client-Skripts im UI Builder verwenden können.  
Diese API ist Client-Skripts zugänglich, auch als Seitenskripts bezeichnet. Client-Skripts werden als Reaktion auf etwas ausgeführt, das auf einer Seite passiert, z. B.:

* Anwenderinteraktionsereignisse/-Aktionen, z. B. Klicken auf eine Schaltfläche.
* Lebenszyklusereignisse, z. B. die Ausführung eines Daten-Brokers, wurden gestartet.
Diese Skripts müssen nichts an das Framework zurückgeben und können als asynchrone Funktion geschrieben werden.  
Diese API ist auch für geskriptete Eigenschaftswerte verfügbar. Diese Skripts werden ausgeführt, wenn die Framework-Laufzeit einen Wert berechnen muss, z. B.:

* Übergabe an eine Komponenteneigenschaft.
* Die Sichtbarkeit der Komponente wird bestimmt.
* Es wird ein Ereignis mit einer Nutzlast ausgegeben.

Diese Skripts können nicht als asynchrone Funktion geschrieben werden. Sie können auch keine Nebenwirkungsmethoden für das api-Objekt aufrufen, z. B. api.Emit() , api.setState() , Und api.Daten.\<data_resource_id\>.\*() .

Das api-Objekt enthält sowohl konfigurationsabhängige als auch konfigurationsunabhängige Eigenschaften, auf die Sie im Kontext der zugehörigen Seite oder Komponente zugreifen können. Sie können die Eigenschaften innerhalb dieses Objekts nicht direkt ändern. Änderungen können nur über die verfügbaren Methoden vorgenommen werden.

## api: api.context.props.\<page_property_name\> {#ariaid-title2}

Seiteneigenschaften können in konfiguriert werden UI Builder. Die Konfigurationswerte hängen vom Kontext ab, in dem die Seite verwendet wird.
{#api-context-props__table_pnc_bkb_n4b__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| \<page_property_name\> | Beliebig | Verfügbare Werte hängen von der Client-Skriptimplementierung ab. Um auf diese Eigenschaften zuzugreifen, verwenden Sie Folgendes: `api.context.props.<page_property_name> `. Zum Beispiel: `// A record page with property table could be accessed with function isActivityStreamVisible({api}) { return api.context.props.table === 'incident'; } ` Hinweis: Diese Eigenschaftswerte sind schreibgeschützt. Das Mutation geschachtelter Objektwerte aus Skripts wird nicht unterstützt. |
[Tabelle : 1. Feld]

{#api-context-props__table_pnc_bkb_n4b}

## api: api.context.session.\<session_property\> {#ariaid-title3}

Kontextsitzungseigenschaften, die dem aktuellen Anwender zugeordnet sind.
{#api-context-session__table_e24_hkc_n4b__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| IsLoggedIn | Boolean | Kennzeichnung, die angibt, ob der aktuelle Anwender beim System angemeldet ist. Mögliche Werte: * Wahr: Der aktuelle Anwender ist bei angemeldet * Falsch: Der aktuelle Anwender ist nicht angemeldet. |
| Properties.awaEnabled | Zeichenfolge | Die Systemeigenschaft „Glide.awa.enabled", die angibt, ob die automatische Zuweisung für Arbeitselemente für die erweiterte Arbeitszuweisung (AWA) für den aktuellen Anwender aktiviert ist. Mögliche Werte: * Wahr: AWA ist für den Anwender aktiviert. * Falsch: AWA ist für den Anwender nicht aktiviert. Weitere Informationen finden Sie unter [Komponenten mit erweiterter Arbeitszuweisung installiert](https://www.servicenow.com/docs/access?context=installed-with-awa&version=yokohama&pubname=yokohama-servicenow-platform&ft:locale=en-US). |
| Properties.forgetMe.value | Zeichenfolge | Die Eigenschaft „Glide.ui.Forgetme", die angibt, ob entfernt werden soll Erinnern Sie Sich An Mich Aktivieren Sie das Kontrollkästchen auf der Anmeldeseite, um zu verhindern, dass Anmeldeinformationen zwischengespeichert werden. Mögliche Werte: * Wahr: Entfernen Sie Erinnern Sie Sich An Mich Kontrollkästchen. * Falsch: Zeigen Sie an Erinnern Sie Sich An Mich Kontrollkästchen. Weitere Informationen finden Sie unter [Entfernen Sie „mich speichern"](https://www.servicenow.com/docs/access?context=sc-remove-remember-me&version=yokohama&pubname=yokohama-platform-security&ft:locale=en-US). |
| properties.sessionTimeLeft.value | Zeichenfolge Zahl in Zeichenfolge erzwungen | Die Systemeigenschaft glide.ui.session_timeleft, die die verbleibende Zeit vor dem Timeout der aktuellen Sitzung bestimmt. Verwenden Sie diese Eigenschaft, um den Anwender aufzufordern, die aktuelle Sitzung zu erweitern, bevor eine Zeitüberschreitung eintritt. Einheit: Minuten |
| properties.sessionTimeout.value | Zeichenfolge Zahl in Zeichenfolge erzwungen | Die Systemeigenschaft glide.ui.session_timeout, die den Zeitüberschreitungswert der ersten Sitzung bestimmt. Einheit: Minuten: Werte, die größer als 1440 Minuten sind, werden als ein Tag behandelt. Weitere Informationen finden Sie unter [Zeitüberschreitung bei Sitzungsaktivität](https://www.servicenow.com/docs/access?context=sc-session-activity-timeout&version=yokohama&pubname=yokohama-platform-security&ft:locale=en-US) |
| Properties.trackingEnabled.value | Zeichenfolge | Die Systemeigenschaft „Glide.uxbuilder.Tracking.enabled", die angibt, ob das Laden und Instanziieren der Web Analytics-Bibliothek für aktiviert/deaktiviert werden soll UI BuilderBasierte Anwendungen. Mögliche Werte: * Wahr: Für den Anwender aktiviert. * Falsch: Für den Anwender deaktiviert. |
| Anwender.Avatar | Zeichenfolge | URL des Avatars des aktuellen Anwenders. |
| User.dateFormat | Zeichenfolge | Standarddatumsformat. |
| Anwender.Domäne | Zeichenfolge | Domänenpfad für den aktuellen Anwender. |
| Anwender.firstName | Zeichenfolge | Vorname des aktuellen Anwenders. |
| Anwender.FullName | Zeichenfolge | Vor- und Nachname des aktuellen Anwenders. |
| user.initials | Zeichenfolge | Initialen des aktuellen Anwenders. |
| Anwender.Sprache | Zeichenfolge | Primäre Sprache, die vom aktuellen Anwender gesprochen wird. |
| Anwender.Einstellungen | Array von Objekten | Name-Wert-Paare, die die Anwendereinstellungen beschreiben. Diese Anwendereinstellungen werden als Datensätze in der Tabelle „Anwendereinstellungen" \[sys_user_preferences\] gespeichert und jedes Mal aktualisiert, wenn der Anwender seine Einstellungen ändert. Weitere Informationen finden Sie unter [Exploring user administration](https://www.servicenow.com/docs/access?context=exploring-user-administration&version=yokohama&pubname=yokohama-platform-administration&ft:locale=en-US). |
| Anwender.Rollen | Array | Kommagetrennte Liste der Rollen, die dem aktuellen Anwender zugewiesen sind. Hinweis: Wenn dem Anwender keine Rollen zugewiesen sind, gibt diese Kontextsitzungseigenschaft null und kein leeres Array zurück. |
| Anwender.sys_ID | Zeichenfolge | SYS_ID des Anwenders in der Anwendertabelle \[sys_user\]. |
| Anwender.Zeitformat | Zeichenfolge | Standardzeitformat, das für den Anwender verwendet werden soll. |
| Anwender.Zeitzone | Zeichenfolge | Zeitzone des aktuellen Anwenders. |
| User.timeZoneOffset | Zeichenfolge | Zeitzonen-Offset des aktuellen Anwenders. |
[Tabelle : 2. Verfügbare Sitzungseigenschaften]

{#api-context-session__table_e24_hkc_n4b}

## api: api.Data.\<data_resource_id\>.Lifecycle.lastFetchSucceeded {#ariaid-title4}

Boolesche Kennzeichnung, die angibt, ob der letzte Abrufversuch für die angegebene Datenressourceninstanz erfolgreich abgeschlossen wurde.
Wenn der Wert „wahr" ist, wurde der letzte Abrufversuch für die Instanz der Datenressource erfolgreich abgeschlossen. Andernfalls „falsch".
{#api-data-resrc_id-lastFetchSuc__table_svj_czb_n4b__entry__3}{#api-data-resrc_id-lastFetchSuc__data_resource_id-entry-api}

| Name | Typ | Beschreibung |
|-|-|-|
| Data_resource_ID | Zeichenfolge | Eindeutiger Bezeichner der zugeordneten Datenressource. In den meisten Fällen können Sie die Aktion „Formularcontroller CTRL_RECORD#SAVE_FORM" verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten" verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren. Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder. |
[Tabelle : 3. Feld]

{#api-data-resrc_id-lastFetchSuc__table_svj_czb_n4b}

## api -- api.Data.\<data_resource_id\>.addErrorMessage (Objektnutzlast) {#ariaid-title5}

Zeigt die angegebene Fehlermeldung oben im aktuellen Formular an.
{#api-data-resrc_id-addErrMsg_O__table_pct_ffd_n4b__entry__3}{#api-data-resrc_id-addErrMsg_O__data_resource_id-entry-api}

| Name | Typ | Beschreibung |
|-|-|-|
| Data_resource_ID | Zeichenfolge | Eindeutiger Bezeichner der zugeordneten Datenressource. In den meisten Fällen können Sie die Aktion „Formularcontroller CTRL_RECORD#SAVE_FORM" verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten" verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren. Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder. |
| Nutzlast | Objekt | Objekt, das die anzuzeigende Fehlermeldung beschreibt. "payload": { "message": "String" } |
| Payload.Message | Zeichenfolge | Anzuzeigende Fehlermeldung. |
[Tabelle : 4. Parameter]

{#api-data-resrc_id-addErrMsg_O__table_pct_ffd_n4b} {#api-data-resrc_id-addErrMsg_O__table_qct_ffd_n4b__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 5. Rückgaben]

{#api-data-resrc_id-addErrMsg_O__table_qct_ffd_n4b}  
<br />

    api.data.gform.addErrorMessage({message: 'Error message'});

## api -- api.Data.\<data_resource_id\>.addInfoMessage (Objektnutzlast) {#ariaid-title6}

Zeigt die angegebene Informationsnachricht oben im aktuellen Formular an.
{#api-data-resrc_id-addInfoMsg_O__table_pqr_wdd_n4b__entry__3}{#api-data-resrc_id-addInfoMsg_O__data_resource_id-entry-api}

| Name | Typ | Beschreibung |
|-|-|-|
| Data_resource_ID | Zeichenfolge | Eindeutiger Bezeichner der zugeordneten Datenressource. In den meisten Fällen können Sie die Aktion „Formularcontroller CTRL_RECORD#SAVE_FORM" verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten" verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren. Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder. |
| Nutzlast | Objekt | Objekt, das die anzuzeigende Informationsnachricht beschreibt. "payload": { "message": "String" } |
| Payload.Message | Zeichenfolge | Anzuzeigende Informationsnachricht. |
[Tabelle : 6. Parameter]

{#api-data-resrc_id-addInfoMsg_O__table_pqr_wdd_n4b} {#api-data-resrc_id-addInfoMsg_O__table_qqr_wdd_n4b__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 7. Rückgaben]

{#api-data-resrc_id-addInfoMsg_O__table_qqr_wdd_n4b}  
<br />

    api.data.gform.addInfoMessage({message: 'Test message'});

## api -- api.Data.\<data_resource_id\>.addOption (Objektnutzlast) {#ariaid-title7}

Fügt dem angegebenen Auswahltypfeld eine Option hinzu.
{#api-data-resrc_id-addOption_O__table_okr_21j_n4b__entry__3}{#api-data-resrc_id-addOption_O__data_resource_id-entry-api}

| Name | Typ | Beschreibung |
|-|-|-|
| Data_resource_ID | Zeichenfolge | Eindeutiger Bezeichner der zugeordneten Datenressource. In den meisten Fällen können Sie die Aktion „Formularcontroller CTRL_RECORD#SAVE_FORM" verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten" verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren. Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder. |
| Nutzlast | Objekt | Objekt, das den zu aktualisierenden Feldwert beschreibt. "payload": { "choiceIndex": "String", "choiceLabel": "String", "choiceValue": "String", "fieldName": "String" } |
| payload.choiceIndex | Zeichenfolge | Optional. Index in die Auswahlliste, in der die Option eingefügt werden soll. Standard: Ende der Auswahlliste. |
| payload.choiceLabel | Zeichenfolge | Bezeichnung der Option, die dem angegebenen Feld hinzugefügt werden soll. |
| payload.choiceValue | Zeichenfolge | Wert der Option, die dem angegebenen Feld hinzugefügt werden soll. |
| Payload.fieldName | Zeichenfolge | Name des Auswahltypformularfelds, dem die angegebene Option hinzugefügt werden soll. |
[Tabelle : 8. Parameter]

{#api-data-resrc_id-addOption_O__table_okr_21j_n4b} {#api-data-resrc_id-addOption_O__table_pkr_21j_n4b__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 9. Rückgaben]

{#api-data-resrc_id-addOption_O__table_pkr_21j_n4b}  
<br />

    api.data.gform.addOption({fieldName: 'priority', choiceLabel: 'Extremely High', choiceValue: '10'});

## api -- api.Data.\<data_resource_id\>.addWarningMessage (Objektnutzlast) {#ariaid-title8}

Zeigt die angegebene Warnmeldung oben im aktuellen Formular an.
{#api-data-resrc_id-addWarnMsg_O__table_mgf_v2d_n4b__entry__3}{#api-data-resrc_id-addWarnMsg_O__data_resource_id-entry-api}

| Name | Typ | Beschreibung |
|-|-|-|
| Data_resource_ID | Zeichenfolge | Eindeutiger Bezeichner der zugeordneten Datenressource. In den meisten Fällen können Sie die Aktion „Formularcontroller CTRL_RECORD#SAVE_FORM" verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten" verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren. Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder. |
| Nutzlast | Objekt | Objekt, das die anzuzeigende Warnmeldung beschreibt. "payload": { "message": "String" } |
| Payload.Message | Zeichenfolge | Anzuzeigende Warnmeldung. |
[Tabelle : 10. Parameter]

{#api-data-resrc_id-addWarnMsg_O__table_mgf_v2d_n4b} {#api-data-resrc_id-addWarnMsg_O__table_ngf_v2d_n4b__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 11. Rückgaben]

{#api-data-resrc_id-addWarnMsg_O__table_ngf_v2d_n4b}  
<br />

    api.data.gform.addWarningMessage({message: 'Test message'});

## api -- api.Data.\<data_resource_id\>.ClearMessage() {#ariaid-title9}

Entfernt alle Informations- und Fehlermeldungen oben im aktuellen Formular.
{#api-data-resrc_id-clearMsg__table_g4t_qfd_n4b__entry__3}{#api-data-resrc_id-clearMsg__data_resource_id-entry-api}

| Name | Typ | Beschreibung |
|-|-|-|
| Data_resource_ID | Zeichenfolge | Eindeutiger Bezeichner der zugeordneten Datenressource. In den meisten Fällen können Sie die Aktion „Formularcontroller CTRL_RECORD#SAVE_FORM" verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten" verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren. Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder. |
[Tabelle : 12. Parameter]

{#api-data-resrc_id-clearMsg__table_g4t_qfd_n4b} {#api-data-resrc_id-clearMsg__table_h4t_qfd_n4b__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 13. Rückgaben]

{#api-data-resrc_id-clearMsg__table_h4t_qfd_n4b}  
<br />

    api.data.gform.clearMessage();

## api -- api.Data.\<data_resource_id\>.ClearOptions (Objektnutzlast) {#ariaid-title10}

Löscht alle Optionen aus dem angegebenen Auswahltypfeld.
{#api-data-resrc_id-clearOptions_O__table_c3x_4dj_n4b__entry__3}{#api-data-resrc_id-clearOptions_O__data_resource_id-entry-api}

| Name | Typ | Beschreibung |
|-|-|-|
| Data_resource_ID | Zeichenfolge | Eindeutiger Bezeichner der zugeordneten Datenressource. In den meisten Fällen können Sie die Aktion „Formularcontroller CTRL_RECORD#SAVE_FORM" verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten" verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren. Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder. |
| Nutzlast | Objekt | Objekt, das das Auswahltypfeld beschreibt, dessen Optionen gelöscht werden sollen. "payload": { "fieldName": "String" } |
| Payload.fieldName | Zeichenfolge | Name des Auswahltypfelds, dessen Optionen gelöscht werden sollen. |
[Tabelle : 14. Parameter]

{#api-data-resrc_id-clearOptions_O__table_c3x_4dj_n4b} {#api-data-resrc_id-clearOptions_O__table_d3x_4dj_n4b__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 15. Rückgaben]

{#api-data-resrc_id-clearOptions_O__table_d3x_4dj_n4b}  
<br />

    api.data.gform.clearOptions({fieldName: 'priority'});

## api -- api.Data.\<data_resource_id\>.executeUiAction (Objektnutzlast) {#ariaid-title11}

Führt die angegebene UI-Aktion aus.
{#api-data-resrc_id-execUIAct_O__table_l41_s2j_n4b__entry__3}{#api-data-resrc_id-execUIAct_O__data_resource_id-entry-api}

| Name | Typ | Beschreibung |
|-|-|-|
| Data_resource_ID | Zeichenfolge | Eindeutiger Bezeichner der zugeordneten Datenressource. In den meisten Fällen können Sie die Aktion „Formularcontroller CTRL_RECORD#SAVE_FORM" verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten" verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren. Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder. |
| Nutzlast | Objekt | Beschreibung der auszuführenden UI-Aktion. "payload": { "actionSysId": "String" } |
| Payload.actionSysId | Zeichenfolge | SYS_ID der auszuführenden UI-Aktion. Tabelle: UI-Aktion \[sys_ui_action\] |
[Tabelle : 16. Parameter]

{#api-data-resrc_id-execUIAct_O__table_l41_s2j_n4b} {#api-data-resrc_id-execUIAct_O__table_m41_s2j_n4b__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 17. Rückgaben]

{#api-data-resrc_id-execUIAct_O__table_m41_s2j_n4b}  
Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

    api.data.gform.executeUiAction({actionSysId: '60615ff90f730010ac7de6f8c4767e9a'});

## api -- api.Data.\<data_resource_id\>.execute(Object inputValues) {#ariaid-title12}

Löst einen Ausführungsvorgang für die angegebene Datenressource aus.
Diese Methode ist nur verfügbar, wenn die Datenressource einer der folgenden Typen ist:

* Zusammenfassung
* GraphQL
* REST
* Skriptlet
* Umwandeln
{#api-data-resrc_id-execute__ul_slc_xq1_54b}  
Hinweis:  
Diese Methode ist nur verfügbar, wenn mutates_server_dataFeld ist auf festgelegt <kbd class="ph userinput">Wahr </kbd>Im entsprechenden Datenressource-Datensatz (sys_ux_data_broker_\*-Tabelle). Sie ist unter zugänglich api.Daten.\<data_resource_Id\>.REFRESH() . {#api-data-resrc_id-execute__table_m52_lyc_n4b__entry__3}{#api-data-resrc_id-execute__data_resource_id_non_gform-entry-api}

| Name | Typ | Beschreibung |
|-|-|-|
| Data_resource_ID | Zeichenfolge | Eindeutiger Bezeichner der zugeordneten Datenressource. Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder. |
| inputValues | Objekt | Objekt, das an die angegebene Datenressource übergeben werden soll. Dieses Objekt muss den Eingabeparametern der Datenressource entsprechen. |
[Tabelle : 18. Parameter]

{#api-data-resrc_id-execute__table_m52_lyc_n4b} {#api-data-resrc_id-execute__table_n52_lyc_n4b__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 19. Rückgaben]

{#api-data-resrc_id-execute__table_n52_lyc_n4b}  
Dieses Codebeispiel zeigt ein Seitenskript, das aufgerufen wird, wenn Übermitteln Auf die Schaltfläche auf der Seite geklickt. Die Seite ist so konfiguriert, dass eine Serverdatenressource einen neuen Datensatz erstellt.

    function handler({api}) {
      if (api.state.movieYear === 2020) {
        // The data resource used in this case specifies two input parameters: name and year
        api.data.create_movie_record.execute({
          name: api.state.movieName,
          year: api.state.movieYear
        });
      }
    }

## api -- api.Data.\<data_resource_id\>.hideFieldMessage (Objektnutzlast) {#ariaid-title13}

Blendet die älteste Nachricht neben dem angegebenen Feld aus oder löscht alle dem Feld zugeordneten Nachrichten.
{#api-data-resrc_id-hideFldMsg__table_jl3_b33_n4b__entry__3}{#api-data-resrc_id-hideFldMsg__data_resource_id-entry-api}

| Name | Typ | Beschreibung |
|-|-|-|
| Data_resource_ID | Zeichenfolge | Eindeutiger Bezeichner der zugeordneten Datenressource. In den meisten Fällen können Sie die Aktion „Formularcontroller CTRL_RECORD#SAVE_FORM" verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten" verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren. Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder. |
| Nutzlast | Objekt | Objekt, das die auszublendende Feldnachricht beschreibt. "payload": { "clearAll": Boolean, "fieldName": "String" } |
| Nutzlast.Klammer | Boolean | Optional. Kennzeichnung, die angibt, ob alle Nachrichten gelöscht werden sollen, die dem angegebenen Formularfeld zugeordnet sind. Gültige Werte: * Wahr: Löschen Sie alle Nachrichten, die dem angegebenen Feld zugeordnet sind. * Falsch: Löschen Sie nicht alle Nachrichten, die dem angegebenen Feld zugeordnet sind. Standard: Falsch |
| Payload.fieldName | Zeichenfolge | Name des Formularfelds, für das die älteste Nachricht ausgeblendet oder alle zugehörigen Nachrichten gelöscht werden sollen. |
[Tabelle : 20. Parameter]

{#api-data-resrc_id-hideFldMsg__table_jl3_b33_n4b} {#api-data-resrc_id-hideFldMsg__table_kl3_b33_n4b__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 21. Rückgaben]

{#api-data-resrc_id-hideFldMsg__table_kl3_b33_n4b}  
<br />

    api.data.gform.hideFieldMessage({fieldName: 'short_description'});

## api -- api.Data.\<data_resource_id\>.hideRelatedList (Objektnutzlast) {#ariaid-title14}

Blendet die angegebene zugehörige Liste im aktuellen Formular aus.
{#api-data-resrc_id-hideRelList_O__table_yxg_jq3_n4b__entry__3}{#api-data-resrc_id-hideRelList_O__data_resource_id-entry-api}

| Name | Typ | Beschreibung |
|-|-|-|
| Data_resource_ID | Zeichenfolge | Eindeutiger Bezeichner der zugeordneten Datenressource. In den meisten Fällen können Sie die Aktion „Formularcontroller CTRL_RECORD#SAVE_FORM" verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten" verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren. Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder. |
| Nutzlast | Objekt | Objekt, das die zugehörige Liste beschreibt, die ausgeblendet werden soll. "payload": { "listTableName ": "String" } |
| Payload.listTabellenname | Zeichenfolge | Name der zugehörigen Liste, die ausgeblendet werden soll. Wenn die auszublendende Liste über eine Beziehung erfolgt, geben Sie die sys_ID der Liste anstelle des Namens an. Tabelle: Zugehörige Liste \[sys_ui_related_list\] |
[Tabelle : 22. Parameter]

{#api-data-resrc_id-hideRelList_O__table_yxg_jq3_n4b} {#api-data-resrc_id-hideRelList_O__table_zxg_jq3_n4b__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 23. Rückgaben]

{#api-data-resrc_id-hideRelList_O__table_zxg_jq3_n4b}  
Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

    api.data.gform.hideRelatedList({listTableName:'incident.parent_incident'});

## api -- api.Data.\<data_resource_id\>.hideRelatedLists() {#ariaid-title15}

Blendet alle zugehörigen Listen im aktuellen Formular aus.
{#api-data-resrc_id-hideRelLists__table_cy4_cm3_n4b__entry__3}{#api-data-resrc_id-hideRelLists__data_resource_id-entry-api}

| Name | Typ | Beschreibung |
|-|-|-|
| Data_resource_ID | Zeichenfolge | Eindeutiger Bezeichner der zugeordneten Datenressource. In den meisten Fällen können Sie die Aktion „Formularcontroller CTRL_RECORD#SAVE_FORM" verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten" verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren. Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder. |
[Tabelle : 24. Parameter]

{#api-data-resrc_id-hideRelLists__table_cy4_cm3_n4b} {#api-data-resrc_id-hideRelLists__table_dy4_cm3_n4b__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 25. Rückgaben]

{#api-data-resrc_id-hideRelLists__table_dy4_cm3_n4b}  
<br />

    api.data.gform.hideRelatedLists();

## api -- api.Data.\<data_resource_id\>.refresh() {#ariaid-title16}

Löst einen Aktualisierungsvorgang für die angegebene Instanz der nicht mutierenden Datenressource aus.
Rufen Sie diese Methode auf, wenn sich die zugrunde liegenden Daten ändern, die von der Datenressource abgerufen werden. Eine Datenressource wird als nicht mutierend betrachtet, wenn der mutates_server_dataFeld im Datensatz ist auf „falsch" festgelegt.

Diese Methode ist asynchron und gibt ein internes Ereignis aus, um die Aktualisierung der angegebenen Datenressourceninstanz auszulösen. Die UI BuilderErmöglicht Ihnen das Auslösen von Client-Skripts als Antwort auf Lebenszyklusereignisse von Datenressourcen, z. B. DATA_FETCH_SUCCESSFUL und DATA_FETCH_FAILED. Weitere Informationen zu diesen Ereignissen finden Sie unter [Ereigniszuordnung](https://www.servicenow.com/docs/access?context=event-mapping&version=yokohama&pubname=yokohama-application-development&ft:locale=en-US).  
Diese Methode ist nur verfügbar, wenn die Datenressource einer der folgenden Typen ist:

* Zusammenfassung
* GraphQL
* REST
* Skriptlet
* Umwandeln
{#api-data-resrc_id-refresh__ul_slc_xq1_54b}  
Hinweis:  
Diese Methode ist nur verfügbar, wenn mutates_server_dataFeld ist auf festgelegt <kbd class="ph userinput">Falsch </kbd>Im entsprechenden Datenressource-Datensatz (sys_ux_data_broker_\*-Tabelle). {#api-data-resrc_id-refresh__table_jrk_spc_n4b__entry__3}{#api-data-resrc_id-refresh__data_resource_id_non_gform-entry-api}

| Name | Typ | Beschreibung |
|-|-|-|
| Data_resource_ID | Zeichenfolge | Eindeutiger Bezeichner der zugeordneten Datenressource. Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder. |
[Tabelle : 26. Parameter]

{#api-data-resrc_id-refresh__table_jrk_spc_n4b} {#api-data-resrc_id-refresh__table_krk_spc_n4b__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 27. Rückgaben]

{#api-data-resrc_id-refresh__table_krk_spc_n4b}  
Dieses Codebeispiel zeigt ein Seitenskript, das aufgerufen wird, wenn ein Dropdown-Element auf einer Seite ausgewählt wird. Die Seite ist mit zwei Serverdatenressourcen konfiguriert, die Problem- und Incident-Tabellen abfragen.

    function handler({api, event}) {
      const value = event.payload.value[0];
      if (value === 'problem')
        api.data.problem_list_1.refresh();
      else if(value === 'incident')
        api.data.incident_list_1.refresh();
    }

## api -- api.Data.\<data_resource_id\>.reload() {#ariaid-title17}

Lädt das aktuelle Formular mit derselben Tabelle und derselben sys_ID neu
{#api-data-resrc_id-reload__table_cwc_kw3_n4b__entry__3}{#api-data-resrc_id-reload__data_resource_id-entry-api}

| Name | Typ | Beschreibung |
|-|-|-|
| Data_resource_ID | Zeichenfolge | Eindeutiger Bezeichner der zugeordneten Datenressource. In den meisten Fällen können Sie die Aktion „Formularcontroller CTRL_RECORD#SAVE_FORM" verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten" verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren. Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder. |
[Tabelle : 28. Parameter]

{#api-data-resrc_id-reload__table_cwc_kw3_n4b} {#api-data-resrc_id-reload__table_dwc_kw3_n4b__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 29. Rückgaben]

{#api-data-resrc_id-reload__table_dwc_kw3_n4b}  
<br />

    api.data.gform.reload();

## api -- api.Data.\<data_resource_id\>.removeOption (Objektnutzlast) {#ariaid-title18}

Entfernt eine Option aus dem angegebenen Auswahltypfeld.
{#api-data-resrc_id-removeOption_O__table_gky_wcj_n4b__entry__3}{#api-data-resrc_id-removeOption_O__data_resource_id-entry-api}

| Name | Typ | Beschreibung |
|-|-|-|
| Data_resource_ID | Zeichenfolge | Eindeutiger Bezeichner der zugeordneten Datenressource. In den meisten Fällen können Sie die Aktion „Formularcontroller CTRL_RECORD#SAVE_FORM" verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten" verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren. Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder. |
| Nutzlast | Objekt | Objekt, das das zu aktualisierende Auswahltypfeld beschreibt. "payload": { "choiceValue": "String", "fieldName": "String" } |
| payload.choiceValue | Zeichenfolge | Wert der Option, die aus dem angegebenen Auswahltypfeld entfernt werden soll. |
| Payload.fieldName | Zeichenfolge | Name des Auswahltypformularfelds, aus dem der angegebene Wert entfernt werden soll. |
[Tabelle : 30. Parameter]

{#api-data-resrc_id-removeOption_O__table_gky_wcj_n4b} {#api-data-resrc_id-removeOption_O__table_hky_wcj_n4b__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 31. Rückgaben]

{#api-data-resrc_id-removeOption_O__table_hky_wcj_n4b}  
<br />

    api.data.gform.removeOption({fieldName: 'priority', choiceValue: '1'});

## api -- api.Data.\<data_resource_id\>.Save() {#ariaid-title19}

Löst die Formularübermittlung mit aus Speichern UI-Aktion.
{#api-data-resrc_id-save__table_fn1_vw3_n4b__entry__3}{#api-data-resrc_id-save__data_resource_id-entry-api}

| Name | Typ | Beschreibung |
|-|-|-|
| Data_resource_ID | Zeichenfolge | Eindeutiger Bezeichner der zugeordneten Datenressource. In den meisten Fällen können Sie die Aktion „Formularcontroller CTRL_RECORD#SAVE_FORM" verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten" verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren. Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder. |
[Tabelle : 32. Parameter]

{#api-data-resrc_id-save__table_fn1_vw3_n4b} {#api-data-resrc_id-save__table_gn1_vw3_n4b__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 33. Rückgaben]

{#api-data-resrc_id-save__table_gn1_vw3_n4b}  
<br />

    api.data.gform.save();

## api -- api.Data.\<data_resource_id\>.setPflichtPflichtfeld (Objektnutzlast) {#ariaid-title20}

Legt fest, ob das angegebene Formularfeld ein Pflichtfeld ist.
{#api-data-resrc_id-setMan_O__table_yws_2v3_n4b__entry__3}{#api-data-resrc_id-setMan_O__data_resource_id-entry-api}

| Name | Typ | Beschreibung |
|-|-|-|
| Data_resource_ID | Zeichenfolge | Eindeutiger Bezeichner der zugeordneten Datenressource. In den meisten Fällen können Sie die Aktion „Formularcontroller CTRL_RECORD#SAVE_FORM" verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten" verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren. Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder. |
| Nutzlast | Objekt | Objekt, das das Feld beschreibt, dessen obligatorische Informationen aktualisiert werden sollen. "payload": { "fieldName": "String", "mandatory": Boolean } |
| Payload.fieldName | Zeichenfolge | Name des Formularfelds, dessen Pflichtwert festgelegt werden soll. |
| Payload.obligatorisch | Boolean | Kennzeichnung, die angibt, dass das angegebene Formularfeld obligatorisch ist, d. h. das Formular kann nicht gespeichert werden, ohne dass dieses Feld einen gültigen Wert enthält. Gültige Werte: * Wahr: Feld ist ein Pflichtfeld. * Falsch: Feld ist optional. |
[Tabelle : 34. Parameter]

{#api-data-resrc_id-setMan_O__table_yws_2v3_n4b} {#api-data-resrc_id-setMan_O__table_zws_2v3_n4b__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 35. Rückgaben]

{#api-data-resrc_id-setMan_O__table_zws_2v3_n4b}  
<br />

    api.data.gform.setMandatory({fieldName: 'short_description', mandatory: false});

## api -- api.Data.\<data_resource_id\>.setReadOnly (Objektnutzlast) {#ariaid-title21}

Legt die Lese-/Schreibfähigkeiten des angegebenen Formularfelds fest.
{#api-data-resrc_id-setReadOnly_O__table_d13_ps3_n4b__entry__3}{#api-data-resrc_id-setReadOnly_O__data_resource_id-entry-api}

| Name | Typ | Beschreibung |
|-|-|-|
| Data_resource_ID | Zeichenfolge | Eindeutiger Bezeichner der zugeordneten Datenressource. In den meisten Fällen können Sie die Aktion „Formularcontroller CTRL_RECORD#SAVE_FORM" verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten" verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren. Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder. |
| Nutzlast | Objekt | Objekt, das das Feld beschreibt, dessen Lesbarkeitsinformationen aktualisiert werden sollen. "payload": { "fieldName": "String", "readonly": Boolean } |
| Payload.fieldName | Zeichenfolge | Name des Formularfelds, dessen Lesbarkeit festgelegt werden soll. |
| Nutzlast.schreibgeschützt | Boolean | Kennzeichnung, die die Lese-/Schreibfähigkeiten des angegebenen Formularfelds angibt. Gültige Werte: * Wahr: Feld ist schreibgeschützt. * Falsch: Feld ist Lese-/Schreibzugriff. |
[Tabelle : 36. Parameter]

{#api-data-resrc_id-setReadOnly_O__table_d13_ps3_n4b} {#api-data-resrc_id-setReadOnly_O__table_e13_ps3_n4b__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 37. Rückgaben]

{#api-data-resrc_id-setReadOnly_O__table_e13_ps3_n4b}  
<br />

    api.data.gform.setReadOnly({fieldName: 'short_description', readonly: false});

## api -- api.Data.\<data_resource_id\>.setValue (Objektnutzlast) {#ariaid-title22}

Aktualisiert ein angegebenes GlideForm-Feld mit dem angegebenen Wert. Optional können Sie den Anzeigewert auch mit demselben angegebenen Wert aktualisieren.
Nur der Wert im Formular wird aktualisiert. Der Wert wird nicht in der Datenbank gespeichert.
{#api-data-resrc_id-setValue_O__table_tyh_31d_n4b__entry__3}{#api-data-resrc_id-setValue_O__data_resource_id-entry-api}

| Name | Typ | Beschreibung |
|-|-|-|
| Data_resource_ID | Zeichenfolge | Eindeutiger Bezeichner der zugeordneten Datenressource. In den meisten Fällen können Sie die Aktion „Formularcontroller CTRL_RECORD#SAVE_FORM" verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten" verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren. Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder. |
| Nutzlast | Objekt | Objekt, das das Feld beschreibt, dessen Wert aktualisiert werden soll. "payload": { "displayValue": "String", "fieldName": "String", "value": "String" } |
| Nutzlast.Anzeigewert | Zeichenfolge | Optional. Name des zu aktualisierenden Anzeigewerts. Wenn leer gelassen, wird der Anzeigewert nicht geändert. |
| Payload.fieldName | Zeichenfolge | Name des zu aktualisierenden Formularfelds. |
| Nutzlast.Wert | Zeichenfolge | Wert, mit dem das Feld aktualisiert werden soll. |
[Tabelle : 38. Parameter]

{#api-data-resrc_id-setValue_O__table_tyh_31d_n4b} {#api-data-resrc_id-setValue_O__table_uyh_31d_n4b__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 39. Rückgaben]

{#api-data-resrc_id-setValue_O__table_uyh_31d_n4b}  
<br />

    api.data.gform.setValue({fieldName: 'short_description', value: 'short description'});

## api -- api.Data.\<data_resource_id\>.setVisible (Objektnutzlast) {#ariaid-title23}

Legt die Sichtbarkeit des angegebenen Formularfelds fest.
{#api-data-resrc_id-setVisible_O__table_j5k_gr3_n4b__entry__3}{#api-data-resrc_id-setVisible_O__data_resource_id-entry-api}

| Name | Typ | Beschreibung |
|-|-|-|
| Data_resource_ID | Zeichenfolge | Eindeutiger Bezeichner der zugeordneten Datenressource. In den meisten Fällen können Sie die Aktion „Formularcontroller CTRL_RECORD#SAVE_FORM" verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten" verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren. Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder. |
| Nutzlast | Objekt | Objekt, das das Feld beschreibt, für das die Sichtbarkeit festgelegt werden soll. "payload": { "fieldName": "String", "visibility": Boolean } |
| Payload.fieldName | Zeichenfolge | Name des Formularfelds, dessen Sichtbarkeit festgelegt werden soll. |
| Nutzlast.Sichtbarkeit | Boolean | Kennzeichnung, die angibt, ob das zugeordnete Feld im aktuellen Formular sichtbar ist. Gültige Werte: * Wahr: Feld wird im Formular angezeigt. * Falsch: Feld wird im Formular nicht angezeigt. |
[Tabelle : 40. Parameter]

{#api-data-resrc_id-setVisible_O__table_j5k_gr3_n4b} {#api-data-resrc_id-setVisible_O__table_k5k_gr3_n4b__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 41. Rückgaben]

{#api-data-resrc_id-setVisible_O__table_k5k_gr3_n4b}  
<br />

    api.data.gform.setVisible({fieldName: 'short_description', visibility: false});

## api -- api.Data.\<data_resource_id\>.showFieldMessage (Objektnutzlast) {#ariaid-title24}

Zeigt die angegebene Nachricht neben dem angegebenen Feld an.
{#api-data-resrc_id-showFldMsg_O__table_o35_xgd_n4b__entry__3}{#api-data-resrc_id-showFldMsg_O__data_resource_id-entry-api}

| Name | Typ | Beschreibung |
|-|-|-|
| Data_resource_ID | Zeichenfolge | Eindeutiger Bezeichner der zugeordneten Datenressource. In den meisten Fällen können Sie die Aktion „Formularcontroller CTRL_RECORD#SAVE_FORM" verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten" verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren. Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder. |
| Nutzlast | Objekt | Objekt, das die anzuzeigende Feldnachricht beschreibt. "payload": { "fieldName": "String", "message": "String", "type": "String" |
| Payload.fieldName | Zeichenfolge | Name des Felds, neben dem die Nachricht angezeigt werden soll. |
| Payload.Message | Zeichenfolge | Anzuzeigende Nachricht. |
| Payload.type | Zeichenfolge | Optional. Typ der anzuzeigenden Nachricht. Gültige Werte: * Fehler * Info * Warnung Standard: Info |
[Tabelle : 42. Parameter]

{#api-data-resrc_id-showFldMsg_O__table_o35_xgd_n4b} {#api-data-resrc_id-showFldMsg_O__table_p35_xgd_n4b__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 43. Rückgaben]

{#api-data-resrc_id-showFldMsg_O__table_p35_xgd_n4b}  
<br />

    api.data.gform.showFieldMessage({fieldName: 'short_description', message: 'Error message', type: 'error'});

## api -- api.Data.\<data_resource_id\>.showRelatedList (Objektnutzlast) {#ariaid-title25}

Zeigt die angegebene zugehörige Liste im aktuellen Formular an.
{#api-data-resrc_id-showRelList_O__table_xc2_tn3_n4b__entry__3}{#api-data-resrc_id-showRelList_O__data_resource_id-entry-api}

| Name | Typ | Beschreibung |
|-|-|-|
| Data_resource_ID | Zeichenfolge | Eindeutiger Bezeichner der zugeordneten Datenressource. In den meisten Fällen können Sie die Aktion „Formularcontroller CTRL_RECORD#SAVE_FORM" verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten" verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren. Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder. |
| Nutzlast | Objekt | Objekt, das die anzuzeigende zugehörige Liste beschreibt. "payload": { "listTableName ": "String" } |
| Payload.listTabellenname | Zeichenfolge | Name der zugehörigen Liste, die angezeigt werden soll. Wenn die anzuzeigende Liste über eine Beziehung erfolgt, geben Sie die sys_ID der Liste anstelle des Namens an. Tabelle: Zugehörige Liste \[sys_ui_related_list\] |
[Tabelle : 44. Parameter]

{#api-data-resrc_id-showRelList_O__table_xc2_tn3_n4b} {#api-data-resrc_id-showRelList_O__table_yc2_tn3_n4b__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 45. Rückgaben]

{#api-data-resrc_id-showRelList_O__table_yc2_tn3_n4b}  
Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

    api.data.gform.showRelatedList({listTableName:'incident.parent_incident'});

## api -- api.Data.\<data_resource_id\>.showRelatedLists() {#ariaid-title26}

Zeigt alle zugehörigen Listen an, die dem aktuellen Formular zugeordnet sind.
{#api-data-resrc_id-showRelLists__table_wzd_sl3_n4b__entry__3}{#api-data-resrc_id-showRelLists__data_resource_id-entry-api}

| Name | Typ | Beschreibung |
|-|-|-|
| Data_resource_ID | Zeichenfolge | Eindeutiger Bezeichner der zugeordneten Datenressource. In den meisten Fällen können Sie die Aktion „Formularcontroller CTRL_RECORD#SAVE_FORM" verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten" verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren. Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder. |
[Tabelle : 46. Parameter]

{#api-data-resrc_id-showRelLists__table_wzd_sl3_n4b} {#api-data-resrc_id-showRelLists__table_xzd_sl3_n4b__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 47. Rückgaben]

{#api-data-resrc_id-showRelLists__table_xzd_sl3_n4b}  
<br />

    api.data.gform.showRelatedLists();

## api -- api.Data.\<data_resource_id\>.submit() {#ariaid-title27}

Löst die Formularübermittlung mit der angegebenen UI-Aktion aus.
{#api-data-resrc_id-submit_O__table_zc1_hx3_n4b__entry__3}{#api-data-resrc_id-submit_O__data_resource_id-entry-api}

| Name | Typ | Beschreibung |
|-|-|-|
| Data_resource_ID | Zeichenfolge | Eindeutiger Bezeichner der zugeordneten Datenressource. In den meisten Fällen können Sie die Aktion „Formularcontroller CTRL_RECORD#SAVE_FORM" verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten" verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren. Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder. |
| Nutzlast | Objekt | Objekt, das die UI-Aktion beschreibt, die zum übermitteln des aktuellen Formulars verwendet werden soll. "payload": { "submitActionName": "String" } |
| Payload.submitActionName | Zeichenfolge | Name der UI-Aktion, die zum übermitteln des aktuellen Formulars ausgeführt werden soll. |
[Tabelle : 48. Parameter]

{#api-data-resrc_id-submit_O__table_zc1_hx3_n4b} {#api-data-resrc_id-submit_O__table_ad1_hx3_n4b__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 49. Rückgaben]

{#api-data-resrc_id-submit_O__table_ad1_hx3_n4b}  
<br />

    api.data.gform.submit({submitActionName:'sysverb_ws_save'});

## api -- api.emit(Zeichenfolge eventName, Objektnutzlast) {#ariaid-title28}

Gibt ein Ereignis mit dem angegebenen Namen und der angegebenen Nutzlast aus.
Der ausgegebene Ereignisname muss Teil der Liste der gesendeten Ereignisse der zugehörigen Seitendefinition sein, die in der Tabelle „UX-Macroponent-Definition" \[sys_ux_macroponent\] gespeichert ist. Beliebig api.Ausgeben Anruf, der Ereignisse sendet, die in dieser Tabelle nicht deklariert sind, werden ignoriert.

Weitere Informationen zu Ereignissen finden Sie unter [Arbeiten Sie mit Ereignissen](https://www.servicenow.com/docs/access?context=work-events&version=yokohama&pubname=yokohama-application-development&ft:locale=en-US).
{#api-emit_S_O__table_yyz_njj_n4b__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| eventName | Zeichenfolge | Name des auszugebenden Ereignisses. Dieser Name sollte den Benennungsrichtlinien der UI Framework-Aktion entsprechen: * Muss ein oberer Schlangenfall sein, z. B. ITEM_CHANGED. Alle Buchstaben in Großbuchstaben und alle Leerzeichen wurden durch Unterstriche ersetzt. * Muss in der Vergangenheit liegen, z. B. BUTTON_CLICKED oder USER_SELECTED. {#api-emit_S_O__ul_xgx_cgk_n4b} Weitere Informationen zu diesen Aktionsbenennungsrichtlinien finden Sie unter <https://developer.servicenow.com/dev.do#!/reference/now-experience/sandiego/ui-framework/main-concepts/dispatching-actions>. |
| Nutzlast | Objekt | Optional. Objekt, das die Daten enthält, die mit dem ausgegebenen Ereignis gesendet werden sollen. Dieses Objekt ist Freiform und kann alle Daten enthalten, die für die Entität, die die Daten empfängt, erforderlich sind. Hinweis: Nutzlasten des primitiven Typs „Arbeit", können jedoch zu inkonsistentem Verhalten führen. |
[Tabelle : 50. Parameter]

{#api-emit_S_O__table_yyz_njj_n4b} {#api-emit_S_O__table_zyz_njj_n4b__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 51. Rückgaben]

{#api-emit_S_O__table_zyz_njj_n4b}  
Das folgende Codebeispiel zeigt die Ausgabe eines aufgerufenen Ereignisses NOW_UXF_PAGE#ADD_NOTIFICATIONSMit zugehörigem itemsNutzlast.

    function handler({api}) { 
      api.emit('NOW_UXF_PAGE#ADD_NOTIFICATIONS', { 
        items: [
          { 
            id: 'alert1', 
            status: 'positive', 
            icon: 'check-circle-outline', 
            content: 'Here is some information!', 
            textLinkProps: { 
              label: 'More info',
              href: 'https://www.servicenow.com' 
            }, 
          action: {type: 'acknowledge'} 
          } 
        ] 
      }); 
    } 

## api -- setState(Zeichenfolge stateParam, beliebiger Wert) {#ariaid-title29}

Legt den Wert des angegebenen Client-Statusparameters fest.
Verwenden Sie Client-Statusparameter, um einen freigegebenen Status auf einer Seite beizubehalten. Der freigegebene Status kann dann als Werte an Eigenschaften von Komponenten übergeben werden, die auf der Seite verwendet werden. Sie können auch in mehrseitigen Skripts auf Client-status zugreifen und diese aktualisieren. Ein häufiger Anwendungsfall besteht darin, die von Anwendern in mehreren Formularsteuerelementen auf einer Seite eingegebenen Werte nachzuverfolgen. Wenn das Formular übermittelt wird, kann ein Client-Skript alle in den Client-Statusparametern gespeicherten Werte verwenden, um einen neuen Datensatz mit einem Daten-Broker zu erstellen. Eine Seite kann einen oder mehrere Client-Statusparameter haben, die Sie für eine Seite über den UI Builder deklarieren können. Sie können dann einen Client-Statusparameter an eine oder mehrere Komponenten binden, um den Client-Statusparameter freizugeben oder zu bearbeiten.

api.setState() Aufrufe werden asynchron ausgeführt und aktualisieren die UI nicht unbedingt sofort. Ob der festzulegende Wert von abhängt currentValueDes Client-Statusparameters oder einer der im api-Objekt bereitgestellten Eigenschaften sollten Sie diese Variante von verwenden api.setState() Methode zur Vermeidung der Verwendung veralteter Werte.
{#api-setState_S_A__table_lgw_35q_n4b__entry__3}{#api-setState_S_A__stateParm-entry-api}

| Name | Typ | Beschreibung |
|-|-|-|
| StateParm | Zeichenfolge | Name des zu aktualisierenden Client-Statusparameters. Dieser Name muss in den Client-Statusparametern der zugehörigen Seite deklariert werden. Weitere Informationen zur Deklaration von Client-Statusparametern finden Sie unter [Arbeiten Sie mit Client-Statusparametern](https://www.servicenow.com/docs/access?context=state-parameters&version=yokohama&pubname=yokohama-application-development&ft:locale=en-US). |
| Wert | Beliebig -- muss mit der Deklaration des Client-Statusparameters identisch sein. | Wert, auf den der angegebene Client-Statusparameter festgelegt werden soll. |
[Tabelle : 52. Parameter]

{#api-setState_S_A__table_lgw_35q_n4b} {#api-setState_S_A__table_mgw_35q_n4b__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 53. Rückgaben]

{#api-setState_S_A__table_mgw_35q_n4b}  
Dieses Beispiel zeigt ein Skript, das ausgeführt werden könnte, um den Statusparameter des E-Mail-Clients zu aktualisieren, wenn ein Eingabewert für eine Now-input-Komponente festgelegt ist.

    function handler({api, event}) {
        api.setState('email', event.payload.value);
    }

## api -- setState(Zeichenfolge stateParam, Funktion callbackFn) {#ariaid-title30}

Legt den Wert des angegebenen Client-Statusparameters auf den Wert fest, der von der angegebenen Rückruffunktion zurückgegeben wird.
Die Rückruffunktion wird mit einem Objekt aufgerufen, das zwei Eigenschaften hat: currentValueUnd api. Die Funktion darf niemals mutieren currentValueEigenschaft oder apiObjekt direkt.

Verwenden Sie Client-Statusparameter, um einen freigegebenen Status auf einer Seite beizubehalten. Der freigegebene Status kann dann als Werte an Eigenschaften von Komponenten übergeben werden, die auf der Seite verwendet werden. Sie können auch in mehrseitigen Skripts auf Client-status zugreifen und diese aktualisieren. Ein häufiger Anwendungsfall besteht darin, die von Anwendern in mehreren Formularsteuerelementen auf einer Seite eingegebenen Werte nachzuverfolgen. Wenn das Formular übermittelt wird, kann ein Client-Skript alle in den Client-Statusparametern gespeicherten Werte verwenden, um einen neuen Datensatz mit einem Daten-Broker zu erstellen. Eine Seite kann einen oder mehrere Client-Statusparameter haben, die Sie für eine Seite über den UI Builder deklarieren können. Sie können dann einen Client-Statusparameter an eine oder mehrere Komponenten binden, um den Client-Statusparameter freizugeben oder zu bearbeiten.

api.setState() Aufrufe werden asynchron ausgeführt und aktualisieren die UI nicht unbedingt sofort. Ob der festzulegende Wert von abhängt currentValueDes Client-Statusparameters oder einer der im api-Objekt bereitgestellten Eigenschaften sollten Sie diese Variante von verwenden api.setState() Methode zur Vermeidung der Verwendung veralteter Werte.
{#api-setState_S_F__table_vlt_gyq_n4b__entry__3}{#api-setState_S_F__stateParm-entry-api}

| Name | Typ | Beschreibung |
|-|-|-|
| StateParm | Zeichenfolge | Name des zu aktualisierenden Client-Statusparameters. Dieser Name muss in den Client-Statusparametern der zugehörigen Seite deklariert werden. Weitere Informationen zur Deklaration von Client-Statusparametern finden Sie unter [Arbeiten Sie mit Client-Statusparametern](https://www.servicenow.com/docs/access?context=state-parameters&version=yokohama&pubname=yokohama-application-development&ft:locale=en-US). |
| CallbackFn | Funktion | Rückruffunktion, die ausgeführt werden soll, um den Wert zu erhalten. |
[Tabelle : 54. Parameter]

{#api-setState_S_F__table_vlt_gyq_n4b} {#api-setState_S_F__table_wlt_gyq_n4b__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 55. Rückgaben]

{#api-setState_S_F__table_wlt_gyq_n4b}  
Dieses Beispiel zeigt die Verwendung api.setState Um Anwender bei einer Seite anzumelden.

    function handler({api, event}) {
      const {name, value} = event.payload;
      if (name === 'username' || name === 'password') {
        // Update the loginParameters state object with the username/password value
        api.setState('loginParameters', ({currentValue}) => {
          return {
            ...currentValue,
            [name]: value
          };
        });
      }
    }

## api: api.State.\<client_state_parameter_name\> {#ariaid-title31}

Aktueller Wert des angegebenen Client-Statusparameters.
{#api-state__table_yk3_rmb_n4b__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| \<client_state_parameter_name\> | Beliebig. Die verfügbaren Client-Statusparameter sind von der Seitenkonfiguration abhängig. | Name des Client-Statusparameters. Verfügbare clientstatus hängen von der Client-Skriptimplementierung ab. Verwenden Sie Folgendes, um auf die verfügbaren clientstatus zuzugreifen: `api.Status.<client_state_name> `. Zum Beispiel: function showRelatedLists({api}) { return !api.state.isCustomListSelected; } Hinweis: Diese Eigenschaftswerte sind schreibgeschützt. Verwenden Sie zum Aktualisieren eines Client-Statusparameters [api.setState()](https://servicenow-prod.fluidtopics.net/Ivoe9jqY5Nok4Bm3fsqdgw#api-setState_S_A "Legt den Wert des angegebenen Client-Statusparameters fest."). Das Mutation geschachtelter Objektwerte aus Skripts wird nicht unterstützt. |
[Tabelle : 56. Feld]

{#api-state__table_yk3_rmb_n4b}

