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


---

# Fragt ein GraphQL-Schema aus einer Komponente ab

# Fragt ein GraphQL-Schema aus einer Komponente ab {#ariaid-title1}

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

Greifen Sie auf Datensatzdaten in einer Komponente zu, indem Sie Ihr geskriptetes GraphQL-Schema abfragen.

## Vorbereitungen

Erforderliche Rolle: Administrator  
1. [Erstellen Sie ein GraphQL-Schema](https://servicenow-prod.fluidtopics.net/X2nFeB8MpBbkFrEBf61yxQ#build-graphql-scripted-schema "Erstellen Sie ein GraphQL-Schema, um Daten für GraphQL-Abfragen verfügbar zu machen.").
2. [Testen Sie GraphQL-APIs mit GraphQL Explorer](https://servicenow-prod.fluidtopics.net/06GF6LdGRoISdsAd58XPdA "Testen Sie die Abfrage Ihrer GraphQL-APIs mit einem integrierten GraphQL-Testtool.").
3. [Deaktivieren Sie introspektive Abfragen in Ihrer Produktionsumgebung](https://servicenow-prod.fluidtopics.net/5vjgq9bZkdFPmU0rD5Vb9Q "Konfigurieren Sie das Verhalten des GraphQL-API-Frameworks. Sie können beispielsweise konfigurieren, ob introspektive Abfragen in Ihrem Schema zugelassen werden sollen.").
4. [Erstellen Sie eine anwenderdefinierte Komponente](https://www.servicenow.com/docs/access?context=custom-components&version=yokohama&pubname=yokohama-application-development&ft:locale=en-US).
{#query-schema-from-component__ol_phk_ggc_bmb}

## Prozedur

1. Navigieren Sie zu Ihrem Komponentenverzeichnis.
2. Definieren Sie die Abfrage in Ihren Komponenten Index.js Datei.  

   Entfernen Sie introspektive Abfragen
   :   Verwenden Sie keine introspektiven Abfragen für Komponenten, die in einer Produktionsumgebung bereitgestellt werden.

   Schließen Sie anwendbare Namespaces ein
   :   Schließen Sie sowohl die Anwendungs- als auch die Schemanamespaces in die Abfrage ein.

   Langsame Antwortfelder zurückstellen
   :   Sie können anwenden `@Zurückstellen `Abfrageanweisung zu einem Fragment, um die Verarbeitung eines oder mehrerer langsam antwortender Felder zu verzögern. Durch das Zurückstellen von Feldern mit langsamer Antwort kann die Abfrage zuerst andere Felder zurückgeben.  
       Warnung:  
   Vermeiden Sie es, diese Abfrageanweisung wahllos anzuwenden, da dies auch zu Leistungsverschlechterungen führen kann. Führen Sie Leistungstests durch, um zu bestimmen, welche Felder für eine bessere Leistung zurückgestellt werden können.  
   Hinweis:  

       const incidentQuery = `query ($sys_id: String!) {
           query (sys_id: $sys_id) {
               incident {
                   _results {
                       sys_id {
                           displayValue
                       }
                   }
               }
           }
       }`;

3. Fügen Sie oben im Skript die folgende Zeile hinzu, um zu importieren CreateGraphQLEffect API in Ihre Komponente.  

       import {createGraphQLEffect} from '@servicenow/ui-effect-graphql';

4. Rufen Sie die Abfrage mit auf `CreateGraphQLEffect `API. Weitere Informationen zu dieser API finden Sie unter [Entwickler-Website](https://developer.servicenow.com/dev.do#!/guide/sandiego/now-experience/ui-framework/api-reference/effect-graphql).
5. Erstellen Sie Aktions-Handler, um das Ergebnis der Abfrage zu verwalten.  

       actionHandlers: {
          [DATA_FETCH_REQUESTED]: dataFetchHandler,
          [DATA_FETCH_STARTED]: ({updateState}) => updateState({loading: true}),
          [DATA_FETCH_SUCCEEDED]: ({action, updateState}) => updateState({data: action.payload}),
          [DATA_FETCH_FAILED]: () => { /* handle network error */ },
        }

## Beispiel

Dieses Beispiel zeigt eine vollständige Komponente, einschließlich Abfrage, GraphQL-API-Aufruf und Aktions-Handler zur Verwaltung der Antwort.  

    import {createCustomElement} from '@servicenow/ui-core';
    import snabbdom from '@servicenow/ui-renderer-snabbdom';
    import {createGraphQLEffect} from '@servicenow/ui-effect-graphql';

    const GQL_QUERY = `
    query query ($active: Boolean) {
        now {
            mySchema (active: $active) {
                myField {
                    value
                }
             }
        }
    }`;
      
    const DATA_FETCH_REQUESTED = 'DATA_FETCH_REQUESTED';
    const DATA_FETCH_STARTED = 'DATA_FETCH_STARTED';
    const DATA_FETCH_SUCCEEDED = 'DATA_FETCH_SUCCEEDED';
    const DATA_FETCH_FAILED = 'DATA_FETCH_FAILED';
      
    const dataFetchHandler = createGraphQLEffect(GQL_QUERY, {
      variableList: ['active'],
      startActionType: DATA_FETCH_STARTED,    // gql http request started
      successActionType: DATA_FETCH_SUCCEEDED // gql request succeeded with result
      errorActionType: DATA_FETCH_FAILED      // gql http network request error (actual schema / server errors will succeed with error objects
    });

    const component = createCustomElement('now-component', {
      renderer: {type: snabbdom},
      view(state) {
        if(state.loading)
          return <div>Loading...</div>;

        if(!state.data)
          return <div>No Data</div>;

        return <div>My value: {state.data.data.now.mySchema.myField.value}</div>;
      },
      actionHandlers: {
       [DATA_FETCH_REQUESTED]: dataFetchHandler,
       [DATA_FETCH_STARTED]: ({updateState}) => updateState({loading: true}),
       [DATA_FETCH_SUCCEEDED]: ({action, updateState}) => updateState({data: action.payload}),
       [DATA_FETCH_FAILED]: () => { /* handle network error */ },
      }
    });


