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


---

# REST APIs

# REST APIs {#ariaid-title1}

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

REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.
Die Now PlatformStellt verschiedene REST-APIs bereit, die standardmäßig aktiv sind. Diese APIs bieten die Möglichkeit, mit verschiedenen zu interagieren ServiceNowFunktionalität in Ihrer Anwendung. Diese Funktionalität umfasst die Möglichkeit, CRUD-Vorgänge (Erstellen, Lesen, Aktualisieren und Löschen) für vorhandene Tabellen ( Tabelle API), Daten in einfügen, Informationen aus abrufen und Transformationen für eine MetricBase-Datenbank ausführen ( MetricBase-Zeitreihe API und viele andere.

Eine Liste der verfügbaren REST-APIs finden Sie unter [REST-API-Referenz](https://servicenow-prod.fluidtopics.net/yfzJY_q_SSBWSvv8_qNjRw "Verwenden Sie REST-Schnittstellen, um auf Daten in Ihrer Instanz zuzugreifen.").  
Hinweis:  
Sie können eingehende API-Transaktionen in den Transaktionsprotokollen anzeigen. Verwenden Sie einen Link wie den folgenden, um die Transaktionen für den aktuellen Tag anzuzeigen:

`https://<instancename>.service-now.com/syslog_transaction_list.do?sysparm_query=sys_created_onONToday%40javascript%3Ags.beginningOfToday()%40javascript%3Ags.endOfToday()%5Etype%3Drest`

## REST-URI-Format und verfügbare Parameter {#c_RESTAPI__section_rlc_q3b_zhb}

ServiceNow REST-APIs folgen dem Standard-REST-API-Protokoll. Sie bieten auch „anwenderdefinierte" URI und Abfrageparameter, um die Abwärtskompatibilität sicherzustellen, und bieten zusätzliche Funktionen wie das Paginieren langer Ergebnislisten. Die folgenden Abschnitte beschreiben die Funktionalität hinter diesen anwenderdefinierten Parametern, die alle optional sind.

## REST API-Versionsverwaltung {#c_RESTAPI__section_orl_rm2_whb}

ServiceNowREST-API-URIs können eine Versionsnummer enthalten, z. B. /api/now/v1/table/{tableName} . Versionsnummern identifizieren die Endpunktversion, auf die ein URI zugreift. Durch Angabe einer Versionsnummer in Ihren URIs können Sie sicherstellen, dass zukünftige Updates der REST-API Ihre Integration nicht beeinträchtigen.

URIs, die keine Versionsnummer in der URI angeben, z. B. /api/now/table/{tableName} , Verwenden Sie den neuesten REST-Endpunkt für Ihre Instanzversion.

## Unterstützte HTTP-Anforderungsmethoden {#c_RESTAPI__supported_HTTP_methods}

* GET
* LÖSCHEN
* HEAD
* PATCH
* POST
* PUT
{#c_RESTAPI__ul_zlt_x2d_jlb}

Weitere Informationen zu diesen Methoden finden Sie unter [RFC-2616 Hypertext-Übertragungsprotokoll](https://www.rfc-editor.org/rfc/rfc2616#page-51)Dokument.  
Hinweis:  
* Sie können die HEAD-Methoden anstelle von GET-Methoden verwenden, um eine Antwort ohne Antworttext zurückzugeben.
* Sie können bei POST-, PUT- und PATCH-Vorgängen nicht mehrere Datensätze übergeben. Wenn Sie dies tun, wird nur der erste Datensatz verarbeitet, der Rest wird ignoriert.
* Sie können „POST", „PUT" und „PATCH" nicht verwenden, um Datensätze in eine Datenbankansicht einzufügen oder zu aktualisieren, da Datenbankansichten schreibgeschützt sind.
{#c_RESTAPI__ul_akw_c5y_gtb}

## Datenformat-Header {#c_RESTAPI__section_uh3_fn2_whb}

REST-APIs erfordern AcceptUnd Content-TypeAnforderungsheader für die richtige Datenformatierung für Anforderungen, die einen Anforderungstext oder Antworttext enthalten. Für POST-, PUT-, PATCH- und LÖSCHVORGÄNGE müssen Sie beide Header angeben. GET- und HEAD-Vorgänge erfordern nur AcceptHeader. Fehler beim Bereitstellen der erforderlichen Header-Ergebnisse in 400 Ungültige Anforderung Fehler.

Für die meisten ServiceNowREST-APIs diese Anforderungsheader unterstützen die folgenden Werte:

* Akzeptieren: application/json, application/xml
* Inhaltstyp: application/json, application/xml

{#c_RESTAPI__ul_cns_g2r_pp}

Eine Liste der spezifischen Werte, die von jedem Endpunkt unterstützt werden, finden Sie unter [REST-API-Referenz](https://servicenow-prod.fluidtopics.net/yfzJY_q_SSBWSvv8_qNjRw "Verwenden Sie REST-Schnittstellen, um auf Daten in Ihrer Instanz zuzugreifen.").

## Andere Header {#c_RESTAPI__section_ay1_3n2_whb}

Alle Anforderungen können einen Authentifizierungsheader enthalten, der die Anwenderanmeldeinformationen angibt, die für die Authentifizierung verwendet werden sollen.

Sie können HTTP-Methoden wie GET oder POST auch überschreiben, indem Sie festlegen X-http-method-overrideHeader.

## Spezielle Datenverarbeitung {#c_RESTAPI__section_q1p_krf_htb}

Im Folgenden werden einige der Datenverarbeitungsnuancen in der REST-API beschrieben.

* So löschen Sie ein Datenfeld: Mit Ausnahme von Auswahlfeldern können Sie einen leeren Wert im Parameter übergeben, um den Wert in der Datenbank zu löschen. Beispiel: Senden `{"Kurzbeschreibung":""} `Löscht short_descriptionFeld für den angegebenen Datensatz.
* Wie Währungsfelder behandelt werden: Zurückgegebene Währungswerte werden basierend auf dem Gebietsschema des Anwenders in die lokale Währung konvertiert. Beim Einfügen von Daten wird keine Konvertierung durchgeführt. Dieses Verhalten gilt für Felder der Typen `Währung `Oder `Preis `.

  Wenn beispielsweise ein Anwender im britischen Gebietsschema Datensätze mit Währungswerten in USD abfragt, werden die zurückgegebenen Werte in GBP konvertiert. Wenn dieser Anwender jedoch einen neuen Datensatz mit dem Währungsfeldwert in GBP hinzufügt, wird der Wert in GBP gespeichert, ohne in USD konvertiert zu werden. Dieser GBP-Wert wird in USD angezeigt, wenn er von einem Anwender im US-Gebietsschema abgefragt wird.
* UI-Datenanzeige vs. An einem REST-Endpunkt übergebene Werte: Die UI zeigt die Datenbank an [Anzeigewert](https://www.servicenow.com/docs/access?context=c_DisplayValues&version=yokohama&pubname=yokohama-platform-administration&ft:locale=en-US), Die manipulierte Daten sind. Ein REST-Endpunkt fügt standardmäßig die ist-Werte ein und aktualisiert sie, die sich vom Anzeigewert unterscheiden können. Sie können einen REST-Endpunkt erzwingen, übergebene Werte als Anzeigewerte zu behandeln, indem Sie festlegen [sysparm_input_display_value](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ#c_RESTAPI__REST-sysparm_input_display_value-row)Anforderungsparameter auf „wahr".
{#c_RESTAPI__ul_xj3_trf_htb}

## Anwenderdefinierte Abfrageparameter {#c_RESTAPI__section_m4z_jnb_zhb}

Die ServiceNowREST-APIs verwenden die folgenden Abfrageparameter für viele der verfügbaren APIs, um ein konsistentes Verhalten in allen APIs zu gewährleisten. Verwenden Sie diese Parameter, um große Datensatzsätze zu paginieren, Ergebnisse zu filtern und die Anzahl der in einer einzelnen Abfrage zurückgegebenen Datensätze einzuschränken.
{#c_RESTAPI__table_z1v_znb_zhb__entry__2}{#c_RESTAPI__sysparm-limit-RESTAPI}{#c_RESTAPI__sysparm_fields_entry-RESTAPI}{#c_RESTAPI__entry-sysparm_input_display_value-REST_API}{#c_RESTAPI__sysparm_offset-ph-RESTAPI}{#c_RESTAPI__sysparm-query-RESTAPI}{#c_RESTAPI__sysparm_view-entry-RESTAPI}

|   |   |
|-|-|
| Sysparm_limit | Maximale Anzahl zurückzugebender Datensätze. Für Anforderungen, die diese Anzahl von Datensätzen überschreiten, verwenden Sie sysparm_offsetParameter zum Paginieren des Datensatzabrufs. Dieser Grenzwert wird vor der ACL-Auswertung angewendet. Wenn keine Datensätze zurückgegeben werden, einschließlich der Datensätze, auf die Sie Zugriff haben, ordnen Sie die Datensatzreihenfolge so an, dass Datensätze, auf die Sie zuerst zugreifen können, zurückgegeben werden. Hinweis: Ungewöhnlich groß sysparm_limitWerte können sich auf die Systemleistung auswirken. Datentyp: Zahl Standard: 20 Maximum: 100 |
| Sysparm_fields | Kommagetrennte Liste von Feldern, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Datentyp: Zeichenfolge Standard: Alle Felder zurückgeben. |
| sysparm_input_display_value | Kennzeichnung, die angibt, ob Feldwerte mithilfe des Anzeigewerts oder des ist-Werts festgelegt werden sollen. Abhängig von den verschiedenen Arten von Feldern kann der Endpunkt die übergebenen Anzeigewerte manipulieren, um die richtigen Werte in der Datenbank zu speichern. Wenn Sie beispielsweise den Anzeigenamen für ein Referenzfeld senden, speichert der Endpunkt die sys_ID für diesen Wert in der Datenbank. Bei Datums- und Uhrzeitfeldern wird der Datums- und Uhrzeitwert an die Zeitzone des aktuellen Anwenders angepasst. Bei „falsch" werden der Datums- und Uhrzeitwert mithilfe der GMT-Zeitzone eingefügt. Gültige Werte: * Wahr: Behandelt Eingabewerte als Anzeigewerte, und sie werden so bearbeitet, dass sie ordnungsgemäß in der Datenbank gespeichert werden. * Falsch: Behandelt Eingabewerte als ist-Werte und speichert sie ohne Manipulation in der Datenbank. {#c_RESTAPI__ul_shq_cfx_pp} Datentyp: Boolescher Wert Standard: Falsch: Entspricht dem Datentyp, der während des Datenabrufs (GET-Methoden) zurückgegeben wird, d. h. den tatsächlichen Werten. Hinweis: Um den Wert eines verschlüsselten Felds festzulegen, müssen Sie diesen Parameter auf festlegen <kbd class="ph userinput">Wahr </kbd>. Wenn dieser Parameter nicht auf „wahr" festgelegt ist, werden an verschlüsselte Felder übermittelte Werte nicht gespeichert. Darüber hinaus muss der anfordernde Anwender über den entsprechenden Verschlüsselungskontext verfügen, bevor die Anforderung übermittelt wird. Verschlüsselte Felder werden für Anwender ohne den entsprechenden Verschlüsselungskontext ausgeblendet. Weitere Informationen zur Feldverschlüsselung finden Sie unter [Encryption](https://www.servicenow.com/docs/access?context=encryption-landing&version=yokohama&pubname=yokohama-platform-security&ft:locale=en-US). |
| Sysparm_Offset | Startdatensatzindex, für den mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktionalität ermöglicht den Abruf aller Datensätze, unabhängig von der Anzahl der Datensätze, in kleinen verwaltbaren Blöcken. Beispiel: Wenn Sie diesen Endpunkt zum ersten Mal aufrufen, sysparm_offsetIst auf „0" festgelegt. Um einfach alle verfügbaren Datensätze durchzublättern, verwenden Sie `Sysparm_Offset=sysparm_Offset+sysparm_limit `, Bis Sie das Ende aller Datensätze erreichen.{#c_RESTAPI__sysparm_offset-p-RESTAPI} Übergeben Sie keine negative Zahl in sysparm_offsetParameter. Datentyp: Zahl Standard: 0 |
| Sysparm_query | [Codierte Abfrage](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=yokohama&pubname=yokohama-platform-user-interface&ft:locale=en-US)Wird verwendet, um den Ergebnissatz zu filtern. Sie können einen UI-Filter verwenden, um eine ordnungsgemäß codierte Abfrage zu erhalten. Syntax: `Sysparm_query=<col_name> <operator> <value> `. * \<col_name\>: Name der Tabellenspalte, nach der gefiltert werden soll. * \<operator\>: Unterstützt die folgenden Werte: * =: Stimmt genau mit \<value\> überein. * !=: Stimmt nicht mit \<value\> überein. * \^: Logisch UND mehrere Abfrageanweisungen. * \^ODER: Logisch ODER mehrere Abfrageanweisungen. * LIKE: \<col_name\> enthält die angegebene Zeichenfolge. Funktioniert nur für \<col_name\>-Felder, deren Datentyp „Zeichenfolge" ist. * STARTSMIT: \<col_name\> beginnt mit der angegebenen Zeichenfolge. Funktioniert nur für \<col_name\>-Felder, deren Datentyp „Zeichenfolge" ist. * ENDSWITH: \<col_name\> endet mit der angegebenen Zeichenfolge. Funktioniert nur für \<col_name\>-Felder, deren Datentyp „Zeichenfolge" ist. {#c_RESTAPI__ul_bgf_5vz_mlb} \<value\>: Wert, mit dem abgeglichen werden soll. {#c_RESTAPI__ul_g2p_svz_mlb} Bei allen Parametern wird zwischen Groß- und Kleinschreibung unterschieden. Abfragen können mehr als einen Eintrag enthalten, z. B. Sysparm_query=\<col_name\> \<operator\> \<value\>\[\<operator\> \<col_name\> \<operator\> \<value\>\] . Zum Beispiel: `(Sysparm_query=caller_ID=javascript:gs.getUserID()^Active=wahr)` Codierte Abfragen unterstützen auch die Funktion „Sortieren nach". Um Antworten basierend auf bestimmten Feldern zu sortieren, verwenden Sie `SORTIEREN NACH `Und `ORDERBYDESC `Klauseln in sysparm_query. Syntax: * `ORDERBY<col_name>` * `ORDERBYDESC<col_name>` {#c_RESTAPI__ul_sq4_rc1_nlb} Beispiel: `Sysparm_query=Active=wahr^ORDERBYNummer^ORDERBYDESCCATEGORY ` Diese Abfrage filtert alle aktiven Datensätze und ordnet die Ergebnisse in aufsteigender Reihenfolge nach Nummer und dann in absteigender Reihenfolge nach Kategorie an. Wenn ein Teil der Abfrage ungültig ist, z. B. durch Angabe eines ungültigen Feldnamens, ignoriert die Instanz den ungültigen Teil. Gibt dann Zeilen zurück, die nur den gültigen Teil der Abfrage verwenden. Sie können dieses Verhalten mithilfe der Eigenschaft steuern glide.invalid_query.returns_no_rows. Legen Sie diese Eigenschaft auf „wahr" fest, um keine Zeilen für eine ungültige Abfrage zurückzugeben. Hinweis: Die glide.invalid_query.returns_no_rowsEigenschaft steuert das Verhalten aller Abfragen in der Instanz, z. B. in Listen, Skripts ( GlideRecord.Abfrage() ) Und Webservice-APIs. Datentyp: Zeichenfolge |
| sysparm_view | UI-Ansicht, für die die Daten gerendert werden sollen. Bestimmt die in der Antwort zurückgegebenen Felder. Gültige Werte: * Desktop * Mobile * both {#c_RESTAPI__ul_wr5_5xl_tgb} Wenn Sie auch angeben sysparm_fieldsParameter, hat Vorrang. Datentyp: Zeichenfolge |
[ ]

{#c_RESTAPI__table_z1v_znb_zhb}

## Dot-Walking in REST-API-Anforderungen {#c_RESTAPI__section_k5v_sr1_xhb}

Sie können Dot-Walking verwenden, wenn Sie angeben sysparm_queryOder sysparm_fieldsParameter in Anforderungen an REST-APIs, die diese Parameter unterstützen.  
Hinweis:  
Die Importsatz-API unterstützt kein Dot-Walking.

## Dot-Walking in sysparm_query {#c_RESTAPI__section_owg_vr1_xhb}

Sie können Abfragen anhand zugehöriger Datensatzwerte durch Dot-Walking in filtern sysparm_queryParameter. Sie können beispielsweise alle Incident-Datensätze abrufen, in denen der Incident vorliegt Unternehmen Hat eine bestimmte Aktiensymbol Wert.

https://\<instance\>.service-now.com/api/now/table/incident?sysparm_query=company.stock_symbol=NYX

## Dot-Walking in sysparm_fields {#c_RESTAPI__section_ufb_wr1_xhb}

Sie können Feldwerte aus mehreren Tabellen durch Dot-Walking in anzeigen sysparm_fieldsParameter. Sie können beispielsweise abrufen Name , SYS_ID , Und Abteilung Von jedem Anwender, der bestimmte Rollen sowie die Rolle hat Name .

Die Anforderung wird in der Tabelle „Anwenderrollen" \[sys_user_has_role\] ausgeführt, die eine viele-zu-viele-Beziehung zwischen Anwendern und Rollen definiert. Die Antwort enthält Feldwerte aus den Tabellen Anwender \[sys_user\] und Rollen \[sys_user_role\].

https://\<instance\>.service-now.com/api/now/table/sys_user_has_role?sysparm_fields=role%2Crole.name%2Cuser%2Cuser.name%2Cuser.sys_id%2Cuser.department\&sysparm_query=role%3D3d43716d0f6002003a2d47bce1050e0d%5EORrole%3Dac73b52d0f6002003a2d47bce1050eec\&sysparm_display_value=true

    {
    "result": [
      {
       "user.name": "Fred Johnson",
       "user.sys_id": "f5a3716d0f6002003a2d47bce1050ed4",
       "role.name": "support",
       "user.department": {
          "display_value": "Accounting",
          "link": "https://<instance>.service-now.com/api/now/table/cmn_department/5b3b13530f58c2003a2d47bce1050e96"
        },
       "role": {
          "display_value": "support",
          "link": "https://<instance>.service-now.com/api/now/table/sys_user_role/3d43716d0f6002003a2d47bce1050e0d"
        },
       "user": {
          "display_value": "Fred Johnson",
          "link": "https://<instance>.service-now.com/api/now/table/sys_user/f5a3716d0f6002003a2d47bce1050ed4"
        }
      },
      {
       "user.name": "Fred Johnson",
       "user.sys_id": "f5a3716d0f6002003a2d47bce1050ed4",
       "role.name": "asset_mgmt",
          "user.department": {
          "display_value": "Accounting",
          "link": "https://<instance>.service-now.com/api/now/table/cmn_department/5b3b13530f58c2003a2d47bce1050e96"
         },
        "role": {
           "display_value": "asset_mgmt",
           "link": "https://<instance>.service-now.com/api/now/table/sys_user_role/ac73b52d0f6002003a2d47bce1050eec"
          },
        "user": {
           "display_value": "Fred Johnson",
           "link": "https://<instance>.service-now.com/api/now/table/sys_user/f5a3716d0f6002003a2d47bce1050ed4"
           }
        }
      ]
    }

## REST-API-HTTP-Antwortcodes {#c_RESTAPI__section_p5z_c42_whb}

Aufrufe an REST-Endpunkte geben HTTP-Antwortcodes zurück. Sie können diese Antwortcodes verwenden, um sicherzustellen, dass die REST-API ordnungsgemäß ausgeführt wird. Wenn nicht, gibt der Endpunkt einen Fehlerantwortcode zurück. Verwenden Sie die Informationen in der Fehlerantwort, um Probleme mit Ihrem Anrufformat zu beheben. Eine Liste der standardmäßigen Antwortcodes, die ein Endpunkt zurückgeben kann, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/9Xv9oa1y5A3vVbAgAaBorg "REST-Nachrichten, die an eine Instanz gesendet werden, geben einen bestimmten HTTP-Antwortcode zurück."). Für die Liste der Antwortcodes, die von einem bestimmten zurückgegeben werden ServiceNowREST-API, siehe [REST-API-Referenz](https://servicenow-prod.fluidtopics.net/yfzJY_q_SSBWSvv8_qNjRw "Verwenden Sie REST-Schnittstellen, um auf Daten in Ihrer Instanz zuzugreifen.").

## REST-API-Sicherheit {#c_RESTAPI__section_mm2_3l2_whb}

Standardmäßig ServiceNowREST-APIs verwenden Standardauthentifizierung oder OAuth, um Anwenderzugriff auf REST-APIs/Endpunkte zu autorisieren. Sie können Ihre Instanz auch für die Verwendung konfigurieren [Multifaktor-Authentifizierung](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ#c_RESTAPI__multi-factor-auth-inbound-REST)Um auf REST-APIs zuzugreifen.

Die Anwender-ID, die Sie in einem REST-Endpunkt-Aufruf angeben, unterliegt der Zugriffssteuerung wie ein interaktiver Anwender. Jede Anforderung erfordert die richtigen Authentifizierungsinformationen, z. B. Anwendername und Passwort. Stellen Sie sicher, dass jede Endpunktanforderung einen Autorisierungsheader mit ausreichenden Anmeldeinformationen für den Zugriff auf den Endpunkt enthält.

ServiceNow REST-APIs unterstützen auch Cookies, die die Bindung an die vorhandene Sitzung ermöglichen.

Informationen zur Verwendung des Zertifikats zum Aufrufen der API und Informationen zur gegenseitigen Authentifizierung finden Sie unter [Zertifikatbasierte Authentifizierung](https://www.servicenow.com/docs/access?context=certificate-based-authentication&version=yokohama&pubname=yokohama-platform-security&ft:locale=en-US).

REST-API-Zugriffsrichtlinien mit den Filterkriterien wie IP, Rolle, Gruppe und Schränken Sie den Umfang der API ein, die Sie verwenden können [REST API Auth Scope](https://www.servicenow.com/docs/access?context=rest-api-auth-scope&version=yokohama&pubname=yokohama-platform-security&ft:locale=en-US). Weitere Informationen zur REST-API-Zugriffsrichtlinie finden Sie unter [REST-API-Zugriffsrichtlinien](https://www.servicenow.com/docs/access?context=inbound-authentication-profile&version=yokohama&pubname=yokohama-platform-security&ft:locale=en-US).

Sie können eine einzelne Richtlinie erstellen, um die eingehende Anforderung auf globaler REST-API-Ebene zu blockieren, indem Sie die REST-API-Zugriffsrichtlinie außerhalb des vertrauenswürdigen Netzwerks und auf einer grundlegenden REST-Authentifizierungsebene verwenden.

## REST-API-Rollen {#c_RESTAPI__section_iwr_fm2_whb}

Zusätzlich zur Anwenderauthentifizierung kann jeder REST-Endpunkt verschiedene Anforderungen für die Rollen haben, die für den Zugriff auf den Endpunkt erforderlich sind. Einige erfordern die Administratorrolle, andere erfordern API-spezifische Rollen. Rollenanforderungen werden in der Zugriffssteuerungsliste (ACL) angegeben, die der REST-API/dem Endpunkt zugeordnet ist. Einzelheiten zu den gültigen Rollen für jede REST-API/jeden Endpunkt finden Sie unter [REST-API-Referenz](https://servicenow-prod.fluidtopics.net/yfzJY_q_SSBWSvv8_qNjRw "Verwenden Sie REST-Schnittstellen, um auf Daten in Ihrer Instanz zuzugreifen.")Oder suchen Sie die zugeordnete ACL für die API/den Endpunkt in einer Instanz über Systemsicherheit \> Zugriffssteuerung (ACL) .

## REST-API-ACLs {#c_RESTAPI__section_owx_4r2_nbb}

REST-API-ACLs definieren Kriterien, z. B. die erforderlichen Rollen und Bedingungen, die ein Anwender erfüllen muss, um auf zuzugreifen ServiceNowREST-API oder Endpunkt. Eine einzelne ACL kann für eine gesamte REST-API definiert werden, z. B. die ACLs für Tabellen-API und Anhang-API, oder für einen einzelnen Endpunkt, z. B. die ACL Clotho_Rest_put, die nur für gilt MetricBaseMethoden PLATZIEREN.

Folgendes ServiceNowREST-API-ACLs sind im Basissystem verfügbar, sind jedoch standardmäßig deaktiviert. Alle anderen ServiceNowREST-API-ACLs sind standardmäßig aktiv.

* Tabellen-API
* Aggregat-API
* Importsatz-API
* Anhang-API

{#c_RESTAPI__ul_wws_wr2_nbb}

Weitere Informationen zu ACLs finden Sie unter [Regeln für Zugriffssteuerungsliste](https://www.servicenow.com/docs/access?context=access-control-rules&version=yokohama&pubname=yokohama-platform-security&ft:locale=en-US).  
Wichtig:  
Sie sollten die Namen von REST-API-ACLs niemals ändern.

## REST-API-Tabellenzugriff {#c_RESTAPI__section_l5h_rr2_whb}

Standardmäßig sind alle Tabellen, einschließlich Basissystemtabellen, globalen Tabellen und bereichsbezogenen Tabellen, über Webservices zugänglich. Sie müssen alle Sicherheitsanforderungen für Webservices erfüllen, z. B. Standardauthentifizierung und ACLs, um über Webservices auf Tabellen zuzugreifen. Felder, für die die aufrufende Entität aufgrund von ACLs keine Rechte hat, werden nicht in einer REST-Abfrageantwort zurückgegeben.

Um den Zugriff auf Tabellen ohne Authentifizierung oder Autorisierung zu ermöglichen, fügen Sie der Tabelle „öffentliche Seiten" \[sys_public\] den Tabellennamen mit dem Status hinzu Aktiv . Die REST-Schnittstelle erzwingt weiterhin alle definierten ACLs in zugeordneten Tabellen. Wenn die Durchsetzung der Zugriffssteuerungsliste nicht das gewünschte Verhalten ist, müssen Sie die Zugriffssteuerungslisten in den Tabellen deaktivieren. Es wird jedoch nicht empfohlen, Ihre APIs öffentlich zu machen, da dies dem öffentlichen Zugriff ermöglicht, Daten in der Instanz zu aktualisieren.

Sie können auch den direkten Webservice-Zugriff auf Tabellen mit steuern Zugriff auf diese Tabelle über Webservices zulassen Aktivieren Sie das Kontrollkästchen in den Zugriffseinstellungen für die Tabellenanwendung. Sie müssen dieses Kontrollkästchen aktivieren, um die Webservice-Interaktion mit der Tabelle zu aktivieren.  
Hinweis:  
Die Anwendungszugriffsfelder, die CRUD-Vorgänge steuern, z. B. Kann lesen Oder Kann erstellen Nicht auf Webserviceanforderungen anwenden.

## Multifaktor-Authentifizierung für eingehende REST {#c_RESTAPI__multi-factor-auth-inbound-REST}

Ab dem Yokohama-Release ist die Multifaktor-Authentifizierung (MFA) für die REST-API-Authentifizierung mit Standardauthentifizierung standardmäßig nicht erforderlich. Weitere Informationen finden Sie hier [KB-artikel](https://support.servicenow.com/kb?id=kb_article_view&sysparm_article=KB1745551).

## REST-Antworten für Multifaktor-Authentifizierung {#c_RESTAPI__section_dkm_vx1_xhb}

Die Antwort auf eine MFA-Authentifizierungsanforderung variiert je nach Gültigkeit der angegebenen Anmeldeinformationen und des MFA-Tokens.
{#c_RESTAPI__table_btf_ylc_55__entry__2}

| Ergebnis | Beschreibung |
|-|-|
| Anmeldeinformationen für Standardauthentifizierung und MFA-Token sind gültig | Anwender wurde authentifiziert und die Sitzung wurde erstellt. Die Anforderung wird normal verarbeitet. |
| Anmeldeinformationen für Standardauthentifizierung sind gültig, das MFA-Token ist jedoch ungültig oder fehlt | Antwort gibt Fehler 401 zurück. Die Antwort enthält den Header X-MFA_TOKEN mit dem Wert Ungültig . |
| Anmeldeinformationen für Standardauthentifizierung sind ungültig | Antwort gibt Fehler 401 zurück. Der Header „X-MFA_TOKEN" ist nicht in der Antwort enthalten. |
[Tabelle : 1. Antworten]

{#c_RESTAPI__table_btf_ylc_55}

## REST-API-CORS-UNTERSTÜTZUNG {#c_RESTAPI__section_hpl_csl_whb}

Die REST-API unterstützt die Sicherheit der ursprungsübergreifenden Ressourcenfreigabe (CORS). Mit der CORS-Unterstützung können Sie definieren, welche Domänen auf jede REST-API zugreifen können. Indem Sie eine CORS-Regel für eine Domäne definieren, können Sie ursprungsübergreifende Anforderungen aus dieser Domäne zulassen. Ursprungsübergreifende Anforderungen können nicht von Domänen ohne CORS-Regel gestellt werden.  
Hinweis:  
Die CORS-Unterstützung gilt nur für REST-APIs, einschließlich geskripteter REST-Webservices. Andere Webservice-APIs, z. B. die SOAP-API, unterstützen CORS nicht.

Sie können CORS so konfigurieren, dass nur auf bestimmte APIs/Endpunkte, HTTP-Methoden und Header aus anderen Domänen zugegriffen wird. Sie können beispielsweise Anforderungen auf beschränken Tabelle API aus einer bestimmten Domäne, um nur ABRUFVORGÄNGE zuzulassen.

Navigieren Sie zu , um die in Ihrer Instanz definierten CORS-Regeln anzuzeigen System-WebservicesCORS-Regelnan.

Sie können die CORS-Unterstützung für eine Instanz deaktivieren, indem Sie festlegen glide.rest.cors.enabledEigenschaft bis Falsch . Wann Falsch , Für eingehende REST-Anforderungen wird keine CORS-Evaluierung durchgeführt. Diese Eigenschaft ist Wahr Standardmäßig.

## REST-API-Explorer {#c_RESTAPI__section_y4h_5n1_xhb}

Der REST-API-Explorer ist ein ServiceNowTool, das Informationen aus Ihrer Instanz verwendet, um eine Liste von Endpunkten, Methoden und Variablen bereitzustellen, die Sie zum Erstellen und Senden von REST-Anforderungen verwenden können.

Nachdem Sie die Anforderung erstellt haben, stellt der REST API Explorer Codebeispiele in mehreren Programmiersprachen bereit, die Sie zum Initiieren der Anforderung verwenden können, sowie detaillierte Anforderungs- und Antwortinformationen.

Um auf den REST-API-Explorer zuzugreifen, navigieren Sie in Ihrer Instanz zu System-WebservicesREST-API-Exploreran. Sie müssen über die Rolle Rest_api_Explorer verfügen, um auf den REST API Explorer zuzugreifen. Weitere Informationen finden Sie unter [Verwenden Sie den REST-API-Explorer](https://servicenow-prod.fluidtopics.net/QZyr9s_~V0xB9fqGOlvJ4A "In diesem Tutorial verwenden Sie den REST API Explorer, um zu testen ServiceNowREST-APIs.").  
Warnung:  
Der REST-API-Explorer interagiert mit Daten in der aktuellen Instanz. Seien Sie vorsichtig, wenn Sie mit Anforderungen arbeiten, die Daten in einer Produktionsinstanz erstellen, bearbeiten oder löschen.

## Unterstützung für automatisiertes Test-Framework {#c_RESTAPI__section_pcq_lxp_g3b}

Das automatisierte Test-Framework (ATF) unterstützt eingehende REST-Testschritte. Sie können automatisierte Tests für anwenderdefinierte eingehende REST-APIs erstellen, die Sie erstellen. Das Erstellen von Tests für Ihre anwenderdefinierten REST-APIs vereinfacht Upgradetests und ermöglicht es, sicherzustellen, dass Änderungen an einer REST-API abwärtskompatibel sind.

## Beispiel für REST-Client-Anwendungen {#c_RESTAPI__section_jhj_qw1_xhb}

Mehrere Beispiele für REST-Client-Anwendungen und Quellcode sind verfügbar, um Integrationen mit REST-Webservices zu demonstrieren. Die Beispiel-REST-Client-Anwendungen demonstrieren die Verwendung von ServiceNowREST-API mit einer externen Anwendung, z. B. einer NodeJS- oder iOS-Anwendung.  
Wichtig:  
Diese Anwendungen werden nur als Demonstration der REST-Funktionalität bereitgestellt und werden nicht offiziell unterstützt.

Die Beispiele sind Open Source und stehen der Community zur Verfügung. Sie können diese Beispielanwendungen verwenden, um sich mit der REST-Funktionalität vertraut zu machen, oder sie als Ausgangspunkt zum Erstellen eigener REST-Client-Anwendungen verwenden.

Anwender mit der Rolle „Rest_api_Explorer" können auf die Liste der verfügbaren Client-Anwendungen zugreifen, indem sie zu navigieren System-WebservicesRESTBeispiel-Client-Appsan.

Klicken Sie beim Anzeigen der Liste der Anwendungen auf eine Anwendung, um den Quellcode und die zusätzliche Dokumentation anzuzeigen, die auf GitHub gehostet wird.

## Entwicklerschulungen {#c_RESTAPI__section_my5_szb_2hb}

Auf ServiceNow® Developer Site, Sie können Training für erhalten [Eingehende REST-Integrationen](https://developer.servicenow.com/app.do#!/training/article/app_store_learnv2_rest_rome_inbound_rest_integrations/app_store_learnv2_rest_rome_inbound_integrations_in_servicenow_objectives?v=vancouver)Und [Ausgehende REST-Integrationen](https://developer.servicenow.com/app.do#!/training/article/app_store_learnv2_rest_rome_outbound_rest_integrations/app_store_learnv2_rest_rome_outbound_integrations_in_servicenow_objectives?v=vancouver).

## Zusätzliche Information {#c_RESTAPI__section_mjd_vbj_zhb}

Der Rest des REST-API-Abschnitts enthält „Anleitungen"-Themen, die bestimmte Implementierungen mit beschreiben ServiceNowREST-API und stellt Referenzinformationen bereit, die verschiedene Datenelemente beschreiben, die von verwendet werden ServiceNowREST-API.
* **[Verwenden Sie den REST-API-Explorer](https://servicenow-prod.fluidtopics.net/QZyr9s_~V0xB9fqGOlvJ4A)**   
  In diesem Tutorial verwenden Sie den REST API Explorer, um zu testen ServiceNowREST-APIs.
* **[Begrenzung der eingehenden REST-API-Rate](https://servicenow-prod.fluidtopics.net/fJ0jNKX_RHi7uzEkdLw_0Q)**   
  Um übermäßige eingehende REST-API-Anforderungen zu verhindern, legen Sie Regeln fest, die die Anzahl der pro Stunde verarbeiteten eingehenden REST-API-Anforderungen begrenzen. Sie können Regeln erstellen, um Anforderungen für bestimmte Anwender, Anwender mit bestimmten Rollen oder alle Anwender einzuschränken.
* **[Debuggen Sie eingehende REST-Abfragen](https://servicenow-prod.fluidtopics.net/OlqpJmYBAKImcncmcSnq9Q#debugging-rest-queries)**   
  Sie können eingehende REST-Abfragen debuggen, indem Sie das Sitzungs-Debug-Protokoll überprüfen.
* **[Gibt Sitzungs-Debug-Protokolle in einer REST-Antwort zurück](https://servicenow-prod.fluidtopics.net/6xa9QuTU3Ktvb1w5IrsO7w)**   
  Sie können Sitzungs-Debug-Protokolle in einen REST-Antworttext einfügen, indem Sie den Header X-WantSessionDebugMessages in der Anforderung übergeben.
* **[CORS-Domänenanforderungen](https://servicenow-prod.fluidtopics.net/QN9tXUSA5AZMcR675G8u~g)**   
  Wenn Sie eine CORS-Regel (Cross-Origin Resource Sharing) definieren, der Wert, den Sie in eingeben Domäne Das Feld muss bestimmte Anforderungen erfüllen. Jede CORS-Regel unterstützt einen einzelnen Platzhalter, um eingehende Ursprungsheader abzugleichen.
* **[Definieren Sie eine CORS-Regel](https://servicenow-prod.fluidtopics.net/VNMiGS1xYPnRxclIzlhTyQ)**   
  Sie können eine CORS-Regel definieren, um zu steuern, welche Domänen auf REST-API-Endpunkte und andere Webressourcen zugreifen können.
* **[Aktivieren Sie OAuth mit eingehender REST](https://servicenow-prod.fluidtopics.net/3Lmo1Rmxf9FOdDFCcFB5kg)**   
  Mit OAuth können Sie eine Anwender-ID und ein Passwort einmal übergeben und dann ein Token für nachfolgende REST-Anforderungen verwenden, anstatt bei jeder Anforderung Anmeldeinformationen zu übermitteln.
* **[REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/9Xv9oa1y5A3vVbAgAaBorg)**   
  REST-Nachrichten, die an eine Instanz gesendet werden, geben einen bestimmten HTTP-Antwortcode zurück.
* **[Scripted REST APIs](https://servicenow-prod.fluidtopics.net/0V9QfkPsOI5r~YAD7CJWCA)**   
  Mit der geskripteten REST-API-Funktion können Anwendungsentwickler anwenderdefinierte Webservice-APIs erstellen.

**Zugehörige Informationen**   

* [REST API -- HÄUFIG GESTELLTE FRAGEN](https://support.servicenow.com/kb_view.do?sysparm_article=KB0535048)

