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


---

# RESTAPIRequest: Umfang, Global

# RESTAPIRequest: Umfang, Global {#ariaid-title1}

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

Die RESTAPIAnforderung Die API bietet Methoden, mit denen Sie in Skripts auf Details zu geskripteten REST-API-Anforderungen zugreifen können.

Diese API wird in ausgeführt `sn_WS `Namespace.  
Hinweis:  
Sie können keine Objekte dieses Typs instanziieren. Objekte dieses Typs werden automatisch erstellt und sind nur in geskripteten REST-API-Ressourcenskripts zugänglich.

## RESTAPIRequest: Textkörper {#ariaid-title2}

Der Text der Anforderung.
{#r_SSR_body__table_a3m_rt1_sr__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| body | [RESTAPIRequestBody](https://servicenow-prod.fluidtopics.net/sEKd5oz2Sy79XxrgLBuk3Q#c_ScriptableServiceRequestBody "Die RESTAPIRequestBody Die API bietet Methoden, mit denen Sie in Skripts auf den Textinhalt einer geskripteten REST-API-Anforderung zugreifen können.") | Der Text der Anforderung. Sie können über die API „RESTAPIRequestBody" auf Daten aus dem Textobjekt zugreifen. |
[Tabelle : 1. Feld]

{#r_SSR_body__table_a3m_rt1_sr}  

    var requestBody = request.body // Returns instance of RESTAPIRequestBody

## RESTAPIRequest -- getHeader (Zeichenfolgenheader) {#ariaid-title3}

Gibt den Wert eines bestimmten Headers aus der Webserviceanforderung zurück.
{#r_SSR-getHeader_String__table_q32_q2r_qr__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| header | Zeichenfolge | Der Name des Headers, z. B. acceptOder content-type. |
[Tabelle : 2. Parameter]

{#r_SSR-getHeader_String__table_q32_q2r_qr} {#r_SSR-getHeader_String__table_r32_q2r_qr__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Der Wert des angegebenen Headers. |
[Tabelle : 3. Rückgaben]

{#r_SSR-getHeader_String__table_r32_q2r_qr}  

    var acceptHeader = request.getHeader('accept');

## RESTAPIRequest -- getSupportedResponseContentTypes() {#ariaid-title4}

Ruft die im Header „Anforderungsakzeptanz" angegebenen Inhaltstypen ab.
{#r_SSR-getSupportedRespContentTypes__table_rtm_qg3_zs__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 4. Parameter]

{#r_SSR-getSupportedRespContentTypes__table_rtm_qg3_zs} {#r_SSR-getSupportedRespContentTypes__table_stm_qg3_zs__entry__2}

| Typ | Beschreibung |
|-|-|
| Array | Ein Array von Zeichenfolgenwerten, bei denen jede Zeichenfolge ein Inhaltstyp ist, z. B. „Application/JSON". |
[Tabelle : 5. Rückgaben]

{#r_SSR-getSupportedRespContentTypes__table_stm_qg3_zs}

## RESTAPIRequest: Header {#ariaid-title5}

Alle Header aus der Anforderung.
{#r_SSR_headers__table_zmm_3s1_sr__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| headers | Objekt | Alle Header aus der Anforderung und ihre Werte. |
[Tabelle : 6. Feld]

{#r_SSR_headers__table_zmm_3s1_sr}  

    var headers = request.headers; 
    var acceptHeader = headers.Accept;
    var myCustomHeader = headers.myCustom; 
    var specialHeader = headers['special - header'];

## RESTAPIRequest: PathParams {#ariaid-title6}

Die im Anforderungs-URI übergebenen Pfadparameter.
{#r_SSR_pathParams__table_zsf_jr1_sr__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| pathParams | Objekt | Die Pfadparameter als Skriptobjekt. Verfügbare Pfadparameter hängen von der Webservicekonfiguration ab. |
[Tabelle : 7. Feld]

{#r_SSR_pathParams__table_zsf_jr1_sr}  
In diesem Beispiel folgt der geskriptete REST-API-Endpunkt diesem Format: https://instance.service-now.com/api/now/myservice/{tableName}/{id} . Die verarbeitete Anforderung verwendet diese URL: https://instance.service-now.com/api/now/myservice/myApp_table/1234 .

    var pathParams = request.pathParams; 
    var tableName = pathParams.tableName; //'myApp_table' 
    var id = pathParams.id; //'1234'

## RESTAPIRequest: QueryParams {#ariaid-title7}

Die Abfrageparameter aus der Webserviceanforderung.
{#r_SSR_queryParams__table_gzw_yg5_rr__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| queryParams | Array | Die Abfrageparameter aus der Webserviceanforderung. |
[Tabelle : 8. Feld]

{#r_SSR_queryParams__table_gzw_yg5_rr}  
In diesem Beispiel verwendet die verarbeitete Anforderung diese URL: https://\<instance_rest_endpoint\>?Active=false\&Name=now . Beachten Sie activeUnd nameParameter.

    var queryParams = request.queryParams; 
    var isActiveQuery = queryParams.active; // [false] 
    var nameQueryVal = queryParams.name; // ['now']

## RESTAPIRequest: Abfragezeichenfolge {#ariaid-title8}

Die gesamte Abfrage wurde dem Endpunkt-URI hinzugefügt.
{#r_SSR_queryString__table_zwx_5q1_sr__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Abfragezeichenfolge | Zeichenfolge | Die gesamte Abfrage für die Anforderung. |
[Tabelle : 9. Feld]

{#r_SSR_queryString__table_zwx_5q1_sr}  
In diesem Beispiel verwendet die verarbeitete Anforderung diese URL: https://\<instance_rest_endpoint\>?Active=false\&Name=now . Beachten Sie die Abfrage `Active=falsch&Name=jetzt `.

    var query = request.queryString; //"active=false&name=now"

## RESTAPIRequest: URI {#ariaid-title9}

Der Anforderungs-URI, mit Ausnahme der Domäneninformationen.
{#r_SSR_uri__table_h5d_ct1_sr__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| uri | Zeichenfolge | Der Anforderungs-URI, mit Ausnahme der Domäneninformationen. |
[Tabelle : 10. Feld]

{#r_SSR_uri__table_h5d_ct1_sr}  
In diesem Beispiel verwendet die verarbeitete Anforderung diese URL: https://instance.service-now.com/api/now/table/myTable?active=false\&name=now .

    var query = request.uri; //"api/now/table/myTable"

## RESTAPIRequest: url {#ariaid-title10}

Die gesamte Anforderungs-URL.
{#r_SSR_url__table_zdq_qs1_sr__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| URL | Zeichenfolge | Die gesamte Anforderungs-URL. |
[Tabelle : 11. Feld]

{#r_SSR_url__table_zdq_qs1_sr}  
In diesem Beispiel verwendet die verarbeitete Anforderung diese URL: https://instance.service-now.com/api/now/table/myTable?active=false\&name=now .

    var query = request.url; //"https://instance.service-now.com/api/now/table/myTable?active=false&name=now"


