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


---

# UriMatcher -- Umfang

# UriMatcher -- Umfang {#ariaid-title1}

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

Stellt eine Methode bereit, um zu überprüfen, ob ein URI den angegebenen Kriterien für Schema, Host, Pfad, Fragmente und Vorhandensein von Abfrageparametern entspricht.

Die UriMatcher API erfordert das Plugin „REST-API-Anbieter" (com.Glide.Rest), das standardmäßig aktiviert ist.

Diese API wird in bereitgestellt `sn_WS `Namespace.

## UriMatcher -- UriMatcher() {#ariaid-title2}

Instanziiert eine neue UriMatcher Objekt.
{#UriMatcher-UriMatcher__table_tq3_2pw_qdc__entry__3}

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

{#UriMatcher-UriMatcher__table_tq3_2pw_qdc}  
Instanziiert einen UriMatcher Objekt.

    var matcher = new sn_ws.UriMatcher();

## UriMatcher -- Match(Zeichenfolgen-URI, Zeichenfolgenschema, Array-Hosts, Array-Pfade, Array-Fragmente, boolescher Wert „unallowQueryParameters") {#ariaid-title3}

Überprüft, ob ein URI den angegebenen Kriterien für Schema, Host, Pfad, Fragmente und Vorhandensein von Abfrageparametern entspricht.
{#UriMatcher-match_S_S_O_O_O_B__table_ejx_wjw_qdc__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| uri | Zeichenfolge | URI, der anhand der angegebenen Kriterien getestet werden soll. |
| Schema | Zeichenfolge | Im URI verwendetes Protokoll. Gültige Werte: * http * https {#UriMatcher-match_S_S_O_O_O_B__ul_c1s_24d_rdc} |
| hosts | Array | Liste der zulässigen Hosts im URI. Der URI muss einen der zulässigen Hosts verwenden, um als Übereinstimmung betrachtet zu werden. |
| paths | Array | Optional. Liste der zulässigen Pfade im URI. Der URI muss einen der zulässigen Pfade verwenden, um als Übereinstimmung betrachtet zu werden, und der zulässige Pfad muss der vollständige Pfad sein, der im URI verwendet wird. Beispiel: Der zulässige Pfad ist `/Path1 `, Ein URI mit dem Pfad `/Path1/mehr `Wird nicht als Übereinstimmung betrachtet. Hinweis: Pfade müssen mit beginnen `/ `. Standard: Jeder Pfad ist zulässig. |
| Fragmente | Array | Optional. Liste der zulässigen Fragmente im URI. Der URI wird auch dann als Übereinstimmung betrachtet, wenn er keines der zulässigen Fragmente enthält. Der URI wird nur als nicht übereinstimmend betrachtet, wenn er Fragmente enthält, die nicht in der zulässigen Liste enthalten sind. Standard: Jedes Fragment ist zulässig. |
| UnallowQueryParameters | Boolean | Optional. Kennzeichnung, die angibt, ob Abfrageparameter im URI zulässig sind. Gültige Werte: * Wahr: Abfrageparameter sind nicht zulässig. Wenn Abfrageparameter in der URI enthalten sind, tritt ein Fehler auf. * Falsch: Abfrageparameter sind zulässig. {#UriMatcher-match_S_S_O_O_O_B__ul_qj4_k4d_rdc} Standard: Falsch |
[Tabelle : 2. Parameter]

{#UriMatcher-match_S_S_O_O_O_B__table_ejx_wjw_qdc} {#UriMatcher-match_S_S_O_O_O_B__table_fjx_wjw_qdc__entry__2}

| Typ | Beschreibung |
|-|-|
| [UriMatcherResponse](https://servicenow-prod.fluidtopics.net/DArJi86CZA5VnTqKbcoLHA#UriMatcherResponseScopedAPI "Stellt Methoden bereit, um Informationen darüber zurückzugeben, ob ein URI den angegebenen Kriterien für Schema, Host, Pfad, Fragmente und Vorhandensein von Abfrageparametern entspricht.") | UriMatcherResponse Objekt mit Methoden für die Rückgabe detaillierter Informationen zur Übereinstimmung. |
[Tabelle : 3. Rückgaben]

{#UriMatcher-match_S_S_O_O_O_B__table_fjx_wjw_qdc}  
Dieses Beispiel überprüft, ob die URI dem angegebenen Schema und Host entspricht.

    var uri = "https://example.com/path?q=query";
    var scheme = "https";  
    var allowedHosts = ["example.com"];  
    var matcher = new sn_ws.UriMatcher();  
    var resp = matcher.match(uri, scheme, allowedHosts);  

    gs.info("Is URI a match: " + resp.isMatch());

Ausgabe:

    Is URI a match: true

Dieses Beispiel überprüft, ob der URI mit dem angegebenen Schema, Host, Pfad, Fragmenten und Vorhandensein von Abfrageparametern übereinstimmt.

    var uri = "https://example.com/path1/more";
    var scheme = "https";  
    var allowedHosts = ["example.com", "sample.com"];  
    var allowedPaths = ["/path1/more", "/path2/less"];  
    var allowedFragments = ["section1", "section2"];  
    var noQueryParams = true;
    var matcher = new sn_ws.UriMatcher();  
    var resp = matcher.match(uri, scheme, allowedHosts, allowedPaths, allowedFragments, noQueryParams);  

    gs.info("Is URI a match: " + resp.isMatch());  
    gs.info("Is scheme a match: " + resp.isSchemeMatches());  
    gs.info("Is host a match: " + resp.isHostMatches());  
    gs.info("Is path a match: " + resp.isPathMatches());  
    gs.info("Is fragment a match: " + resp.isFragmentMatches());
    gs.info("Error occurred: " + resp.isError());  
    gs.info("Error message: " + resp.getErrorMessages());

Ausgabe:

    Is URI a match: true
    Is scheme a match: true
    Is host a match: true
    Is path a match: true
    Is fragment a match: true
    Error occurred: false
    Error message:


