---
sourceDocument: Xanadu-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - de-DE

ft:publication_title :

    - Xanadu-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# WSD-Such-API

# WSD-Such-API {#ariaid-title1}

* Freigeben Version: Xanadu
* 
* Aktualisiert 1. August 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 46 Minuten Lesedauer

Die Such -API Workplace Service Delivery (WSD) bietet Endpunkte für die Suche nach verfügbaren Standorten und Arbeitsplatzelementen wie reservierbaren Elementen, reservierbaren Modulen und verfügbaren Schichten.
Um auf diese API zuzugreifen, muss der Anrufer über die Rolle „sn_wsd_core.workplace_user" verfügen, und die Plugins „Workplace Safety Management" (sn_wsd_core) und „Workplace Reservation Management" (sn_wsd_rsv) müssen aktiviert sein.

Diese API wird im Namespace `sn_wsd_rsv ausgeführt`.

Weitere Informationen zu Management von Arbeitsplatz-Reservierungenfinden Sie unter [Reservierungsmanagement für Arbeitsplatz](https://www.servicenow.com/docs/access?context=workplace-rsv-mgmt-feat&version=xanadu&pubname=xanadu-employee-service-management&ft:locale=en-US).

## WSD-Suche: GET /api/sn_wsd_rsv/search/availability {#ariaid-title2}

Überprüft, ob die angegebenen reservierbaren Elemente für die angegebenen Zeiten verfügbar sind.

### URL-Format

URL mit Versionsnummer: /api/sn_wsd_rsv/{api_version}/search/availability

Standard-URL: /api/sn_wsd_rsv/search/availability

### Unterstützte Anforderungsparameter

{#wsd_search-GET-availability__entry__2}{#wsd_search-GET-availability__version-RESTAPI}

| Name | Beschreibung |
|-|-|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel <kbd class="ph userinput">v1</kbd> oder <kbd class="ph userinput">v2</kbd>. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
[Tabelle : 1. Pfadparameter]

{#wsd_search-GET-availability__entry__6}{#wsd_search-GET-availability__end-query-reserv-entry}{#wsd_search-GET-availability__include_reservations_within_days-reserv-entry}{#wsd_search-GET-availability__reservation_ids-reserv-entry}{#wsd_search-GET-availability__reservable_module-reserv-entry}{#wsd_search-GET-availability__schedule_view_obj-reserv-entry}{#wsd_search-GET-availability__schedule_view_obj-schedule_view_date-reserv-entry}{#wsd_search-GET-availability__schedule_view_obj-timezone-entry}{#wsd_search-GET-availability__start-query-reserv-entry}

| Name | Beschreibung |
|-|-|
| end | Erforderlich. Endzeit für die Suche nach verfügbaren reservierbaren Modulen. Dieser Wert muss nach dem im Parameter start angegebenen Wert liegen. Datentyp: Zeichenfolge Format: UTC oder Ortszeit (JJJJ-MM-TT hh:mm:ss) |
| „include_reservations_within_days" | Kennzeichnung, die angibt, ob alle freien Zeitfenster der verfügbaren Zeiten in der Antwort für jedes reservierbare Element für den ganzen Tag zurückgegeben werden sollen. Gültige Werte: * „wahr": Gibt alle freien Slots zurück. * „falsch": Gibt nicht alle freien Slots zurück. Datentyp: Boolesch Standardwert: false |
| reservable_ids | Erforderlich. Kommagetrennte Liste der reservierbaren sys_ids, deren Verfügbarkeit ausgewertet werden soll. Zu finden in der Tabelle „Arbeitsplatzstandort" \[sn_wsd_core_workplace_location\]. Datentyp: Zeichenfolge |
| reservierung_ids | Kommagetrennte Liste der vorhandenen sys_ids für Reservierungen. Übergeben Sie diesen Parameter, wenn Sie die zugehörigen Reservierungen bearbeiten möchten. Befindet sich in der Tabelle „Arbeitsplatzreservierung" \[sn_wsd_rsv_reservation\]. Die für diese sys_ids für die entsprechenden reservierbaren Elemente blockierte Zeit wird als verfügbar behandelt. Datentyp: Zeichenfolge Standard: Keine |
| reservable_module | Erforderlich. Sys_id des reservierbaren Moduls, das in die Suche aufgenommen werden soll. Ein [reservierbares Modul](https://www.servicenow.com/docs/access?context=config-reservable-module&version=xanadu&pubname=xanadu-employee-service-management&ft:locale=en-US) gruppiert ähnliche Arten von Arbeitsplatzelementen. Befindet sich in der Tabelle „Reservierbares Modul" \[sn_wsd_rsv_reservable_module\]. Datentyp: Zeichenfolge |
| schedule_view_obj | Details zur zurückzugebenden Zeitplanansicht. Übergeben Sie dieses Objekt, wenn Sie 24-Stunden-Verfügbarkeitsdaten für Reservierungen benötigen, die sich über mehr als einen Tag erstrecken. Die zurückgegebenen Ergebnisse enthalten nur verfügbare Zeiten und Reservierungen für das angegebene Datum. Damit diese Funktionalität ordnungsgemäß funktioniert, müssen die Parameter ignore_same_day_validation und include_reservations_within_days auf <kbd class="ph userinput">true</kbd>festgelegt sein. Datentyp: Objekt "schedule_view_obj": { "schedule_view_date": "String", "timezone": "String" } |
| schedule_view_obj.schedule_view_date | Datum, ab dem die Rückgabe der Reservierungsverfügbarkeit beginnen soll. Dieses Datum muss in der Zeitzone liegen, die im Parameter schedule_view_obj.timezone angegeben ist. Datentyp: Zeichenfolge Format: JJJJ-MM-TT |
| schedule_view_obj.timezone | Gebäudezeitzone zur Bestimmung der zurückzugebenden Reservierungsverfügbarkeitsdaten. Beispiel: USA/Pazifik. Datentyp: Zeichenfolge |
| Schicht | Erforderlich, wenn die angegebenen reservierbaren Module auf einer Schicht basieren. Sys_id der Schicht, die der Reservierung zugeordnet werden soll. Befindet sich in der Tabelle „Schicht" \[sn_wsd_core_shift\]. Wenn dieser Parameter übergeben wird, ist der Parameter end nicht erforderlich. Weitere Informationen zu schichtbasierten Reservierungen finden Sie unter [Schichtbasierte Reservierung aktivieren](https://www.servicenow.com/docs/access?context=wsd-reservation-setup&version=xanadu&pubname=xanadu-employee-service-management&ft:locale=en-US). Datentyp: Zeichenfolge |
| start | Erforderlich. Startzeit für die Suche nach verfügbaren reservierbaren Modulen. Dieser Wert muss vor dem im Parameter end angegebenen Wert liegen. Datentyp: Zeichenfolge Format: UTC oder Ortszeit (JJJJ-MM-TT hh:mm:ss) |
[Tabelle : 2. Abfrageparameter]

{#wsd_search-GET-availability__entry__28}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 3. Anforderungstextparameter]

### Kopfzeilen

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter [Unterstützte REST API-Header](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.").
{#wsd_search-GET-availability__entry__32}{#wsd_search-GET-availability__accept-reserv-entry}

| Kopfzeile | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Anforderungstexts. Unterstützte Typen: application/json, application/xml oder, text/xml Standard: application/json |
[Tabelle : 4. Anforderungskopfzeilen]

{#wsd_search-GET-availability__entry__36}

| Kopfzeile | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 5. Antwortkopfzeilen]

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter [HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API.
{#wsd_search-GET-availability__entry__40}{#wsd_search-GET-availability__entry-200-status-code}{#wsd_search-GET-availability__entry-401-status-code}{#wsd_search-GET-availability__entry-404-status-code}{#wsd_search-GET-availability__entry-500-status-code}

| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
[Tabelle : 6. Statuscodes]

### Parameter des Antwort-Haupttexts

{#wsd_search-GET-availability__entry__50}

| Name | Beschreibung |
|-|-|
| Ergebnis | Liste aller verfügbaren reservierbaren Elemente für die angegebenen Zeiten. Datentyp: Array von Objekten "result": [ { "availableTimes": [Array], "building": {Object}, "campus": {Object}, "email": "String", "floor": {Object}, "is_available": Boolean, "name": "String", "reservations": [Array], "sys_id": "String" } ] |
| Ergebnis.verfügbareZeiten | Liste der Daten/Uhrzeiten, zu denen das zugeordnete reservierbare Element verfügbar ist. Datentyp: Array |
| result.building | Details zum Gebäude, das dem reservierbaren Element zugeordnet ist. Datentyp: Objekt "building": { "display_value": "String", "name": "String", "sys_id": "String" } |
| Ergebnis.Gebäude.Anzeigewert | Anzeigewert für das Gebäude. Datentyp: Zeichenfolge |
| result.building.name | Name des Gebäudes Datentyp: Zeichenfolge |
| result.building.sys_id | Sys_id des zugeordneten Gebäudedatensatzes. Datentyp: Zeichenfolge |
| result.campus | Details zum Campus, der dem reservierbaren Element zugeordnet ist. Datentyp: Objekt "campus": { "display_value": "String", "name": "String", "sys_id": "String" } |
| result.campus.display_value | Anzeigenummer des Campus, auf dem sich das reservierbare Element befindet, z. B. Ostbucht. Datentyp: Zeichenfolge |
| result.campus.name | Name des Campus. Datentyp: Zeichenfolge |
| result.campus.sys_id | Sys_id des zugeordneten Datensatzes. Befindet sich in der Tabelle „Campus" \[sn_wsd_core_campus\]. Datentyp: Zeichenfolge |
| result.email | E-Mail-Adresse für das zugeordnete reservierbare Element. Datentyp: Zeichenfolge |
| Ergebnis.Stockwerk | Details zum Stockwerk, das dem reservierbaren Element zugeordnet ist. Datentyp: Objekt "floor": { "display_value": "String", "name": "String", "sys_id": "String" } |
| Ergebnis.Stockwerk.Anzeigewert | Anzeigenummer des Stockwerks, in dem sich das reservierbare Element befindet, z. B. 12. Datentyp: Zeichenfolge |
| result.floor.name | Name des Stockwerks, in dem sich das reservierbare Element befindet. Datentyp: Zeichenfolge |
| Ergebnis.Stockwerk.sys_id | Sys_id des zugeordneten Datensatzes in der Tabelle „Stockwerk" \[sn_wsd_core_Floor\]. Datentyp: Zeichenfolge |
| result.is_available | Kennzeichnung, die angibt, ob das reservierbare Element zum Reservieren verfügbar ist. Gültige Werte: * true: Zum Reservieren verfügbar. * false: Nicht zum Reservieren verfügbar. Datentyp: Boolesch |
| result.name | Name des reservierbaren Elements. Datentyp: Zeichenfolge |
| result.reservations | Details zur zugeordneten Reservierung. Datentyp: Array von Objekten "reservations": [ { "configuration_item": "String", "end": "String", "is_collided": Boolean, "location": {Object}, "number": "String", "requested_for": {Object}, "reservation_purpose": {Object}, "start": "String", "state": {Object}, "subject": "String", "sys_id": "String" } ] |
| „result.reservations.configuration_item" | Configuration Items, die der Reservierung entsprechen. Befindet sich in der Tabelle cmdb_ci. Datentyp: Zeichenfolge |
| result.reservations.end | Enddatum und -uhrzeit der Reservierung. Datentyp: Zeichenfolge Format: UTC: jjjj-mm-ttThh:mm:ssZ, z. B. 2021-02-05T18:00:00Z |
| result.reservations.is_collided | Kennzeichnung, die angibt, ob die Reservierung mit der Start- und Endzeit der Suche kollidiert. Dies zeigt an, dass der zugeordnete reservierbare Standort bereits für den angegebenen Suchzeitraum reserviert ist. Mögliche Werte: * wahr: Kollision. * false: Keine Kollision. Datentyp: Boolesch |
| Ergebnis.Reservierungen.Ort | Details zum Standort der Reservierung. Datentyp: Objekt "location": { "location": "String", "timezone": {Object} } |
| result.reservations.location.location | Sys_id des zugeordneten Standortdatensatzes. Zu finden in der Tabelle „Arbeitsplatzstandort" \[sn_wsd_core_workplace_location\]. Datentyp: Zeichenfolge |
| Ergebnis.Reservierungen.Ort.Zeitzone | Details zur Zeitzone, die dem Standort zugeordnet ist. Datentyp: Objekt "timezone": { "displayValue": "String", "value": "String" } |
| result.reservations.location.timezone.​displayValue | Anzeigewert für die Zeitzone, zu der dieser Standort gehört. Datentyp: Zeichenfolge |
| result.reservations.location.timezone.value | Interner Wert für die Zeitzone, zu der dieser Standort gehört. Datentyp: Zeichenfolge |
| Ergebnis.Reservierungen.Nummer | Reservierungsnummer. Datentyp: Zeichenfolge |
| result.reservations.requested_for | Details zur Person, für die die Reservierung im Namen von angefordert wurde. Datentyp: Objekt "requested_for": { "name": "String", "sys_id": "String" } |
| result.reservations.requested_for.name | Name des Anwenders, für den die Reservierung angefordert wurde. Datentyp: Zeichenfolge |
| result.reservations.requested_for.sys_id | Sys_id des Anwenders, für den die Reservierung angefordert wird. Befindet sich in der Tabelle „Benutzer" \[sys_user\]. Datentyp: Zeichenfolge |
| result.reservations.reservation_zweck | Details zum Zweck der Reservierung. Datentyp: Objekt "reservation_purpose": { "display_value": "String," "value": "String" } |
| result.reservations.reservation_zweck.​display_value | Anzeigewert für den Zweck der Reservierung, z. B. Unternehmensbesprechung. Datentyp: Zeichenfolge |
| result.reservations.reservation_zweck.wert | Interner Wert für den Zweck der Reservierung, z. B. „company_meeting". Datentyp: Zeichenfolge |
| Ergebnis.Reservierungen.Start | Startdatum und -uhrzeit der Reservierung. Datentyp: Zeichenfolge Format: UTC - jjjj-mm-ttThh:mm:ssZ, z. B. 2021-02-05T18:00:00Z |
| Ergebnis.Reservierungen.Status | Details zum Status der Reservierung für den Standort. Datentyp: Objekt "state": { "display_value": "String," "value": "String" } |
| result.reservations.state.display_value | Anzeigewert für den aktuellen Status der Reservierung, z. B. „Bestätigt". Datentyp: Zeichenfolge |
| Ergebnis.Reservierungen.Status.Wert | Interner Wert für den aktuellen Status der Reservierung, z. B. 2. Datentyp: Zeichenfolge |
| Ergebnis.Reservierungen.Betreff | Betreff der Reservierung. Datentyp: Zeichenfolge |
| result.reservations.sys_id | Erforderlich. Sys_id des Reservierungsdatensatzes. Befindet sich in der Tabelle „Arbeitsplatzreservierung" \[sn_wsd_rsv_reservation\]. Datentyp: Zeichenfolge |
[ ]

### cURL-Anforderung

Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird. Hinweis: Den Abfrageparametern wurden Zeilenumbrüche hinzugefügt, um das Lesen zu erleichtern.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/search/availability?
    reservable_module=5db44502dbb650106c731dcd13961937&
    start=2023-10-12T11:00:00Z&
    end=2023-10-15T12:00:00Z&
    reservable_ids=adb35f1977220110b3d7be377b5a99fc&
    reservation_ids=undefined&
    shift=undefined&
    schedule_view_obj={"schedule_view_date":"2023-10-12","timezone":"Europe/Paris"}&
    timezone=Europe/Paris&
    include_reservations_within_days=true&
    ignore_same_day_validation=true&
    include_unavailable_items=true"  \
    --request GET \
    --header "Accept:application/json" \
    --user "username":"password"

Ergebnisse zurückgeben:

    {
      "result": [
        {
          "sys_id": "fe1f744edb7650106c731dcd139619ca",
          "email": null,
          "name": "Aspen",
          "is_available": true,
          "availableTimes": [
            [
              "2022-04-23 07:00:00",
              "2022-04-23 08:30:00"
            ],
            [
              "2022-04-23 09:30:00",
              "2022-04-23 23:00:00"
            ],
            [
              "2022-04-24 00:00:00",
              "2022-04-24 06:59:59"
            ]
          ],
          "floor": {
            "sys_id": "2f554296dbba10106c731dcd139619ed",
            "display_value": "Floor 2",
            "name": "Floor 2"
          },
          "building": {
            "sys_id": "94e264cedb3650106c731dcd13961919",
            "display_value": "CAL-B1",
            "name": "CAL-B1"
          },
          "campus": {
            "sys_id": "82b2a0cedb3650106c731dcd139619e9",
            "display_value": "California Campus",
            "name": "California Campus"
          },
          "reservations": [
            {
              "sys_id": "5fe65830874bc9106342b846dabb352b",
              "number": "WRES0001001",
              "location": {
                "location": "fe1f744edb7650106c731dcd139619ca",
                "timezone": {
                  "value": "US/Pacific",
                  "displayValue": "US/Pacific"
                }
              },
              "configuration_item": null,
              "start": "2022-04-23T08:30:00Z",
              "end": "2022-04-23T09:30:00Z",
              "subject": null,
              "reservation_purpose": {
                "value": "meeting",
                "display_value": "Meeting"
              },
              "state": {
                "value": "confirmed",
                "display_value": "Confirmed"
              },
              "is_collided": false,
              "requested_for": {
                "sys_id": "2de07e1887cb89106342b846dabb35fe",
                "name": "Workplace User"
              }
            }
          ]
        }
      ]
    }

## WSD-Suche: GET /api/sn_wsd_rsv/search/best_match {#ariaid-title3}

Sucht anhand der angegebenen Suchkriterien nach dem besten reservierbaren Element.

### URL-Format

URL mit Versionsnummer: /api/sn_wsd_rsv/{api_version}/search/best_match

Standard-URL: /api/sn_wsd_rsv/search/best_match

### Unterstützte Anforderungsparameter

{#wsd_search-GET-best_match__entry__2}{#wsd_search-GET-best_match__version-RESTAPI}

| Name | Beschreibung |
|-|-|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel <kbd class="ph userinput">v1</kbd> oder <kbd class="ph userinput">v2</kbd>. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
[Tabelle : 7. Pfadparameter]

{#wsd_search-GET-best_match__entry__6}{#wsd_search-GET-best_match__end-query-reserv-entry}{#wsd_search-GET-best_match__include_reservable_purposes-reserv-entry}{#wsd_search-GET-best_match__include_reservations_within_days-reserv-entry}{#wsd_search-GET-best_match__include_standard_services-reserv-entry}{#wsd_search-GET-best_match__q-reserv-entry}{#wsd_search-GET-best_match__reservable_module-reserv-entry}{#wsd_search-GET-best_match__start-query-reserv-entry}{#wsd_search-GET-best_match__timezone_q_parm-reserv-query}

| Name | Beschreibung |
|-|-|
| best_match_count | Anzahl der am besten übereinstimmenden zurückzugebenden reservierbaren Elemente. Datentyp: Zahl Standard: 1 |
| end | Erforderlich. Endzeit für die Suche nach verfügbaren reservierbaren Modulen. Dieser Wert muss nach dem im Parameter start angegebenen Wert liegen. Datentyp: Zeichenfolge Format: UTC oder Ortszeit (JJJJ-MM-TT hh:mm:ss) |
| beinhaltet_reservierbare_Zwecke | Kennzeichnung, die angibt, ob der Zweck der Reservierung des Arbeitsplatzstandorts für jedes reservierbare Element in den Rückgabeergebnissen zurückgegeben werden soll. Diese Informationen befinden sich in der Tabelle „Zweck der reservierbaren Elemente" \[sn_wsd_rsv_reservable_zweck\]. Gültige Werte: * „wahr": Gibt die reservierbaren Zwecke zurück. * „falsch": Die reservierbaren Zwecke werden nicht zurückgegeben. Datentyp: Boolesch Standardwert: false |
| „include_reservations_within_days" | Kennzeichnung, die angibt, ob alle freien Zeitfenster der verfügbaren Zeiten in der Antwort für jedes reservierbare Element für den ganzen Tag zurückgegeben werden sollen. Gültige Werte: * „wahr": Gibt alle freien Slots zurück. * „falsch": Gibt nicht alle freien Slots zurück. Datentyp: Boolesch Standardwert: false |
| „include_standard_​services". | Kennzeichnung, die angibt, ob die Standardserviceinformationen in der Antwort zurückgegeben werden sollen. Ein Standardservice beschreibt grundlegende Bestimmungen, die mit einem reservierbaren Arbeitsplatzelement verfügbar sind, wenn die Reservierung vorgenommen wird, z. B. Whiteboards, zusätzliche Monitore und ähnliche Services. Weitere Informationen zu Standardservices finden Sie unter [Standardservices](https://www.servicenow.com/docs/access?context=standard-service&version=xanadu&pubname=xanadu-employee-service-management&ft:locale=en-US). Diese Informationen befinden sich in der Tabelle „Standardservice" \[sn_wsd_rsv_standard_service\]. Gültige Werte: * „wahr": Gibt die Informationen zu Standardservices zurück. * „falsch": Die Standardserviceinformationen werden nicht zurückgegeben. Datentyp: Boolesch Standardwert: false |
| q | Erforderlich. Codierte Abfrage zum Filtern der zurückgegebenen Suchergebnisse. In dieser Abfrage müssen Sie die sys_id des Gebäudes angeben. Außerdem können Sie Parameter wie Stockwerk, Fläche, Kapazität, Standardservices und reservable_zwecke angeben. Alle übergebenen Parameter müssen sys_ids sein, mit Ausnahme der Kapazität, bei der es sich um eine Zahl handelt. For example: `q=building=94e264cedb3650106c731dcd13961919​^floorINfc7368cedb3650106c731dcd13961902​^capacity>=1​^standard_services=55c0818edb7650106c731dcd13961904​^reservable_purposes=d6e5c7cd1ba4e01051848489cc4bcb81` Sie können diese Informationen in den folgenden Tabellen finden: * Gebiet: sn_wsd_core_area * Gebäude: sn_wsd_core_building * Stockwerk: sn_wsd_core_stockwerk * Reservierbar -- Zwecke: sn_wsd_rsv_reservable_zweck * Standardservices: sn_wsd_rsv_standard_service Datentyp: Zeichenfolge |
| reservable_module | Erforderlich. Sys_id des reservierbaren Moduls, das in die Suche aufgenommen werden soll. Ein [reservierbares Modul](https://www.servicenow.com/docs/access?context=config-reservable-module&version=xanadu&pubname=xanadu-employee-service-management&ft:locale=en-US) gruppiert ähnliche Arten von Arbeitsplatzelementen. Befindet sich in der Tabelle „Reservierbares Modul" \[sn_wsd_rsv_reservable_module\]. Datentyp: Zeichenfolge |
| start | Erforderlich. Startzeit für die Suche nach verfügbaren reservierbaren Modulen. Dieser Wert muss vor dem im Parameter end angegebenen Wert liegen. Datentyp: Zeichenfolge Format: UTC oder Ortszeit (JJJJ-MM-TT hh:mm:ss) |
| time_slot | Sys_id eines Zeitfensterdatensatzes, für den versucht wird, nach dem am besten übereinstimmenden reservierbaren Element zu suchen. Befindet sich in der Tabelle „Zeitfenster" \[sn_wsd_rsv_time_slot\]. Datentyp: Zeichenfolge Standard: Keine |
| Feld | Bevorzugte Zeitzone, z. B. Europa/Amsterdam. Datentyp: Zeichenfolge Standard: Keine |
[Tabelle : 8. Abfrageparameter]

{#wsd_search-GET-best_match__entry__28}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 9. Anforderungstextparameter]

### Kopfzeilen

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter [Unterstützte REST API-Header](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.").
{#wsd_search-GET-best_match__entry__32}{#wsd_search-GET-best_match__accept-RESTAPI}

| Kopfzeile | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
[Tabelle : 10. Anforderungskopfzeilen]

{#wsd_search-GET-best_match__entry__36}

| Kopfzeile | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 11. Antwortkopfzeilen]

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter [HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API.
{#wsd_search-GET-best_match__entry__40}{#wsd_search-GET-best_match__entry-200-status-code}{#wsd_search-GET-best_match__entry-401-status-code}{#wsd_search-GET-best_match__entry-404-status-code}{#wsd_search-GET-best_match__entry-500-status-code}

| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
[Tabelle : 12. Statuscodes]

### Parameter des Antwort-Haupttexts

{#wsd_search-GET-best_match__entry__50}{#wsd_search-GET-best_match__hasMore-reserv-entry}{#wsd_search-GET-best_match__nextItemIndex-reserv-entry}{#wsd_search-GET-best_match__reservableContainers-reserv-entry}{#wsd_search-GET-best_match__reservableContainers_building-reserv-entry}{#wsd_search-GET-best_match__reservableContainers_campus-reserv-entry}{#wsd_search-GET-best_match__reservableContainers_capacity-reserv-entry}{#wsd_search-GET-best_match__reservableContainers_display_value-reserv-entry}{#wsd_search-GET-best_match__reservableContainers_floor-reserv-entry}{#wsd_search-GET-best_match__reservableContainers_sys_id-reserv-container}{#wsd_search-GET-best_match__reservableUnit-reserv-entry}{#wsd_search-GET-best_match__reservableUnit_area-reserv-entry}{#wsd_search-GET-best_match__reservableUnit_area_display_value-reserv-entry}{#wsd_search-GET-best_match__reservableUnit_area_sys_id-reserv-entry}{#wsd_search-GET-best_match__availableTimes-reserv-entry}{#wsd_search-GET-best_match__reservableUnit_building-reserv-entry}{#wsd_search-GET-best_match__reservableUnit_description-reserv-entry}{#wsd_search-GET-best_match__reservableUnit_email-reserv-entry}{#wsd_search-GET-best_match__reservableUnit_external_id-reserv-entry}{#wsd_search-GET-best_match__reservableUnit_includedInResult-reserv-entry}{#wsd_search-GET-best_match__is_available-reserv-entry}{#wsd_search-GET-best_match__reservableUnit_is_favorite-reserv-entry}{#wsd_search-GET-best_match__reservableUnit_is_reservable-reserv-entry}{#wsd_search-GET-best_match__reservableUnit_is_reserved-reserv-entry}{#wsd_search-GET-best_match__reservableUnit_is_selected-reserv-entry}{#wsd_search-GET-best_match__reservableUnit_location_type-reserv-entry}{#wsd_search-GET-best_match__reservableUnit_location_type_name-reserv-entry}{#wsd_search-GET-best_match__reservableUnit_reservations-reserv-entry}{#wsd_search-GET-best_match__configuration_item-reserv-row}{#wsd_search-GET-best_match__is_collided-reserv-row}{#wsd_search-GET-best_match__reservableUnit_reservations_location-reserv-entry}

| Name | Beschreibung |
|-|-|
| Ergebnis | Geben Sie Ergebnisse für die beste Übereinstimmung mit den reservierbaren Elementen zurück. Datentyp: Objekt "result": { "floorsOfSelectedBuilding": [Array], "hasMore": Boolean, "nextItemIndex": Number, "reservableContainers": [Array], "reservableUnits": [Array] } |
| ergebnis.stockwerkeAusgewählterGebäude | Details zu den Stockwerken, auf denen sich das reservierbare Element befindet. Datentyp: Array von Objekten "floorsOfSelectedBuilding": [ { "display_value": "String", "external_id": "String", "name": "String", "sys_id": "String" } ] |
| result.stockmentsOfSelectedBuilding.display_value | Anzeigenummer des Stockwerks, in dem sich das reservierbare Element befindet, z. B. 12. Datentyp: Zeichenfolge |
| result.stockmentsOfSelectedBuilding.external_id | Externer Identifier für das Stockwerk. Datentyp: Zeichenfolge |
| result.floorsOfSelectedBuilding.name | Name des Stockwerks, in dem sich das reservierbare Element befindet. Datentyp: Zeichenfolge |
| result.stockmentsOfSelectedBuilding.sys_id | Sys_id des zugeordneten Datensatzes in der Tabelle „Stockwerk" \[sn_wsd_core_Floor\]. Datentyp: Zeichenfolge |
| result.hasMore | Kennzeichnung, die angibt, ob in den Rückgabeergebnissen weitere reservierbare Elemente vorhanden sind. Mögliche Werte: * wahr: Weitere reservierbare Elemente verfügbar. * „falsch": Keine weiteren reservierbaren Elemente verfügbar. Datentyp: Boolesch |
| result.nextItemIndex | Index für den nächsten abzurufenden reservierbaren Datensatz. Verwenden Sie diesen Wert beim Paginieren durch reservierbare Datensätze. Datentyp: Zahl |
| result.reservableContainers | Wird nur für reservierbare Module zurückgegeben, deren Feld „selection_type" auf „ <kbd class="ph userinput">container</kbd>" festgelegt ist. Ein Container ist eine Gruppierung ähnlicher Elemente, z. B. eine Gruppe von Schreibtischen. Datentyp: Array von Objekten "reservableContainers": [ { "building": {Object}, "campus": {Object}, "capacity": Number, "display_value": "String", "floor": {Object}, "image": {Object} "sys_id": "String" } ] |
| result.reservableContainers.building | Details zum Gebäude, das dem reservierbaren Container zugeordnet ist. Datentyp: Objekt "building": { "display_value": "String", "name": "String", "sys_id": "String" } |
| result.reservableContainers.building.​display_value | Anzeigewert für das Gebäude. Datentyp: Zeichenfolge |
| result.reservableContainers.building.name | Name des Gebäudes Datentyp: Zeichenfolge |
| result.reservableContainers.building.sys_id | Sys_id des zugeordneten Gebäudedatensatzes. Datentyp: Zeichenfolge |
| result.reservableContainers.campus | Details zum Campus, auf dem sich das reservierbare Element befindet. Befindet sich in der Tabelle „Campus" \[sn_wsd_core_campus\]. Datentyp: Objekt "campus": { "display_value": "String", "name": "String", "sys_id": "String" } |
| result.reservableContainers.campus.​display_value | Anzeigenummer des Campus, auf dem sich das reservierbare Element befindet, z. B. Ostbucht. Datentyp: Zeichenfolge |
| result.reservableContainers.campus.name | Name des Campus. Datentyp: Zeichenfolge |
| result.reservableContainers.campus.sys_id | Sys_id des zugeordneten Datensatzes. Befindet sich in der Tabelle „Campus" \[sn_wsd_core_campus\]. Datentyp: Zeichenfolge |
| result.reservableContainers.capacity | Maximale Anzahl von Personen für das reservierbare Element. Datentyp: Zahl |
| result.reservableContainers.display_value | Anzeigewert für den reservierbaren Container. Datentyp: Zeichenfolge |
| Ergebnis.reservierbareContainer.Stockwerk | Details zum Stockwerk, das dem reservierbaren Container zugeordnet ist. Datentyp: Objekt "floor": { "display_value": "String", "name": "String", "sys_id": "String" } |
| Ergebnis.reservierbareContainer.Stockwerk.​Anzeigewert | Anzeigenummer des Stockwerks, in dem sich das reservierbare Element befindet, z. B. 12. Datentyp: Zeichenfolge |
| result.reservableContainers.floor.name | Name des Stockwerks, in dem sich das reservierbare Element befindet. Datentyp: Zeichenfolge |
| Ergebnis.reservierbareContainer.Stockwerk.sys_id | Sys_id des zugeordneten Datensatzes in der Tabelle „Stockwerk" \[sn_wsd_core_Floor\]. Datentyp: Zeichenfolge |
| result.reservableContainers.image | Details zu einem Bild, das das Layout für das zugeordnete reservierbare Element darstellt. Befindet sich in der Tabelle „Images" \[db_image\]. "image": { "link": "String", "sys_id": "String" } |
| result.reservableContainers.image.link | Link zu einem Bild, das das Layout für dieses reservierbare Element darstellt. Befindet sich in der Tabelle „Images" \[db_image\]. Datentyp: Zeichenfolge |
| result.reservableContainers.image.sys_id | Sys_id des zugeordneten Image-Datensatzes. Datentyp: Zeichenfolge |
| result.reservableContainers.sys_id | Sys_id des zugeordneten Containerdatensatzes. Die Tabelle, in der sich befindet, kann für jeden Containertyp konfiguriert werden. Standardmäßig befindet er sich in der Tabelle „Bereich" \[sn_wsd_core_area\]. Datentyp: Zeichenfolge |
| result.reservableUnits | Details zu den reservierbaren Einheiten, die den angegebenen Suchkriterien entsprechen. Eine reservierbare Einheit ist ein einzelnes reservierbares Element wie ein Schreibtisch oder ein Stuhl. Datentyp: Objekt "reservableUnits": [ { "area": "String", "availableTimes": [Array], "building": {Object}, "campus": {Object}, "capacity": "String", "defaultPrivacyValue": Boolean, "description": "String", "email": "String", "external_id": "String", "floor": {Object}, "image": {Object}, "includedInResult": Boolean, "is_available": Boolean, "is_favorite": Boolean, "is_reservable": "String", "is_reserved": Boolean, "is_selected": Boolean, "location_type": {Object}, "name": "String", "number": "String", "order": "String", "require_approval": Boolean, "requires_check_in": Boolean, "reservable_quantity": "String", "showPrivacyOption": Boolean, "site": {Object}, "standard_services": [Array], "tableName": "String", "title": "String", "reservable_purposes": [Array], "reservations": [Array], "sys_id": "String" } ] |
| Ergebnis.reservierbareEinheiten.Bereich | Details zum Bereich, in dem sich das reservierbare Modul befindet. Befindet sich in der Tabelle „Bereich" \[sn_wsd_core_area\]. Datentyp: Objekt "area": { "display_value": "String", "sys_id": "String" } |
| Ergebnis.reservierbareEinheiten.Bereich.Anzeigewert | Anzeigewert für den reservierbaren Modulbereich. Datentyp: Zeichenfolge |
| result.reservableUnits.area.sys_id | Sys_id des Bereichsdatensatzes, der dem reservierbaren Element zugeordnet ist. Datentyp: Zeichenfolge |
| result.reservableUnits.availableTimes | Liste der Daten/Uhrzeiten, zu denen das zugeordnete reservierbare Element verfügbar ist. Datentyp: Array |
| Ergebnis.reservierbareEinheiten.Gebäude | Details zum Gebäude, in dem sich das reservierbare Element befindet. Befindet sich in der Tabelle „Gebäude" \[sn_wsd_core_building\]. Datentyp: Objekt "building": { "display_value": "String", "sys_id": "String" } |
| result.reservableUnits.building.display_value | Anzeigewert für das Gebäude. Datentyp: Zeichenfolge |
| result.reservableUnits.building.sys_id | Sys_id des zugeordneten Gebäudedatensatzes. Datentyp: Zeichenfolge |
| Ergebnis.reservierbareEinheiten.Campus | Details zum Campus, auf dem sich das reservierbare Element befindet. Befindet sich in der Tabelle „Campus" \[sn_wsd_core_campus\]. Datentyp: Objekt "campus": { "display_value": "String", "sys_id": "String" } |
| result.reservableUnits.campus.display_value | Anzeigenummer des Campus, auf dem sich das reservierbare Element befindet, z. B. Ostbucht. Datentyp: Zeichenfolge |
| result.reservableUnits.campus.sys_id | Sys_id des zugeordneten Datensatzes. Befindet sich in der Tabelle „Campus" \[sn_wsd_core_campus\]. Datentyp: Zeichenfolge |
| Ergebnis.reservierbareEinheiten.Kapazität | Maximale Anzahl von Personen für das reservierbare Element. Datentyp: Zahl |
| result.reservableUnits.defaultPrivacyValue | Kennzeichnung, die die standardmäßige Datenschutzeinstellung für das reservierbare Element angibt. Weitere Informationen zu diesen Datenschutzeinstellungen finden Sie unter [Datenschutzeinstellungen für den Standort und ihre Auswirkungen](https://www.servicenow.com/docs/access?context=location-privacy-settings-and-impact&version=xanadu&pubname=xanadu-employee-service-management&ft:locale=en-US). Mögliche Werte: * wahr: Die Datenschutzeinstellung für das reservierbare Element kann überschrieben werden. * „falsch": Die Datenschutzeinstellung für das reservierbare Element kann nicht überschrieben werden. Datentyp: Boolesch |
| result.reservableUnits.description | Kurze Beschreibung des reservierbaren Elements. Datentyp: Zeichenfolge |
| result.reservableUnits.email | E-Mail-Adresse für das reservierbare Element. Datentyp: Zeichenfolge |
| result.reservableUnits.external_id | Externe ID des reservierbaren Elements, die zum Synchronisieren eines im CMS zugeordneten Platzes verwendet wird. Dieser Wert wird nur ausgefüllt, wenn diesem Standort eine Karte zugeordnet ist. Datentyp: Zeichenfolge |
| Ergebnis.reservierbareEinheiten.Stockwerk | Details zum Stockwerk, auf dem sich das reservierbare Element befindet. Befindet sich in der Tabelle „Stockwerk" \[sn_wsd_core_stockwerk\]. Datentyp: Objekt "floor": { "display_value": "String", "sys_id": "String" } |
| Ergebnis.reservierbareEinheiten.Stockwerk.Anzeigewert | Anzeigenummer des Stockwerks, in dem sich das reservierbare Element befindet, z. B. 12. Datentyp: Zeichenfolge |
| Ergebnis.reservierbareEinheiten.Stockwerk.sys_id | Sys_id des zugeordneten Datensatzes in der Tabelle „Stockwerk" \[sn_wsd_core_Floor\]. Datentyp: Zeichenfolge |
| result.reservableUnits.image | Details zu einem Bild, das das Layout für das zugeordnete reservierbare Element darstellt. Befindet sich in der Tabelle „Images" \[db_image\]. "image": { "link": "String", "sys_id": "String" } |
| result.reservableUnits.image.link | Link zu einem Bild, das das Layout für dieses reservierbare Element darstellt. Befindet sich in der Tabelle „Images" \[db_image\]. Datentyp: Zeichenfolge |
| result.reservableUnits.image.sys_id | Sys_id des zugeordneten Image-Datensatzes. Datentyp: Zeichenfolge |
| result.reservableUnits.includedInResult | Kennzeichnung, die angibt, ob das aktuelle reservierbare Element in den zurückgegebenen Ergebnissen enthalten ist. Gültige Werte: * wahr: In den zurückgegebenen Ergebnissen enthalten. * false: Nicht in den zurückgegebenen Ergebnissen enthalten. Datentyp: Boolesch |
| Ergebnis.reservierbareEinheiten.ist_verfügbar | Kennzeichnung, die angibt, ob das reservierbare Element zum Reservieren verfügbar ist. Gültige Werte: * true: Zum Reservieren verfügbar. * false: Nicht zum Reservieren verfügbar. Datentyp: Boolesch |
| result.reservableUnits.is_favorite | Kennzeichnung, die angibt, ob das reservierbare Element als einer der Favoriten des zugeordneten Anwenders gekennzeichnet ist. Gültige Werte: * true: Favorit. * false: Kein Favorit. Datentyp: Boolesch |
| Ergebnis.reservierbareEinheiten.ist_reservierbar | Kennzeichnung, die angibt, ob dieses reservierbare Element reserviert werden kann. Hinweis: Wenn der Abfrageparameter include_unavailable_items auf „true" festgelegt ist, werden auch nicht verfügbare Standorte zurückgegeben. Wenn in diesem Fall ein Standort bereits reserviert ist, ist der Parameter is_available auf „falsch" festgelegt, is_reservable jedoch auf „wahr". Gültige Werte: * true: Zum Reservieren verfügbar. * false: Nicht zum Reservieren verfügbar. Datentyp: Boolesch |
| result.reservableUnits.is_reserved | Kennzeichnung, die angibt, ob das reservierbare Element bereits reserviert ist. Gültige Werte: * true: Zum Reservieren verfügbar. * „false": Bereits reserviert. Datentyp: Boolesch |
| Ergebnis.reservierbareEinheiten.ist_ausgewählt | Kennzeichnung, die angibt, ob das reservierbare Element bereits reserviert ist. Gültige Werte: * true: Zum Reservieren verfügbar. * „false": Bereits reserviert. Datentyp: Boolesch |
| result.reservableUnits.location_type | Details zum Standorttyp des reservierbaren Elements, z. B. Arbeitsplatz/Schreibtisch, Café oder Studio. Zu finden in der Tabelle „Arbeitsplatzstandort" \[sn_wsd_core_workplace_location\]. "location_type": { "display_value": "String", "name": "String", "sys_id": "String" } |
| result.reservableUnits.location_type.​display_value | Anzeigewert des Ortstyps. Datentyp: Zeichenfolge |
| result.reservableUnits.location_type.name | Name des Standorttyps, z. B. Basement oder Lager. Identisch mit Anzeigewert. Datentyp: Zeichenfolge |
| result.reservableUnits.location_type.sys_id | Sys_id des zugeordneten Datensatzes in der Tabelle „Platztyp" \[sn_wsd_core_space_type\]. Datentyp: Zeichenfolge |
| result.reservableUnits.name | Name des reservierbaren Elements. Datentyp: Zeichenfolge |
| result.reservableUnits.number | Eindeutiger Bezeichner des reservierbaren Elements. Dieser Wert ist besser lesbar als die sys_id. Datentyp: Zeichenfolge |
| Ergebnis.reservierbareEinheiten.Reihenfolge | Auftragsnummer für das reservierbare Element. Datentyp: Zahl |
| result.reservableUnits.require_approval | Kennzeichnung, die angibt, ob für das Reservieren des reservierbaren Elements eine Genehmigung erforderlich ist. Mögliche Werte: * true: Genehmigung erforderlich. * „false": Eine Genehmigung ist nicht erforderlich. Datentyp: Boolesch |
| result.reservableUnits.requires_check_in | Kennzeichnung, die angibt, ob der Anwender für das reservierbare Element einchecken muss. Gültige Werte: * true: Check-in erforderlich. * „false": Einchecken ist nicht erforderlich. Datentyp: Boolesch |
| Ergebnis.reservierbareEinheiten.reservierbare_Zwecke | Details zum Zweck der Reservierung des zugehörigen reservierbaren Elements. Datentyp: Array von Objekten "reservable_purposes": [ { "name": "String", "short_description": "String", "sys_id": "String" } ] |
| Ergebnis.reservierbareEinheiten.reservierbare_Zwecke.​Name | Name des reservierbaren Elements. Datentyp: Zeichenfolge |
| result.reservableUnits.reservable_zwecks.​short_description | Kurze Beschreibung des reservierbaren Elements. Datentyp: Zeichenfolge |
| result.reservableUnits.reservable_zwecke.​sys_id | Sys_id des reservierbaren Zweckdatensatzes. Befindet sich in der Tabelle „Zweck der reservierbaren Elemente" \[sn_wsd_rsv_reservable_zweck\]. Datentyp: Zeichenfolge |
| Ergebnis.reservierbareEinheiten.Reservierungen | Details zu den Reservierungen, die dem reservierbaren Element zugeordnet sind. Wird nur ausgefüllt, wenn der Abfrageparameter reservation_idsinclude_reservations_within_days auf „wahr" festgelegt ist und Reservierungs-IDs enthält. Dies bedeutet, dass bereits Reservierungen für dieses reservierbare Element vorhanden sind. Datentyp: Array von Objekten "reservations": [ { "configuration_item": "String", "end": "String", "is_collided": Boolean, "location": {Object}, "number": "String", "requested_for": {Object}, "reservation_purpose": {Object}, "start": "String", "state": {Object}, "subject": "String", "sys_id": "String" } ] |
| result.reservableUnits.reservations.​configuration_item | Configuration Items, die der Reservierung entsprechen. Befindet sich in der Tabelle cmdb_ci. Datentyp: Zeichenfolge |
| result.reservableUnits.reservations.end | Enddatum und -uhrzeit der Reservierung. Datentyp: Zeichenfolge Format: UTC: jjjj-mm-ttThh:mm:ssZ, z. B. 2021-02-05T18:00:00Z |
| result.reservableUnits.reservations.is_collided | Kennzeichnung, die angibt, ob die Reservierung mit der Start- und Endzeit der Suche kollidiert. Dies zeigt an, dass der zugeordnete reservierbare Standort bereits für den angegebenen Suchzeitraum reserviert ist. Mögliche Werte: * wahr: Kollision. * false: Keine Kollision. Datentyp: Boolesch |
| result.reservableUnits.reservations.location | Details zum Standort der Reservierung. Datentyp: Objekt "location": { "location": "String", "timezone": {Object} } |
| result.reservableUnits.reservations.location.​location | Sys_id des zugeordneten Standortdatensatzes. Zu finden in der Tabelle „Arbeitsplatzstandort" \[sn_wsd_core_workplace_location\]. Datentyp: Zeichenfolge |
| result.reservableUnits.reservations.location.​timezone | Details zur Zeitzone, die dem Standort zugeordnet ist. Datentyp: Objekt "timezone": { "displayValue": "String", "value": "String" } |
| result.reservableUnits.reservations.location.​timezone.displayValue | Anzeigewert für die Zeitzone, zu der dieser Standort gehört. Datentyp: Zeichenfolge |
| Ergebnis.reservierbareEinheiten.Reservierungen.Ort.​Zeitzone.Wert | Interner Wert für die Zeitzone, zu der dieser Standort gehört. Datentyp: Zeichenfolge |
| result.reservableUnits.reservations.number | Eindeutiger Bezeichner des reservierbaren Elements. Dieser Wert ist besser lesbar als die sys_id. Datentyp: Zeichenfolge |
| result.reservableUnits.reservations.​requested_for | Details zur Person, für die die Reservierung im Namen von angefordert wurde. Datentyp: Objekt "requested_for": { "name": "String", "sys_id": "String" } |
| result.reservableUnits.reservations.​requested_for.name | Name des Anwenders, für den die Reservierung angefordert wurde. Datentyp: Zeichenfolge |
| result.reservableUnits.reservations.​requested_for.sys_id | Sys_id des Anwenders, für den die Reservierung angefordert wird. Befindet sich in der Tabelle „Benutzer" \[sys_user\]. Datentyp: Zeichenfolge |
| result.reservableUnits.reservations.​reservation_zweck | Details zum Zweck der Reservierung. Datentyp: Objekt "reservation_purpose": { "display_value": "String," "value": "String" } |
| result.reservableUnits.reservations.​reservation_zweck.anzeige_wert | Anzeigewert für den Zweck der Reservierung, z. B. Unternehmensbesprechung. Datentyp: Zeichenfolge |
| result.reservableUnits.reservations.​reservation_zweck.wert | Interner Wert für den Zweck der Reservierung, z. B. „company_meeting". Datentyp: Zeichenfolge |
| result.reservableUnits.reservations.start | Startdatum und -uhrzeit der Reservierung. Datentyp: Zeichenfolge Format: UTC - jjjj-mm-ttThh:mm:ssZ, z. B. 2021-02-05T18:00:00Z |
| result.reservableUnits.reservations.state | Details zum Status der Reservierung für den Standort. Datentyp: Objekt "state": { "display_value": "String," "value": "String" } |
| result.reservableUnits.reservations.state.​display_value | Anzeigewert für den aktuellen Status der Reservierung, z. B. „Bestätigt". Datentyp: Zeichenfolge |
| result.reservableUnits.reservations.state.value | Interner Wert für den aktuellen Status der Reservierung, z. B. 2. Datentyp: Zeichenfolge |
| result.reservableUnits.reservations.subject | Betreff der Reservierung. Datentyp: Zeichenfolge |
| result.reservableUnits.reservations.sys_id | Erforderlich. Sys_id des Reservierungsdatensatzes. Befindet sich in der Tabelle „Arbeitsplatzreservierung" \[sn_wsd_rsv_reservation\]. Datentyp: Zeichenfolge |
| result.reservableUnits.reservable_quantity | Maximale Anzahl, wie oft das zugeordnete reservierbare Element für dieselbe Zeit reserviert werden kann. Dieser Wert wird verwendet, wenn Arbeitsbereichsbereiche einem Bereich zugewiesen werden. Datentyp: Ganzzahl |
| result.reservableUnits.showPrivacyOption | Kennzeichnung, die angibt, ob ein Mitarbeiter die Datenschutzeinstellungen für das zugeordnete reservierbare Element überschreiben kann. Weitere Informationen zu diesen Datenschutzeinstellungen finden Sie unter [Datenschutzeinstellungen für den Standort und ihre Auswirkungen](https://www.servicenow.com/docs/access?context=location-privacy-settings-and-impact&version=xanadu&pubname=xanadu-employee-service-management&ft:locale=en-US). Gültige Werte: * wahr: Datenschutzeinstellungen können überschrieben werden. * false: Die Datenschutzeinstellung kann nicht überschrieben werden. Datentyp: Boolesch |
| result.reservableUnits.site | Details zum Standort, auf dem sich das reservierbare Element befindet. Befindet sich in der Tabelle „Site" \[sn_wsd_core_site\]. "site": { "display_value": "String", "sys_id": "String" } |
| result.reservableUnits.site.display_value | Anzeigewert der Site. Datentyp: Zeichenfolge |
| result.reservableUnits.site.sys_id | Sys_id des zugeordneten Site-Datensatzes in der Site-Tabelle \[sn_wsd_core_site\]. Datentyp: Zeichenfolge |
| result.reservableUnits.standard_services | Zugehörige Standardservices, z. B. Flipchart, Bildschirmprojektor sowie Whiteboard und Marker. Datentyp: Array von Objekten "standard_services": [ { "font_awesome_icon": "String", "name": "String", "short_description": "String", "sys_id": "String" } ] |
| Ergebnis.reservierbareEinheiten.Standard_Services.​Schriftsatz_Symbol | Name des Miniatursymbols, das dem Standardservice zugeordnet ist. Datentyp: Zeichenfolge |
| result.reservableUnits.standard_services.name | Name des Miniatursymbols, das dem Standardservice zugeordnet ist. Datentyp: Zeichenfolge |
| result.reservableUnits.standard_services.​short_description | Kurze Beschreibung des Standardservice. Datentyp: Zeichenfolge |
| result.reservableUnits.standard_services.sys_id | Sys_id des Standardservicedatensatzes. Befindet sich in der Tabelle „Standardservice" \[sn_wsd_rsv_standard_service\]. Datentyp: Zeichenfolge |
| result.reservableUnits.sys_id | Sys_id des reservierbaren Datensatzes. Zu finden in der Tabelle „Arbeitsplatzstandort" \[sn_wsd_core_workplace_location\]. Datentyp: Zeichenfolge |
| result.reservableUnits.tableName | Name der Tabelle, in der sich der reservierbare Datensatz befindet. Datentyp: Zeichenfolge |
| result.reservableUnits.title | Titel des reservierbaren Elements. Datentyp: Zeichenfolge |
[ ]

### cURL-Anforderung

Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/search/best_match?q=building%3D9e0364cedb3650106c731dcd1396192b&start=2023-01-04T07%3A00%3A00Z&time_slot=d5331cf2dbb5f01038e42b24ca961906&end=2023-01-04T17%3A00%3A00Z&best_match_count=1&reservable_module=2b636b7e1b4e60103523ff751a4bcbe2&timezone=Europe%2FAmsterdam" \
    --request GET \
    --header "Accept:application/json" \
    --user "username":"password"

Ergebnisse zurückgeben:

    {
      "result": {
        "hasMore": false,
        "reservableUnits": [
          {
            "sys_id": "fe1f744edb7650106c731dcd139619ca",
            "external_id": null,
            "email": null,
            "name": "Aspen",
            "title": "Aspen",
            "description": "A room with large windows, dark leather seats and a large wooden table.",
            "image": {
              "sys_id": "41c74902dbb650106c731dcd13961944",
              "link": "41c74902dbb650106c731dcd13961944.iix"
            },
            "number": "ROOM0000903",
            "site": {
              "sys_id": "628eec06db7650106c731dcd139619dd",
              "display_value": "North America"
            },
            "campus": {
              "sys_id": "82b2a0cedb3650106c731dcd139619e9",
              "display_value": "California Campus"
            },
            "building": {
              "sys_id": "94e264cedb3650106c731dcd13961919",
              "display_value": "CAL-B1"
            },
            "floor": {
              "sys_id": "2f554296dbba10106c731dcd139619ed",
              "display_value": "Floor 2"
            },
            "area": null,
            "capacity": "16",
            "reservable_quantity": null,
            "location_type": {
              "sys_id": "20713b83eb512010b89bfdfc9c522899",
              "display_value": "Room",
              "name": "Room"
            },
            "order": null,
            "requires_check_in": null,
            "is_reservable": "1",
            "tableName": "sn_wsd_core_room",
            "require_approval": false,
            "standard_services": [
              {
                "sys_id": "abd0c18edb7650106c731dcd13961965",
                "name": "Projector screen",
                "short_description": "Connect laptop to screen (HDMI and DVI)",
                "font_awesome_icon": "fa-caret-square-o-right"
              }
            ],
            "reservable_purposes": [
              {
                "sys_id": "18f4c3cd1ba4e01051848489cc4bcb82",
                "name": "Board room",
                "short_description": null
              }
            ],
            "is_available": true,
            "reservations": [
              {
                "sys_id": "5fe65830874bc9106342b846dabb352b",
                "number": "WRES0001001",
                "location": {
                  "location": "fe1f744edb7650106c731dcd139619ca",
                  "timezone": {
                    "value": "US/Pacific",
                    "displayValue": "US/Pacific"
                  }
                },
                "configuration_item": null,
                "start": "2022-04-23T08:30:00Z",
                "end": "2022-04-23T09:30:00Z",
                "subject": null,
                "reservation_purpose": {
                  "value": "meeting",
                  "display_value": "Meeting"
                },
                "state": {
                  "value": "confirmed",
                  "display_value": "Confirmed"
                },
                "is_collided": false,
                "requested_for": {
                  "sys_id": "2de07e1887cb89106342b846dabb35fe",
                  "name": "Workplace User"
                }
              },
              {
                "sys_id": "af075c30874bc9106342b846dabb3572",
                "number": "WRES0001002",
                "location": {
                  "location": "fe1f744edb7650106c731dcd139619ca",
                  "timezone": {
                    "value": "US/Pacific",
                    "displayValue": "US/Pacific"
                  }
                },
                "configuration_item": null,
                "start": "2022-04-23T23:00:00Z",
                "end": "2022-04-24T00:00:00Z",
                "subject": null,
                "reservation_purpose": {
                  "value": "meeting",
                  "display_value": "Meeting"
                },
                "state": {
                  "value": "confirmed",
                  "display_value": "Confirmed"
                },
                "is_collided": false,
                "requested_for": {
                  "sys_id": "2de07e1887cb89106342b846dabb35fe",
                  "name": "Workplace User"
                }
              }
            ],
            "availableTimes": [
              [
                "2022-04-23 07:00:00",
                "2022-04-23 08:30:00"
              ],
              [
                "2022-04-23 09:30:00",
                "2022-04-23 23:00:00"
              ],
              [
                "2022-04-24 00:00:00",
                "2022-04-24 06:59:59"
              ]
            ],
            "is_favorite": false
          }
        ],
        "reservableContainers": [],
        "nextItemIndex": -1,
        "floorsOfSelectedBuilding": [
          {
            "sys_id": "2f554296dbba10106c731dcd139619ed",
            "display_value": "Floor 2",
            "external_id": null,
            "name": "Floor 2"
          }
        ]
      }
    }{
      "result": {
        "hasMore": false,
        "reservableUnits": [
          {
            "sys_id": "32f2a98adb7210106c731dcd13961972",
            "external_id": null,
            "wsd_email": null,
            "name": "B1-03-04",
            "title": "B1-03-04",
            "description": "Desk reserved for the Team-C. After 10am, free to reserve for everyone.",
            "image": {
              "sys_id": "57b42dcadb7210106c731dcd13961945",
              "link": "57b42dcadb7210106c731dcd13961945.iix"
            },
            "number": "SPCE0009018",
            "site": {
              "sys_id": "b17220cedb3650106c731dcd1396197a",
              "display_value": "Western Europe"
            },
            "campus": {
              "sys_id": "44d2e0cedb3650106c731dcd13961988",
              "display_value": "Amsterdam Campus"
            },
            "building": {
              "sys_id": "9e0364cedb3650106c731dcd1396192b",
              "display_value": "AMS-B1"
            },
            "floor": {
              "sys_id": "5373a8cedb3650106c731dcd1396198a",
              "display_value": "Floor 3"
            },
            "area": {
              "sys_id": "410ff04edb7650106c731dcd13961973",
              "display_value": "Desks C1"
            },
            "capacity": "1",
            "reservable_quantity": null,
            "location_type": {
              "sys_id": "5f017383eb512010b89bfdfc9c5228c8",
              "display_value": "Workspace/Desk",
              "name": "Workspace/Desk"
            },
            "order": null,
            "requires_check_in": null,
            "is_reservable": "1",
            "tableName": "sn_wsd_core_space",
            "require_approval": false,
            "is_available": true,
            "reservations": [],
            "availableTimes": [
              [
                "2023-01-04 07:00:00",
                "2023-01-04 17:00:00"
              ]
            ],
            "showPrivacyOption": false,
            "defaultPrivacyValue": false,
            "container": {
              "sys_id": "410ff04edb7650106c731dcd13961973",
              "display_value": "Desks C1",
              "floor": {
                "sys_id": "5373a8cedb3650106c731dcd1396198a",
                "display_value": "Floor 3",
                "name": "Floor 3"
              },
              "building": {
                "sys_id": "9e0364cedb3650106c731dcd1396192b",
                "display_value": "AMS-B1",
                "name": "AMS-B1"
              },
              "campus": {
                "sys_id": "44d2e0cedb3650106c731dcd13961988",
                "display_value": "Amsterdam Campus",
                "name": "Amsterdam Campus"
              },
              "capacity": 6,
              "image": {
                "sys_id": "d52c27b21b8e60103523ff751a4bcb49",
                "link": "d52c27b21b8e60103523ff751a4bcb49.iix"
              }
            },
            "includedInResult": true,
            "is_favorite": true
          }
        ],
        "reservableContainers": [
          {
            "sys_id": "410ff04edb7650106c731dcd13961973",
            "display_value": "Desks C1",
            "floor": {
              "sys_id": "5373a8cedb3650106c731dcd1396198a",
              "display_value": "Floor 3",
              "name": "Floor 3"
            },
            "building": {
              "sys_id": "9e0364cedb3650106c731dcd1396192b",
              "display_value": "AMS-B1",
              "name": "AMS-B1"
            },
            "campus": {
              "sys_id": "44d2e0cedb3650106c731dcd13961988",
              "display_value": "Amsterdam Campus",
              "name": "Amsterdam Campus"
            },
            "capacity": 6,
            "image": {
              "sys_id": "d52c27b21b8e60103523ff751a4bcb49",
              "link": "d52c27b21b8e60103523ff751a4bcb49.iix"
            }
          }
        ],
        "nextItemIndex": -1,
        "floorsOfSelectedBuilding": [
          {
            "sys_id": "5373a8cedb3650106c731dcd1396198a",
            "display_value": "Floor 3",
            "external_id": null,
            "name": "Floor 3"
          }
        ]
      }

## WSD-Suche: GET /api/sn_wsd_rsv/search/overlapping_reservation {#ariaid-title4}

Bestimmt, ob basierend auf den übergebenen Parametern eine überlappende Reservierung vorhanden ist.
<br />

### URL-Format

URL mit Versionsnummer: /api/sn_wsd_rsv/{api_version}/search/overlapping_reservation

Standard-URL: /api/sn_wsd_rsv/search/overlapping_reservation

### Unterstützte Anforderungsparameter

{#wsd_search-GET-overlap_resv__entry__2}{#wsd_search-GET-overlap_resv__version-RESTAPI}

| Name | Beschreibung |
|-|-|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel <kbd class="ph userinput">v1</kbd> oder <kbd class="ph userinput">v2</kbd>. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
[Tabelle : 13. Pfadparameter]

{#wsd_search-GET-overlap_resv__entry__6}

| Name | Beschreibung |
|-|-|
| end | Erforderlich. Endzeit, die zum Überprüfen auf sich überschneidende Reservierungen verwendet wird. Datentyp: Zeichenfolge Format: JJJJ-MM-TTTHH:MM:SSZ |
| recurring_pattern | Details zum wiederkehrenden Muster für die Reservierung. Datentyp: Objekt "recurring_pattern": { "duration": Number, "options": {Object}, "repeats": "String", "startDate":"String" } |
| recurring_pattern.duration | Dauer der Prüfung. Datentyp: Zahl Einheit: Sekunden |
| recurring_pattern.options | Details zu den Optionen, die mit der wiederkehrenden Reservierung verknüpft sind. Datentyp: Objekt "options": { "count": Number, "daysOfWeek": "String", "every": Number } |
| recurring_pattern.options.count | Anzahl der Wiederholungen des Musters. Datentyp: Zahl |
| recurring_pattern.options.daysOfWeek | Wochentage, an denen auf Überschneidungen geprüft werden soll. Gültige Werte: * 1 = Montag * 2 = Dienstag * 3 = Mittwoch * 4 = Donnerstag * 5 = Freitag * 6 = Samstag * 7 = Sonntag Um beispielsweise Dienstag, Donnerstag und Freitag anzugeben, übergeben Sie 245 (kein Trennzeichen). Datentyp: Zeichenfolge |
| recurring_pattern.options.every | Zu überprüfendes Musterwiederholungsintervall. Wenn dieser Wert beispielsweise <kbd class="ph userinput">2</kbd>ist, wird das Wiederholungsmuster basierend auf der Auswahl im Parameter repeats überprüft, z. B. jeden zweiten Tag oder jede zwei Woche. Datentyp: Zahl |
| recurring_pattern.options.repeats | Sich wiederholendes Muster für die Prüfung der Reservierungsüberschneidung. Mögliche Werte: (Groß-/Kleinschreibung beachten) * täglich * monatlich * wöchentlich * jährlich Datentyp: Zeichenfolge |
| reservable_id | Sys_id des reservierbaren Moduls zur Prüfung auf überlappende Reservierungen. Befindet sich in der Tabelle „Reservierbares Modul" \[sn_wsd_rsv_reservable_module\]. Datentyp: Zeichenfolge |
| „reservierung_id" | Sys_id der Reservierung zur Überprüfung auf Überschneidung. Dieser Wert wird im Bearbeitungs-Flow von übergeordneten Mehrfach-/Gruppen benötigt. Befindet sich in der Tabelle „Arbeitsplatzreservierung" \[sn_wsd_rsv_reservation\]. Datentyp: Zeichenfolge |
| shift_info_object | Details der Schicht, um auf Überschneidung zu prüfen. Weitere Informationen zu schichtbasierten Reservierungen finden Sie unter [Schichtbasierte Reservierung aktivieren](https://www.servicenow.com/docs/access?context=wsd-reservation-setup&version=xanadu&pubname=xanadu-employee-service-management&ft:locale=en-US). Datentyp: Objekt "shift_info_object": { "applyToShift": Boolean, "shift": "String", "timezone": "String" } |
| shift_info_object.applyToShift | Kennzeichnung, die angibt, ob schichtbasierte Reservierungen für das reservierbare Modul aktiviert sind. Gültige Werte: * „wahr": Schichtbasierte Reservierungen zulassen. * „falsch": Keine schichtbasierten Reservierungen zulassen. Datentyp: Boolesch |
| shift_info_object.shift | Sys_id der Schicht, die der Reservierung zugeordnet werden soll. Befindet sich in der Tabelle „Schicht" \[sn_wsd_core_shift\]. Wenn dieser Parameter übergeben wird, ist der Parameter end nicht erforderlich. Datentyp: Zeichenfolge |
| shift_info_object.timezone | Zeitzone der Schicht, in der auf Überschneidungen geprüft werden soll. Datentyp: Zeichenfolge |
| start | Erforderlich. Startzeit für die Prüfung auf sich überschneidende Reservierungen. Datentyp: Zeichenfolge Format: JJJJ-MM-TTTHH:MM:SSZ |
| user_id | Erforderlich. Sys_id des Anwenders zur Überprüfung auf überlappende Reservierungen. Befindet sich in der Tabelle „Benutzer" \[sys_user\]. Datentyp: Zeichenfolge |
[Tabelle : 14. Abfrageparameter]

{#wsd_search-GET-overlap_resv__entry__40}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 15. Anforderungstextparameter (XML oder JSON)]

### Kopfzeilen

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter [Unterstützte REST API-Header](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.").
{#wsd_search-GET-overlap_resv__entry__44}{#wsd_search-GET-overlap_resv__accept-RESTAPI}

| Kopfzeile | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
[Tabelle : 16. Anforderungskopfzeilen]

{#wsd_search-GET-overlap_resv__entry__48}

| Kopfzeile | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 17. Antwortkopfzeilen]

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter [HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API.
{#wsd_search-GET-overlap_resv__entry__52}{#wsd_search-GET-overlap_resv__entry-200-status-code}{#wsd_search-GET-overlap_resv__entry-400-status-code}{#wsd_search-GET-overlap_resv__entry-401-status-code}{#wsd_search-GET-overlap_resv__entry-404-status-code}{#wsd_search-GET-overlap_resv__entry-500-status-code}

| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
[Tabelle : 18. Statuscodes]

### Parameter des Antworttexts (JSON oder XML)

{#wsd_search-GET-overlap_resv__entry__64}

| Name | Beschreibung |
|-|-|
| Ergebnisse | Details der Ergebnisse der Überschneidungsprüfung. Datentyp: Objekt "results": { "isOverlapped": Boolean, "reservableId": "String" } |
| Ergebnisse.istÜberlappt | Kennzeichnung, die angibt, ob eine überlappende Reservierung vorhanden ist. Gültige Werte: * „wahr": Überlappende Reservierung vorhanden. * „falsch": Überlappende Reservierung ist nicht vorhanden. Datentyp: Boolesch |
| ergebnisse.reservierbareId | Im Falle einer Gruppenreservierung die sys_id des reservierbaren Elements, für das die Überschneidung auftritt. Datentyp: Zeichenfolge |
[ ]

### cURL-Anforderung

Das folgende Codebeispiel zeigt, wie nach einer Reservierungsüberschneidung für einen bestimmten Anwender und für einen bestimmten Zeitraum gesucht wird, der durch die Parameter start und end angegeben wird.

    curl "http://instance.servicenow.com/api/sn_wsd_rsv/search/overlapping_reservation?user_id=2e617fecc3d365101e38b23bb00131ec&end=2023-06-19T8:00:00Z&start=2023-06-19T07:00:00Z" \
    --request GET \
    --header "Accept:application/json" \
    --user 'username':'password'

Ergebnisse zurückgeben:

    {
    "results": {
      "isOverlapped": True,
      "reservableId": ""
      }
    }

## WSD-Suche: GET /api/sn_wsd_rsv/search/reservable {#ariaid-title5}

Sucht nach verfügbaren reservierbaren Elementen anhand einer angegebenen Konfiguration des Modells „Reservierbar".

### URL-Format

URL mit Versionsnummer: /api/sn_wsd_rsv/{api_version}/search/reservable

Standard-URL: /api/sn_wsd_rsv/search/reservable

### Unterstützte Anforderungsparameter

{#wsd_search-GET-reservable__entry__2}{#wsd_search-GET-reservable__version-RESTAPI}

| Name | Beschreibung |
|-|-|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel <kbd class="ph userinput">v1</kbd> oder <kbd class="ph userinput">v2</kbd>. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
[Tabelle : 19. Pfadparameter]

{#wsd_search-GET-reservable__entry__6}{#wsd_search-GET-reservable__end-query-reserv-entry}{#wsd_search-GET-reservable__ignore_same_day_validation-reserv-entry}{#wsd_search-GET-reservable__include_reservable_purposes-reserv-entry}{#wsd_search-GET-reservable__include_reservations_within_days-reserv-entry}{#wsd_search-GET-reservable__include_standard_services-reserv-entry}{#wsd_search-GET-reservable__neighborhood-reserv-entry}{#wsd_search-GET-reservable__q-reserv-entry}{#wsd_search-GET-reservable__reservable_module-reserv-entry}{#wsd_search-GET-reservable__reservation_ids-reserv-entry}{#wsd_search-GET-reservable__schedule_view_obj-reserv-entry}{#wsd_search-GET-reservable__schedule_view_obj-schedule_view_date-reserv-entry}{#wsd_search-GET-reservable__schedule_view_obj-timezone-entry}{#wsd_search-GET-reservable__start-query-reserv-entry}{#wsd_search-GET-reservable__shift-update_reserv-entry}{#wsd_search-GET-reservable__timezone_q_parm-reserv-query}

| Name | Beschreibung |
|-|-|
| end | Erforderlich. Endzeit für die Suche nach verfügbaren reservierbaren Modulen. Dieser Wert muss nach dem im Parameter start angegebenen Wert liegen. Datentyp: Zeichenfolge Format: UTC oder Ortszeit (JJJJ-MM-TT hh:mm:ss) |
| „exclude_reservables" | Liste mit einer oder mehreren sys_ids von reservierbaren Elementen, die aus den Suchergebnissen ausgeschlossen werden sollen. Die Tabelle, in der sich diese sys_ids befinden, ist im Feld „reservable_table" in der Tabelle „Reservierbares Modul" \[sn_wsd_rsv_reservable_module\] angegeben. Dies ist entweder die Tabelle „Raum" \[sn_wsd_core_space\] oder „Raum" \[sn_wsd_core_room\]. Datentyp: Zeichenfolge oder Array |
| „ignore_same_day_validation" | Kennzeichnung, die angibt, ob die Reservierungssuche die Änderung der Datumsvalidierung zwischen den Start- und Endparametern ignoriert. Gültige Werte: * „wahr": Validierung des Change-Datums ignorieren. * „falsch": Validierung des Change-Datums nicht ignorieren. Datentyp: Boolesch Standardwert: false |
| beinhaltet_reservierbare_Zwecke | Kennzeichnung, die angibt, ob der Zweck der Reservierung des Arbeitsplatzstandorts für jedes reservierbare Element in den Rückgabeergebnissen zurückgegeben werden soll. Diese Informationen befinden sich in der Tabelle „Zweck der reservierbaren Elemente" \[sn_wsd_rsv_reservable_zweck\]. Gültige Werte: * „wahr": Gibt die reservierbaren Zwecke zurück. * „falsch": Die reservierbaren Zwecke werden nicht zurückgegeben. Datentyp: Boolesch Standardwert: false |
| „include_reservations_within_days" | Kennzeichnung, die angibt, ob alle freien Zeitfenster der verfügbaren Zeiten in der Antwort für jedes reservierbare Element für den ganzen Tag zurückgegeben werden sollen. Gültige Werte: * „wahr": Gibt alle freien Slots zurück. * „falsch": Gibt nicht alle freien Slots zurück. Datentyp: Boolesch Standardwert: false |
| „include_standard_​services". | Kennzeichnung, die angibt, ob die Standardserviceinformationen in der Antwort zurückgegeben werden sollen. Ein Standardservice beschreibt grundlegende Bestimmungen, die mit einem reservierbaren Arbeitsplatzelement verfügbar sind, wenn die Reservierung vorgenommen wird, z. B. Whiteboards, zusätzliche Monitore und ähnliche Services. Weitere Informationen zu Standardservices finden Sie unter [Standardservices](https://www.servicenow.com/docs/access?context=standard-service&version=xanadu&pubname=xanadu-employee-service-management&ft:locale=en-US). Diese Informationen befinden sich in der Tabelle „Standardservice" \[sn_wsd_rsv_standard_service\]. Gültige Werte: * „wahr": Gibt die Informationen zu Standardservices zurück. * „falsch": Die Standardserviceinformationen werden nicht zurückgegeben. Datentyp: Boolesch Standardwert: false |
| „near_by_location_id" | Erforderlich, wenn der Parameter rsv_path auf <kbd class="ph userinput">„browse_near_a_person</kbd>" festgelegt ist. Sys_id des Standorts, der in der codierten Abfrage verwendet werden soll. Zu finden in der Tabelle „Arbeitsplatzstandort" \[sn_wsd_core_workplace_location\]. Datentyp: Zeichenfolge |
| Arbeitsbereich | Erforderlich, wenn der Parameter „ `rsv_path"` auf <kbd class="ph userinput">„browse_by_neight“ festgelegt</kbd>ist. Nur verfügbar, wenn das Plugin „Bereichsmanagement" (sn_wsd_spc_mgmt_neight) aktiviert ist. Sys_id des Arbeitsbereichsdatensatzes, der in der codierten Abfrage verwendet werden soll. Befindet sich in der Tabelle „Arbeitsumgebung" \[sn_wsd_spcmgmt_neightboarding\]. Weitere Informationen zu Bereichsreservierungen im Arbeitsbereich finden Sie unter [Create neighborhood reservations](https://www.servicenow.com/docs/access?context=create-neighborhood-reservations&version=xanadu&pubname=xanadu-employee-service-management&ft:locale=en-US). Datentyp: Zeichenfolge |
| Next_item_index | Index des nächsten abzurufenden Elements. Übergeben Sie diesen Parameter, wenn Sie die zurückgegebenen Ergebnisse paginieren. Datentyp: Zahl Standard: 0 |
| page_size | Maximale Anzahl von Datensätzen, die in den Rückgabeergebnissen zurückgegeben werden sollen. Datentyp: Zahl Standard: 6 |
| q | Erforderlich. Codierte Abfrage zum Filtern der zurückgegebenen Suchergebnisse. In dieser Abfrage müssen Sie die sys_id des Gebäudes angeben. Außerdem können Sie Parameter wie Stockwerk, Fläche, Kapazität, Standardservices und reservable_zwecke angeben. Alle übergebenen Parameter müssen sys_ids sein, mit Ausnahme der Kapazität, bei der es sich um eine Zahl handelt. For example: `q=building=94e264cedb3650106c731dcd13961919​^floorINfc7368cedb3650106c731dcd13961902​^capacity>=1​^standard_services=55c0818edb7650106c731dcd13961904​^reservable_purposes=d6e5c7cd1ba4e01051848489cc4bcb81` Sie können diese Informationen in den folgenden Tabellen finden: * Gebiet: sn_wsd_core_area * Gebäude: sn_wsd_core_building * Stockwerk: sn_wsd_core_stockwerk * Reservierbar -- Zwecke: sn_wsd_rsv_reservable_zweck * Standardservices: sn_wsd_rsv_standard_service Datentyp: Zeichenfolge |
| reservable_module | Erforderlich. Sys_id des reservierbaren Moduls, das in die Suche aufgenommen werden soll. Ein [reservierbares Modul](https://www.servicenow.com/docs/access?context=config-reservable-module&version=xanadu&pubname=xanadu-employee-service-management&ft:locale=en-US) gruppiert ähnliche Arten von Arbeitsplatzelementen. Befindet sich in der Tabelle „Reservierbares Modul" \[sn_wsd_rsv_reservable_module\]. Datentyp: Zeichenfolge |
| reservierung_ids | Kommagetrennte Liste der vorhandenen sys_ids für Reservierungen. Übergeben Sie diesen Parameter, wenn Sie die zugehörigen Reservierungen bearbeiten möchten. Befindet sich in der Tabelle „Arbeitsplatzreservierung" \[sn_wsd_rsv_reservation\]. Die für diese sys_ids für die entsprechenden reservierbaren Elemente blockierte Zeit wird als verfügbar behandelt. Datentyp: Zeichenfolge Standard: Keine |
| rsv_path | Reservierungspfad, der auf die Suche angewendet werden soll. Gültige Werte: * browse_all: Alle reservierbaren Elemente durchsuchen. * browse_by_area: Sucht die reservierbaren Elemente in der Nähe eines bestimmten Standorts. In der codierten Abfrage muss ein Bereichsbezeichner übergeben werden (Parameterq ). * browse_by_neightboarding: Sucht nach reservierbaren Elementen in der Nähe des im Parameter neighborhood angegebenen Arbeitsbereichs. * browse_near_a_person: Durchsucht die reservierbaren Elemente in der Nähe des Arbeitsplatzstandorts der im Parameter near_by_location_id angegebenen Person. Datentyp: Zeichenfolge Standard: browse_all |
| schedule_view_obj | Details zur zurückzugebenden Zeitplanansicht. Übergeben Sie dieses Objekt, wenn Sie 24-Stunden-Verfügbarkeitsdaten für Reservierungen benötigen, die sich über mehr als einen Tag erstrecken. Die zurückgegebenen Ergebnisse enthalten nur verfügbare Zeiten und Reservierungen für das angegebene Datum. Damit diese Funktionalität ordnungsgemäß funktioniert, müssen die Parameter ignore_same_day_validation und include_reservations_within_days auf <kbd class="ph userinput">true</kbd>festgelegt sein. Datentyp: Objekt "schedule_view_obj": { "schedule_view_date": "String", "timezone": "String" } |
| schedule_view_obj.schedule_view_date | Datum, ab dem die Rückgabe der Reservierungsverfügbarkeit beginnen soll. Dieses Datum muss in der Zeitzone liegen, die im Parameter schedule_view_obj.timezone angegeben ist. Datentyp: Zeichenfolge Format: JJJJ-MM-TT |
| schedule_view_obj.timezone | Gebäudezeitzone zur Bestimmung der zurückzugebenden Reservierungsverfügbarkeitsdaten. Beispiel: USA/Pazifik. Datentyp: Zeichenfolge |
| start | Erforderlich. Startzeit für die Suche nach verfügbaren reservierbaren Modulen. Dieser Wert muss vor dem im Parameter end angegebenen Wert liegen. Datentyp: Zeichenfolge Format: UTC oder Ortszeit (JJJJ-MM-TT hh:mm:ss) |
| Schicht | Sys_id der Schicht, die der Reservierung zugeordnet werden soll. Befindet sich in der Tabelle „Schicht" \[sn_wsd_core_shift\]. Wenn dieser Parameter übergeben wird, ist der Parameter end nicht erforderlich. Weitere Informationen zu schichtbasierten Reservierungen finden Sie unter [Schichtbasierte Reservierung aktivieren](https://www.servicenow.com/docs/access?context=wsd-reservation-setup&version=xanadu&pubname=xanadu-employee-service-management&ft:locale=en-US). Datentyp: Zeichenfolge |
| sort_by | Gewünschte Sortierreihenfolge der zurückgegebenen reservierbaren Elemente. Gültige Werte: * a_z: Aufsteigende Sortierreihenfolge. * Favoriten_first: Sortiert nach den bevorzugten reservierbaren Arbeitsplatzelementen des Anwenders, dann aufsteigend für den Rest. * z_a: Absteigende Sortierreihenfolge. Datentyp: Zeichenfolge Standard: a_z |
| Feld | Bevorzugte Zeitzone, z. B. Europa/Amsterdam. Datentyp: Zeichenfolge Standard: Keine |
[Tabelle : 20. Abfrageparameter]

{#wsd_search-GET-reservable__entry__50}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 21. Anforderungstextparameter]

### Kopfzeilen

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter [Unterstützte REST API-Header](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.").
{#wsd_search-GET-reservable__entry__54}{#wsd_search-GET-reservable__accept-reserv-entry}

| Kopfzeile | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Anforderungstexts. Unterstützte Typen: application/json, application/xml oder, text/xml Standard: application/json |
[Tabelle : 22. Anforderungskopfzeilen]

{#wsd_search-GET-reservable__entry__58}

| Kopfzeile | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 23. Antwortkopfzeilen]

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter [HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API.
{#wsd_search-GET-reservable__entry__62}{#wsd_search-GET-reservable__entry-200-status-code}{#wsd_search-GET-reservable__entry-401-status-code}{#wsd_search-GET-reservable__entry-404-status-code}{#wsd_search-GET-reservable__entry-500-status-code}

| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
[Tabelle : 24. Statuscodes]

### Parameter des Antwort-Haupttexts

{#wsd_search-GET-reservable__entry__72}{#wsd_search-GET-reservable__hasMore-reserv-entry}{#wsd_search-GET-reservable__nextItemIndex-reserv-entry}{#wsd_search-GET-reservable__reservableContainers-reserv-entry}{#wsd_search-GET-reservable__reservableContainers_building-reserv-entry}{#wsd_search-GET-reservable__reservableContainers_campus-reserv-entry}{#wsd_search-GET-reservable__reservableContainers_capacity-reserv-entry}{#wsd_search-GET-reservable__reservableContainers_display_value-reserv-entry}{#wsd_search-GET-reservable__reservableContainers_floor-reserv-entry}{#wsd_search-GET-reservable__reservableContainers_sys_id-reserv-container}{#wsd_search-GET-reservable__reservableUnit-reserv-entry}{#wsd_search-GET-reservable__reservableUnit_area-reserv-entry}{#wsd_search-GET-reservable__reservableUnit_area_display_value-reserv-entry}{#wsd_search-GET-reservable__reservableUnit_area_sys_id-reserv-entry}{#wsd_search-GET-reservable__availableTimes-reserv-entry}{#wsd_search-GET-reservable__reservableUnit_building-reserv-entry}{#wsd_search-GET-reservable__reservableUnit_description-reserv-entry}{#wsd_search-GET-reservable__reservableUnit_email-reserv-entry}{#wsd_search-GET-reservable__reservableUnit_external_id-reserv-entry}{#wsd_search-GET-reservable__reservableUnit_includedInResult-reserv-entry}{#wsd_search-GET-reservable__is_available-reserv-entry}{#wsd_search-GET-reservable__reservableUnit_is_favorite-reserv-entry}{#wsd_search-GET-reservable__reservableUnit_is_reservable-reserv-entry}{#wsd_search-GET-reservable__reservableUnit_is_reserved-reserv-entry}{#wsd_search-GET-reservable__reservableUnit_is_selected-reserv-entry}{#wsd_search-GET-reservable__reservableUnit_location_type-reserv-entry}{#wsd_search-GET-reservable__reservableUnit_location_type_name-reserv-entry}{#wsd_search-GET-reservable__reservableUnit_reservations-reserv-entry}{#wsd_search-GET-reservable__configuration_item-reserv-row}{#wsd_search-GET-reservable__is_collided-reserv-row}{#wsd_search-GET-reservable__reservableUnit_reservations_location-reserv-entry}

| Name | Beschreibung |
|-|-|
| Ergebnis | Gibt Ergebnisse für die angegebene Suche zurück. Datentyp: Objekt "result": { "filter": {Object}, "hasMore": Boolean, "nextFavIndex": Number, "nextItemIndex": Number, "reservableContainers": [Array], "reservableUnits": [Array], "totalProcessed": Number } |
| result.filter | Details zu den Stockwerken, den Standardservices und den Reservierungszwecken der reservierbaren Elemente. Wenn die Parameter include_standard_services oder include_reservable_purposes auf „false" festgelegt sind, sind standard_services und reservable_purposes leere Arrays. Datentyp: Objekt "filter": { "floors": [Array], "reservable_purposes": [Array], "standard_services": [Array] } |
| Ergebnis.Filter.Stockwerke | Details zum Stockwerk, auf dem sich das reservierbare Element befindet. Befindet sich in der Tabelle „Stockwerk" \[sn_wsd_core_stockwerk\]. Datentyp: Objekt "floors": [ { "display_value": "String", "sys_id": "String" } ] |
| Ergebnis.Filter.Stockwerke.Anzeigewert | Anzeigenummer des Stockwerks, in dem sich das reservierbare Element befindet, z. B. 12. Datentyp: Zeichenfolge |
| result.filter.stockwerk.sys_id | Sys_id des zugeordneten Datensatzes in der Tabelle „Stockwerk" \[sn_wsd_core_Floor\]. Datentyp: Zeichenfolge |
| result.filter.standard_services | Wird nur ausgefüllt, wenn der Parameter include_standard_services auf „wahr" festgelegt ist. Zugehörige Standardservices, z. B. Flipchart, Bildschirmprojektor sowie Whiteboard und Marker. Datentyp: Array von Objekten "standard_services": [ { "font_awesome_icon": "String", "name": "String", "short_description": "String", "sys_id": "String" } ] |
| Ergebnis.Filter.Standard_Services.​Schriftart_Symbol | Name des Miniatursymbols, das dem Standardservice zugeordnet ist. Datentyp: Zeichenfolge |
| result.filter.standard_services.name | Name des Standardservice. Datentyp: Zeichenfolge |
| result.filter.standard_services.short_description | Kurze Beschreibung des Standardservice. Datentyp: Zeichenfolge |
| result.filter.standard_services.sys_id | Sys_id des Standardservicedatensatzes. Befindet sich in der Tabelle „Standardservice" \[sn_wsd_rsv_standard_service\]. Datentyp: Zeichenfolge |
| result.filter.reservable_zwecke | Details zum Zweck der Reservierung des zugehörigen reservierbaren Elements. Datentyp: Array von Objekten "reservable_purposes": [ { "name": "String", "short_description": "String", "sys_id": "String" } ] |
| result.filter.reservable_purposes.name | Name des reservierbaren Elements. Datentyp: Zeichenfolge |
| result.filter.reservable_zwecks.​short_description | Kurze Beschreibung des reservierbaren Elements. Datentyp: Zeichenfolge |
| result.filter.reservable_zwecke.sys_id | Sys_id des reservierbaren Zweckdatensatzes. Befindet sich in der Tabelle „Zweck der reservierbaren Elemente" \[sn_wsd_rsv_reservable_zweck\]. Datentyp: Zeichenfolge |
| result.hasMore | Kennzeichnung, die angibt, ob in den Rückgabeergebnissen weitere reservierbare Elemente vorhanden sind. Mögliche Werte: * wahr: Weitere reservierbare Elemente verfügbar. * „falsch": Keine weiteren reservierbaren Elemente verfügbar. Datentyp: Boolesch |
| result.nextFavIndex | Index für das nächste bevorzugte reservierbare Element für den Anwender. Verwenden Sie diesen Wert, wenn Sie durch die bevorzugten reservierbaren Elemente des Anwenders paginieren. Datentyp: Zahl |
| result.nextItemIndex | Index für den nächsten abzurufenden reservierbaren Datensatz. Verwenden Sie diesen Wert beim Paginieren durch reservierbare Datensätze. Datentyp: Zahl |
| result.reservableContainers | Wird nur für reservierbare Module zurückgegeben, deren Feld „selection_type" auf „ <kbd class="ph userinput">container</kbd>" festgelegt ist. Ein Container ist eine Gruppierung ähnlicher Elemente, z. B. eine Gruppe von Schreibtischen. Datentyp: Array von Objekten "reservableContainers": [ { "building": {Object}, "campus": {Object}, "capacity": Number, "display_value": "String", "floor": {Object}, "image": {Object} "sys_id": "String" } ] |
| result.reservableContainers.building | Details zum Gebäude, das dem reservierbaren Container zugeordnet ist. Datentyp: Objekt "building": { "display_value": "String", "name": "String", "sys_id": "String" } |
| result.reservableContainers.building.​display_value | Anzeigewert für das Gebäude. Datentyp: Zeichenfolge |
| result.reservableContainers.building.name | Name des Gebäudes Datentyp: Zeichenfolge |
| result.reservableContainers.building.sys_id | Sys_id des zugeordneten Gebäudedatensatzes. Datentyp: Zeichenfolge |
| result.reservableContainers.campus | Details zum Campus, auf dem sich das reservierbare Element befindet. Befindet sich in der Tabelle „Campus" \[sn_wsd_core_campus\]. Datentyp: Objekt "campus": { "display_value": "String", "name": "String", "sys_id": "String" } |
| result.reservableContainers.campus.​display_value | Anzeigenummer des Campus, auf dem sich das reservierbare Element befindet, z. B. Ostbucht. Datentyp: Zeichenfolge |
| result.reservableContainers.campus.name | Name des Campus. Datentyp: Zeichenfolge |
| result.reservableContainers.campus.sys_id | Sys_id des zugeordneten Datensatzes. Befindet sich in der Tabelle „Campus" \[sn_wsd_core_campus\]. Datentyp: Zeichenfolge |
| result.reservableContainers.capacity | Maximale Anzahl von Personen für das reservierbare Element. Datentyp: Zahl |
| result.reservableContainers.display_value | Anzeigewert für den reservierbaren Container. Datentyp: Zeichenfolge |
| Ergebnis.reservierbareContainer.Stockwerk | Details zum Stockwerk, das dem reservierbaren Container zugeordnet ist. Datentyp: Objekt "floor": { "display_value": "String", "name": "String", "sys_id": "String" } |
| Ergebnis.reservierbareContainer.Stockwerk.​Anzeigewert | Anzeigenummer des Stockwerks, in dem sich das reservierbare Element befindet, z. B. 12. Datentyp: Zeichenfolge |
| result.reservableContainers.floor.name | Name des Stockwerks, in dem sich das reservierbare Element befindet. Datentyp: Zeichenfolge |
| Ergebnis.reservierbareContainer.Stockwerk.sys_id | Sys_id des zugeordneten Datensatzes in der Tabelle „Stockwerk" \[sn_wsd_core_Floor\]. Datentyp: Zeichenfolge |
| result.reservableContainers.image | Link zu einem Bild, das das Layout für dieses reservierbare Element darstellt. Befindet sich in der Tabelle „Images" \[db_image\]. Datentyp: Zeichenfolge |
| result.reservableContainers.image.link | Link zu einem Bild, das das Layout für dieses reservierbare Element darstellt. Befindet sich in der Tabelle „Images" \[db_image\]. Datentyp: Zeichenfolge |
| result.reservableContainers.image.sys_id | Sys_id des zugeordneten Image-Datensatzes. Datentyp: Zeichenfolge |
| result.reservableContainers.sys_id | Sys_id des zugeordneten Containerdatensatzes. Die Tabelle, in der sich befindet, kann für jeden Containertyp konfiguriert werden. Standardmäßig befindet er sich in der Tabelle „Bereich" \[sn_wsd_core_area\]. Datentyp: Zeichenfolge |
| result.reservableUnits | Details zu den reservierbaren Einheiten, die den angegebenen Suchkriterien entsprechen. Eine reservierbare Einheit ist ein einzelnes reservierbares Element wie ein Schreibtisch oder ein Stuhl. Datentyp: Objekt "reservableUnits": [ { "area": "String", "availableTimes": [Array], "building": {Object}, "campus": {Object}, "capacity": "String", "defaultPrivacyValue": Boolean, "description": "String", "email": "String", "external_id": "String", "floor": {Object}, "image": {Object}, "includedInResult": Boolean, "is_available": Boolean, "is_favorite": Boolean, "is_reservable": "String", "is_reserved": Boolean, "is_selected": Boolean, "location_type": {Object}, "name": "String", "number": "String", "order": "String", "require_approval": Boolean, "requires_check_in": Boolean, "reservable_quantity": "String", "showPrivacyOption": Boolean, "site": {Object}, "standard_services": [Array], "tableName": "String", "title": "String", "reservable_purposes": [Array], "reservations": [Array], "sys_id": "String" } ] |
| Ergebnis.reservierbareEinheiten.Bereich | Details zum Bereich, in dem sich das reservierbare Modul befindet. Befindet sich in der Tabelle „Bereich" \[sn_wsd_core_area\]. Datentyp: Objekt "area": { "display_value": "String", "sys_id": "String" } |
| Ergebnis.reservierbareEinheiten.Bereich.Anzeigewert | Anzeigewert für den reservierbaren Modulbereich. Datentyp: Zeichenfolge |
| result.reservableUnits.area.sys_id | Sys_id des Bereichsdatensatzes, der dem reservierbaren Element zugeordnet ist. Datentyp: Zeichenfolge |
| result.reservableUnits.availableTimes | Liste der Daten/Uhrzeiten, zu denen das zugeordnete reservierbare Element verfügbar ist. Datentyp: Array |
| Ergebnis.reservierbareEinheiten.Gebäude | Details zum Gebäude, in dem sich das reservierbare Element befindet. Befindet sich in der Tabelle „Gebäude" \[sn_wsd_core_building\]. Datentyp: Objekt "building": { "display_value": "String", "sys_id": "String" } |
| result.reservableUnits.building.display_value | Anzeigewert für das Gebäude. Datentyp: Zeichenfolge |
| result.reservableUnits.building.sys_id | Sys_id des zugeordneten Gebäudedatensatzes. Datentyp: Zeichenfolge |
| Ergebnis.reservierbareEinheiten.Campus | Details zum Campus, auf dem sich das reservierbare Element befindet. Befindet sich in der Tabelle „Campus" \[sn_wsd_core_campus\]. Datentyp: Objekt "campus": { "display_value": "String", "sys_id": "String" } |
| result.reservableUnits.campus.display_value | Anzeigenummer des Campus, auf dem sich das reservierbare Element befindet, z. B. Ostbucht. Datentyp: Zeichenfolge |
| result.reservableUnits.campus.sys_id | Sys_id des zugeordneten Datensatzes. Befindet sich in der Tabelle „Campus" \[sn_wsd_core_campus\]. Datentyp: Zeichenfolge |
| Ergebnis.reservierbareEinheiten.Kapazität | Maximale Anzahl von Personen für das reservierbare Element. Datentyp: Zahl |
| result.reservableUnits.description | Kurze Beschreibung des reservierbaren Elements. Datentyp: Zeichenfolge |
| result.reservableUnits.email | E-Mail-Adresse für das reservierbare Element. Datentyp: Zeichenfolge |
| result.reservableUnits.external_id | Externe ID des reservierbaren Elements, die zum Synchronisieren eines im CMS zugeordneten Platzes verwendet wird. Dieser Wert wird nur ausgefüllt, wenn diesem Standort eine Karte zugeordnet ist. Datentyp: Zeichenfolge |
| Ergebnis.reservierbareEinheiten.Stockwerk | Details zum Stockwerk, auf dem sich das reservierbare Element befindet. Befindet sich in der Tabelle „Stockwerk" \[sn_wsd_core_stockwerk\]. Datentyp: Objekt "floor": { "display_value": "String", "sys_id": "String" } |
| Ergebnis.reservierbareEinheiten.Stockwerk.Anzeigewert | Anzeigenummer des Stockwerks, in dem sich das reservierbare Element befindet, z. B. 12. Datentyp: Zeichenfolge |
| Ergebnis.reservierbareEinheiten.Stockwerk.sys_id | Sys_id des zugeordneten Datensatzes in der Tabelle „Stockwerk" \[sn_wsd_core_Floor\]. Datentyp: Zeichenfolge |
| result.reservableUnits.image | Details zu einem Bild, das das Layout für das zugeordnete reservierbare Element darstellt. Befindet sich in der Tabelle „Images" \[db_image\]. "image": { "link": "String", "sys_id": "String" } |
| result.reservableUnits.image.link | Link zu einem Bild, das das Layout für dieses reservierbare Element darstellt. Befindet sich in der Tabelle „Images" \[db_image\]. Datentyp: Zeichenfolge |
| result.reservableUnits.image.sys_id | Sys_id des zugeordneten Image-Datensatzes. Datentyp: Zeichenfolge |
| result.reservableUnits.includedInResult | Kennzeichnung, die angibt, ob das aktuelle reservierbare Element in den zurückgegebenen Ergebnissen enthalten ist. Gültige Werte: * wahr: In den zurückgegebenen Ergebnissen enthalten. * false: Nicht in den zurückgegebenen Ergebnissen enthalten. Datentyp: Boolesch |
| Ergebnis.reservierbareEinheiten.ist_verfügbar | Kennzeichnung, die angibt, ob das reservierbare Element zum Reservieren verfügbar ist. Gültige Werte: * true: Zum Reservieren verfügbar. * false: Nicht zum Reservieren verfügbar. Datentyp: Boolesch |
| result.reservableUnits.is_favorite | Kennzeichnung, die angibt, ob das reservierbare Element als einer der Favoriten des zugeordneten Anwenders gekennzeichnet ist. Gültige Werte: * true: Favorit. * false: Kein Favorit. Datentyp: Boolesch |
| Ergebnis.reservierbareEinheiten.ist_reservierbar | Kennzeichnung, die angibt, ob dieses reservierbare Element reserviert werden kann. Hinweis: Wenn der Abfrageparameter include_unavailable_items auf „true" festgelegt ist, werden auch nicht verfügbare Standorte zurückgegeben. Wenn in diesem Fall ein Standort bereits reserviert ist, ist der Parameter is_available auf „falsch" festgelegt, is_reservable jedoch auf „wahr". Gültige Werte: * true: Zum Reservieren verfügbar. * false: Nicht zum Reservieren verfügbar. Datentyp: Boolesch |
| result.reservableUnits.is_reserved | Kennzeichnung, die angibt, ob das reservierbare Element bereits reserviert ist. Gültige Werte: * true: Zum Reservieren verfügbar. * „false": Bereits reserviert. Datentyp: Boolesch |
| Ergebnis.reservierbareEinheiten.ist_ausgewählt | Kennzeichnung, die angibt, ob das reservierbare Element bereits reserviert ist. Gültige Werte: * true: Zum Reservieren verfügbar. * „false": Bereits reserviert. Datentyp: Boolesch |
| result.reservableUnits.location_type | Details zum Standorttyp des reservierbaren Elements, z. B. Arbeitsplatz/Schreibtisch, Café oder Studio. Zu finden in der Tabelle „Arbeitsplatzstandort" \[sn_wsd_core_workplace_location\]. "location_type": { "display_value": "String", "name": "String", "sys_id": "String" } |
| result.reservableUnits.location_type.​display_value | Anzeigewert des Ortstyps. Datentyp: Zeichenfolge |
| result.reservableUnits.location_type.name | Name des Standorttyps, z. B. Basement oder Lager. Identisch mit Anzeigewert. Datentyp: Zeichenfolge |
| result.reservableUnits.location_type.sys_id | Sys_id des zugeordneten Datensatzes in der Tabelle „Platztyp" \[sn_wsd_core_space_type\]. Datentyp: Zeichenfolge |
| result.reservableUnits.name | Name des reservierbaren Elements. Datentyp: Zeichenfolge |
| result.reservableUnits.number | Eindeutiger Bezeichner des reservierbaren Elements. Dieser Wert ist besser lesbar als die sys_id. Datentyp: Zeichenfolge |
| Ergebnis.reservierbareEinheiten.Reihenfolge | Auftragsnummer für das reservierbare Element. Datentyp: Zahl |
| result.reservableUnits.require_approval | Kennzeichnung, die angibt, ob für das Reservieren des reservierbaren Elements eine Genehmigung erforderlich ist. Mögliche Werte: * true: Genehmigung erforderlich. * „false": Eine Genehmigung ist nicht erforderlich. Datentyp: Boolesch |
| result.reservableUnits.requires_check_in | Kennzeichnung, die angibt, ob der Anwender für das reservierbare Element einchecken muss. Gültige Werte: * true: Check-in erforderlich. * „false": Einchecken ist nicht erforderlich. Datentyp: Boolesch |
| Ergebnis.reservierbareEinheiten.reservierbare_Zwecke | Details zum Zweck der Reservierung des zugehörigen reservierbaren Elements. Datentyp: Array von Objekten "reservable_purposes": [ { "name": "String", "short_description": "String", "sys_id": "String" } ] |
| Ergebnis.reservierbareEinheiten.reservierbare_Zwecke.​Name | Name des reservierbaren Elements. Datentyp: Zeichenfolge |
| result.reservableUnits.reservable_zwecks.​short_description | Kurze Beschreibung des reservierbaren Elements. Datentyp: Zeichenfolge |
| result.reservableUnits.reservable_zwecke.​sys_id | Sys_id des reservierbaren Zweckdatensatzes. Befindet sich in der Tabelle „Zweck der reservierbaren Elemente" \[sn_wsd_rsv_reservable_zweck\]. Datentyp: Zeichenfolge |
| Ergebnis.reservierbareEinheiten.Reservierungen | Details zu den Reservierungen, die dem reservierbaren Element zugeordnet sind. Wird nur ausgefüllt, wenn der Abfrageparameter reservation_idsinclude_reservations_within_days auf „wahr" festgelegt ist und Reservierungs-IDs enthält. Dies bedeutet, dass bereits Reservierungen für dieses reservierbare Element vorhanden sind. Datentyp: Array von Objekten "reservations": [ { "configuration_item": "String", "end": "String", "is_collided": Boolean, "location": {Object}, "number": "String", "requested_for": {Object}, "reservation_purpose": {Object}, "start": "String", "state": {Object}, "subject": "String", "sys_id": "String" } ] |
| result.reservableUnits.reservations.​configuration_item | Configuration Items, die der Reservierung entsprechen. Befindet sich in der Tabelle cmdb_ci. Datentyp: Zeichenfolge |
| result.reservableUnits.reservations.end | Enddatum und -uhrzeit der Reservierung. Datentyp: Zeichenfolge Format: UTC: jjjj-mm-ttThh:mm:ssZ, z. B. 2021-02-05T18:00:00Z |
| result.reservableUnits.reservations.is_collided | Kennzeichnung, die angibt, ob die Reservierung mit der Start- und Endzeit der Suche kollidiert. Dies zeigt an, dass der zugeordnete reservierbare Standort bereits für den angegebenen Suchzeitraum reserviert ist. Mögliche Werte: * wahr: Kollision. * false: Keine Kollision. Datentyp: Boolesch |
| result.reservableUnits.reservations.location | Details zum Standort der Reservierung. Datentyp: Objekt "location": { "location": "String", "timezone": {Object} } |
| result.reservableUnits.reservations.location.​location | Sys_id des zugeordneten Standortdatensatzes. Zu finden in der Tabelle „Arbeitsplatzstandort" \[sn_wsd_core_workplace_location\]. Datentyp: Zeichenfolge |
| result.reservableUnits.reservations.location.​timezone | Details zur Zeitzone, die dem Standort zugeordnet ist. Datentyp: Objekt "timezone": { "displayValue": "String", "value": "String" } |
| result.reservableUnits.reservations.location.​timezone.displayValue | Anzeigewert für die Zeitzone, zu der dieser Standort gehört. Datentyp: Zeichenfolge |
| Ergebnis.reservierbareEinheiten.Reservierungen.Ort.​Zeitzone.Wert | Interner Wert für die Zeitzone, zu der dieser Standort gehört. Datentyp: Zeichenfolge |
| result.reservableUnits.reservations.number | Eindeutiger Bezeichner des reservierbaren Elements. Dieser Wert ist besser lesbar als die sys_id. Datentyp: Zeichenfolge |
| result.reservableUnits.reservations.​requested_for | Details zur Person, für die die Reservierung im Namen von angefordert wurde. Datentyp: Objekt "requested_for": { "name": "String", "sys_id": "String" } |
| result.reservableUnits.reservations.​requested_for.name | Name des Anwenders, für den die Reservierung angefordert wurde. Datentyp: Zeichenfolge |
| result.reservableUnits.reservations.​requested_for.sys_id | Sys_id des Anwenders, für den die Reservierung angefordert wird. Befindet sich in der Tabelle „Benutzer" \[sys_user\]. Datentyp: Zeichenfolge |
| result.reservableUnits.reservations.​reservation_zweck | Details zum Zweck der Reservierung. Datentyp: Objekt "reservation_purpose": { "display_value": "String," "value": "String" } |
| result.reservableUnits.reservations.​reservation_zweck.anzeige_wert | Anzeigewert für den Zweck der Reservierung, z. B. Unternehmensbesprechung. Datentyp: Zeichenfolge |
| result.reservableUnits.reservations.​reservation_zweck.wert | Interner Wert für den Zweck der Reservierung, z. B. „company_meeting". Datentyp: Zeichenfolge |
| result.reservableUnits.reservations.start | Startdatum und -uhrzeit der Reservierung. Datentyp: Zeichenfolge Format: UTC - jjjj-mm-ttThh:mm:ssZ, z. B. 2021-02-05T18:00:00Z |
| result.reservableUnits.reservations.state | Details zum Status der Reservierung für den Standort. Datentyp: Objekt "state": { "display_value": "String," "value": "String" } |
| result.reservableUnits.reservations.state.​display_value | Anzeigewert für den aktuellen Status der Reservierung, z. B. „Bestätigt". Datentyp: Zeichenfolge |
| result.reservableUnits.reservations.state.value | Interner Wert für den aktuellen Status der Reservierung, z. B. 2. Datentyp: Zeichenfolge |
| result.reservableUnits.reservations.subject | Betreff der Reservierung. Datentyp: Zeichenfolge |
| result.reservableUnits.reservations.sys_id | Erforderlich. Sys_id des Reservierungsdatensatzes. Befindet sich in der Tabelle „Arbeitsplatzreservierung" \[sn_wsd_rsv_reservation\]. Datentyp: Zeichenfolge |
| result.reservableUnits.reservable_quantity | Maximale Anzahl, wie oft das zugeordnete reservierbare Element für dieselbe Zeit reserviert werden kann. Dieser Wert wird verwendet, wenn Arbeitsbereichsbereiche einem Bereich zugewiesen werden. Datentyp: Ganzzahl |
| result.reservableUnits.site | Details zum Standort, auf dem sich das reservierbare Element befindet. Befindet sich in der Tabelle „Site" \[sn_wsd_core_site\]. "site": { "display_value": "String", "sys_id": "String" } |
| result.reservableUnits.site.display_value | Anzeigewert der Site. Datentyp: Zeichenfolge |
| result.reservableUnits.site.sys_id | Sys_id des zugeordneten Site-Datensatzes in der Site-Tabelle \[sn_wsd_core_site\]. Datentyp: Zeichenfolge |
| result.reservableUnits.standard_services | Zugehörige Standardservices, z. B. Flipchart, Bildschirmprojektor sowie Whiteboard und Marker. Datentyp: Array von Objekten "standard_services": [ { "font_awesome_icon": "String", "name": "String", "short_description": "String", "sys_id": "String" } ] |
| Ergebnis.reservierbareEinheiten.Standard_Services.​Schriftsatz_Symbol | Name des Miniatursymbols, das dem Standardservice zugeordnet ist. Datentyp: Zeichenfolge |
| result.reservableUnits.standard_services.name | Name des Miniatursymbols, das dem Standardservice zugeordnet ist. Datentyp: Zeichenfolge |
| result.reservableUnits.standard_services.​short_description | Kurze Beschreibung des Standardservice. Datentyp: Zeichenfolge |
| result.reservableUnits.standard_services.sys_id | Sys_id des Standardservicedatensatzes. Befindet sich in der Tabelle „Standardservice" \[sn_wsd_rsv_standard_service\]. Datentyp: Zeichenfolge |
| result.reservableUnits.sys_id | Sys_id des reservierbaren Datensatzes. Zu finden in der Tabelle „Arbeitsplatzstandort" \[sn_wsd_core_workplace_location\]. Datentyp: Zeichenfolge |
| result.reservableUnits.tableName | Name der Tabelle, in der sich der reservierbare Datensatz befindet. Datentyp: Zeichenfolge |
| result.reservableUnits.title | Titel des reservierbaren Elements. Datentyp: Zeichenfolge |
| Ergebnis.gesamtVerarbeitet | Gesamtzahl der verarbeiteten Datensätze. Datentyp: Zahl |
[ ]

### cURL-Anforderung {#wsd_search-GET-reservable__example_w3q_yn1_hzb}

In diesem Beispiel wird gezeigt, wie Sie mit diesem Endpunkt nach reservierbaren Elementen suchen. Hinweis: Den Abfrageparametern wurden Zeilenumbrüche hinzugefügt, um das Lesen zu erleichtern.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/search/reservable?
    reservable_module=d9864189c3653910977396cb05013100&
    start=2023-10-12T10:30:00Z&
    end=2023-10-13T11:30:00Z&
    include_standard_services=true&
    include_reservable_purposes=true&
    include_reservations_within_days=true&
    include_unavailable_items=true&
    near_by_location_id=undefined&
    timezone=Europe/Paris&
    page_size=6&
    sort_by=a_z&
    view=schedule&
    rsv_path=browse_all&
    ignore_same_day_validation=true&
    schedule_view_obj={"schedule_view_date":"2023-10-12","timezone":"Europe/Paris"}&
    q=building=dea39b1977220110b3d7be377b5a9955\
    --request GET \
    --header "Accept:application/json" 
    --user "username":"password"

Ergebnisse zurückgeben:

    {
      "result": {
        "hasMore": true,
        "reservableUnits": [
          {
            "sys_id": "fe1f744edb7650106c731dcd139619ca",
            "external_id": null,
            "email": null,
            "name": "Aspen",
            "title": "Aspen",
            "description": "A room with large windows, dark leather seats and a large wooden table.",
            "image": {
              "sys_id": "41c74902dbb650106c731dcd13961944",
              "link": "41c74902dbb650106c731dcd13961944.iix"
            },
            "number": "ROOM0000903",
            "site": {
              "sys_id": "628eec06db7650106c731dcd139619dd",
              "display_value": "North America"
            },
            "campus": {
              "sys_id": "82b2a0cedb3650106c731dcd139619e9",
              "display_value": "California Campus"
            },
            "building": {
              "sys_id": "94e264cedb3650106c731dcd13961919",
              "display_value": "CAL-B1"
            },
            "floor": {
              "sys_id": "2f554296dbba10106c731dcd139619ed",
              "display_value": "Floor 2"
            },
            "area": null,
            "capacity": "16",
            "reservable_quantity": null,
            "location_type": {
              "sys_id": "20713b83eb512010b89bfdfc9c522899",
              "display_value": "Room",
              "name": "Room"
            },
            "order": null,
            "requires_check_in": null,
            "is_reservable": "1",
            "tableName": "sn_wsd_core_room",
            "require_approval": false,
            "standard_services": [
              {
                "sys_id": "9b01458edb7650106c731dcd13961945",
                "name": "Flip chart",
                "short_description": "Flip chart with paper sheets",
                "font_awesome_icon": "fa-calendar-o"
              }
            ],
            "reservable_purposes": [
              {
                "sys_id": "18f4c3cd1ba4e01051848489cc4bcb82",
                "name": "Board room",
                "short_description": null
              }
            ],
            "is_available": true,
            "reservations": [
              {
                "sys_id": "5fe65830874bc9106342b846dabb352b",
                "number": "WRES0001001",
                "location": {
                  "location": "fe1f744edb7650106c731dcd139619ca",
                  "timezone": {
                    "value": "US/Pacific",
                    "displayValue": "US/Pacific"
                  }
                },
                "configuration_item": null,
                "start": "2022-04-23T08:30:00Z",
                "end": "2022-04-23T09:30:00Z",
                "subject": null,
                "reservation_purpose": {
                  "value": "meeting",
                  "display_value": "Meeting"
                },
                "state": {
                  "value": "confirmed",
                  "display_value": "Confirmed"
                },
                "is_collided": false,
                "requested_for": {
                  "sys_id": "2de07e1887cb89106342b846dabb35fe",
                  "name": "Workplace User"
                }
              }
            ],
            "availableTimes": [
              [
                "2022-04-23 07:00:00",
                "2022-04-23 08:30:00"
              ],
              [
                "2022-04-23 09:30:00",
                "2022-04-23 23:00:00"
              ]
            ],
           "is_reserved": true,
           "is_selected": true,
            "includedInResult": true,
            "is_favorite": false
          }
        ],
        "reservableContainers": [],
        "nextItemIndex": -1,
        "filter": {
          "floors": [],
          "standard_services": [
            {
              "sys_id": "9b01458edb7650106c731dcd13961945",
              "name": "Flip chart",
              "short_description": "Flip chart with paper sheets",
              "font_awesome_icon": "fa-calendar-o"
            }
          ],
          "reservable_purposes": [
            {
              "sys_id": "18f4c3cd1ba4e01051848489cc4bcb82",
              "name": "Board room",
              "short_description": null
            }
          ]
        },
        "totalProcessed": 2,
        "nextFavIndex": 0
      }
    }

## WSD-Suche -- GET /api/sn_wsd_rsv/search/shift/{building_id}/{module_id} {#ariaid-title6}

Gibt eine codierte Abfrage zurück, mit der Sie nach verfügbaren Schichten in der Tabelle „Schicht" \[sn_wsd_core_shift\] suchen können.
Gilt nur, wenn das Feld „appy_to_shift" im angegebenen reservierbaren Modul aktiviert ist. Andernfalls ist die zurückgegebene codierte Abfragezeichenfolge leer.

### URL-Format

URL mit Versionsnummer: /api/sn_wsd_rsv/{api_version}/search/shift/{building_id}/{module_id}

Standard-URL: /api/sn_wsd_rsv/search/shift/{building_id}/{module_id}

### Unterstützte Anforderungsparameter

{#wsd_search-GET-shift__entry__2}{#wsd_search-GET-shift__version-RESTAPI}

| Name | Beschreibung |
|-|-|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel <kbd class="ph userinput">v1</kbd> oder <kbd class="ph userinput">v2</kbd>. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| „building_id" | Sys_id des Gebäudes, das in die Suchabfrage aufgenommen werden soll. Befindet sich in der Tabelle „Gebäude" \[sn_wsd_core_building\]. Datentyp: Zeichenfolge |
| module_id | Sys_id des reservierbaren Moduls, das in die Suchabfrage aufgenommen werden soll. Befindet sich in der Tabelle „Reservierbares Modul" \[sn_wsd_core_reservable_module\]. Ein reservierbares Modul gruppiert ähnliche Arten von Arbeitsplatzelementen, wie z. B. Stühle oder Schreibtische. Datentyp: Zeichenfolge |
[Tabelle : 25. Pfadparameter]

{#wsd_search-GET-shift__entry__10}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 26. Abfrageparameter]

{#wsd_search-GET-shift__entry__14}

| Name | Beschreibung |
|-|-|
| end_date | Enddatum und -uhrzeit der Schicht, die in die codierte Abfrage aufgenommen werden sollen. Datentyp: Zeichenfolge Format: jjjj-mm-tt hh:mm:ss |
| start_date | Startdatum und -uhrzeit der Schicht, die in die codierte Abfrage aufgenommen werden sollen. Datentyp: Zeichenfolge Format: jjjj-mm-tt hh:mm:ss |
[Tabelle : 27. Anforderungstextparameter]

### Header

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter [Unterstützte REST API-Header](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.").
{#wsd_search-GET-shift__entry__20}{#wsd_search-GET-shift__accept-reserv-entry}

| Kopfzeile | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Anforderungstexts. Unterstützte Typen: application/json, application/xml oder, text/xml Standard: application/json |
[Tabelle : 28. Anforderungskopfzeilen]

{#wsd_search-GET-shift__entry__24}

| Kopfzeile | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 29. Antwortkopfzeilen]

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter [HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API.
{#wsd_search-GET-shift__entry__28}{#wsd_search-GET-shift__entry-200-status-code}{#wsd_search-GET-shift__entry-401-status-code}{#wsd_search-GET-shift__entry-404-status-code}{#wsd_search-GET-shift__entry-500-status-code}

| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
[Tabelle : 30. Statuscodes]

### Parameter des Antwort-Haupttexts

{#wsd_search-GET-shift__entry__38}

| Name | Beschreibung |
|-|-|
| Ergebnis | Codierte Abfrage zum Erfassen der angegebenen verfügbaren Schichten. Datentyp: Objekt "result": { "moduleHasShift" : Boolean, "query": "String" } |
| moduleHasShift | Kennzeichnung, die angibt, ob für das angegebene reservierbare Modul Schichten aktiviert sind. Gültige Werte: * „wahr": Für das reservierbare Modul sind Schichten aktiviert. * „falsch": Für das reservierbare Modul sind keine Schichten aktiviert. Keine codierte Abfrage zurückgegeben. Datentyp: Boolesch |
| query | Codierte Abfrage zum Abrufen von Schichtinformationen für das angegebene reservierbare Modul. Datentyp: Zeichenfolge |
[ ]

### cURL-Anforderung

Das folgende Codebeispiel zeigt, wie dieser Endpunkt verwendet wird, um eine schichtcodierte Abfrage zu erhalten.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/search/shift/94e264cedb3650106c731dcd13961919/fc71f64fdb42a01097acc900399619a8?start_date=2022-04-23 16:00:00&end_date=2022-04-28 16:00:00"  \
    --request GET \
    --header "Accept:application/json" \
    --user "username":"password"

Ergebnisse zurückgeben:

    {
      "result": { 
        "moduleHasShift" : true,
        "query" : "active=true^state=2^building=94e264cedb3650106c731dcd13961919^building.is_reservable=true^building.active=true^floorISEMPTY^ORfloor.is_reservable=true^floorISEMPTY^ORfloor.active=true^start<=2022-04-26 16:00:00^ORstartISEMPTY^end>=2022-04-28 16:00:00^ORendISEMPTY^start<=2022-04-28 16:00:00^ORstartISEMPTY^end>=2022-04-28 16:00:00^ORendISEMPTY"
      }
    }

## WSD-Suche -- POST /api/sn_wsd_rsv/search/availability_score {#ariaid-title7}

Gibt eine Verfügbarkeitspunktzahl für reservierbare Elemente für angegebene Zeitfenster zurück.

### URL-Format

URL mit Versionsnummer: /api/sn_wsd_rsv/{api_version}/search/availability_score

Standard-URL: /api/sn_wsd_rsv/search/availability_score

### Unterstützte Anforderungsparameter

{#wsd_search-POST-avail_score__entry__2}{#wsd_search-POST-avail_score__version-RESTAPI}

| Name | Beschreibung |
|-|-|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel <kbd class="ph userinput">v1</kbd> oder <kbd class="ph userinput">v2</kbd>. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
[Tabelle : 31. Pfadparameter]

{#wsd_search-POST-avail_score__entry__6}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 32. Abfrageparameter]

{#wsd_search-POST-avail_score__entry__10}

| Name | Beschreibung |
|-|-|
| recurringPattern | Erforderlich, wenn Parameter startEndDateTimes nicht angegeben ist. Wiederkehrendes Muster für die Suche nach reservierbaren Elementen, die für die angegebenen wiederkehrenden Ereignisse verfügbar sind. Datentyp: Objekt "recurringPattern": { "duration": Number, "label": "String", "options": {Object}, "repeats": "String", "startDate": "String" } |
| recurringPattern.duration | Erforderlich. Dauer, für die das reservierbare Element verfügbar sein muss. Datentyp: Zahl Einheit: Millisekunden |
| recurringPattern.label | Beschreibung des wiederkehrenden Musters, z. B. <kbd class="ph userinput">Tägliche Wiederholung, 5&nbsp;Mal</kbd>. Datentyp: Zeichenfolge |
| recurringPattern.options | Verfügbarkeitsoptionen für die zu suchende wiederkehrende Reservierung. Datentyp: Objekt "options": { "count": Number, "daysOfWeek": "String", "endDate": "String", "every": Number } |
| recurringPattern.options.count | Erforderlich, wenn endDate nicht übergeben wird. Wenn beide übergeben werden, wird count verwendet. Anzahl der Wiederholungen des Besprechungsmusters. Datentyp: Zahl |
| recurringPattern.options.daysOfWeek | Erforderlich, wenn der Parameter recurringPattern.repeats auf <kbd class="ph userinput">wöchentlich</kbd>festgelegt ist. Wochentage, an denen das reservierbare Element benötigt wird. Gültige Werte: * 1 = Montag * 2 = Dienstag * 3 = Mittwoch * 4 = Donnerstag * 5 = Freitag * 6 = Samstag * 7 = Sonntag Um beispielsweise Dienstag, Donnerstag und Freitag anzugeben, übergeben Sie 245 (kein Trennzeichen). Wenn repeat wöchentlich ist, count gleich 5 ist und daysOfWeek gleich 245 ist, dann ist in den zurückgegebenen Ergebnissen der Gesamtwert `count*daysOfWeek.length` (5\*3=15). Datentyp: Zeichenfolge |
| recurringPattern.options.endDate | Erforderlich, wenn recurringPattern.options.count nicht übergeben wird. Wenn beide übergeben werden, wird count verwendet. Enddatum und -uhrzeit der Wiederholung der Besprechung, z. B. „2022-07-08T14:00:00Z". Datentyp: Zeichenfolge Format: UTC jjjj-mm-tt hh:mm:ss |
| recurringPattern.options.each | Musterwiederholungsintervall. Wenn dieser Wert beispielsweise <kbd class="ph userinput">2</kbd>ist, wiederholen Sie das Muster alternativ basierend auf der Auswahl im Parameter repeats, z. B. jeden zweiten Tag oder jede zwei Woche. Datentyp: Zahl |
| recurringPattern.repeats | Erforderlich. Sich wiederholendes Muster für das reservierbare Element. Gültige Werte (Groß-/Kleinschreibung beachten): * täglich * monatlich * wöchentlich * jährlich Datentyp: Zeichenfolge |
| recurringPattern.startDate | Erforderlich. Startdatum und -uhrzeit für das wiederkehrende Muster, z. B. „2022-07-08T14:00:00Z". Datentyp: Zeichenfolge Format: UTC jjjj-mm-tt hh:mm:ss |
| reservableIds | Erforderlich. Liste der sys_ids der reservierbaren Elemente, die in die Verfügbarkeitspunktzahl einbezogen werden sollen. Zu finden in der Tabelle „Arbeitsplatzstandort" \[sn_wsd_core_workplace_location\]. Datentyp: Array |
| reservableType | Erforderlich. Typ des reservierbaren Elements, das in die Verfügbarkeitspunktzahl aufgenommen werden soll. Wird verwendet, um die Suche einzugrenzen. Gültige Werte (Groß-/Kleinschreibung beachten): * location * configuration_item Datentyp: Zeichenfolge |
| startEndDateTimes | Liste der Start- und Enddaten und -uhrzeiten in der Zeitzone des Anwenders, nach der gesucht werden soll. Datentyp: Array von Objekten "startEndDateTimes": [ { "end": "String", "start": "String" } ] Standard: Parameter recurringPattern muss angegeben werden. |
| startEndDateTimes.end | Enddatum und -uhrzeit des reservierbaren Elements. Datentyp: Zeichenfolge Format: jjjj-mm-tt hh:mm:ss |
| startEndDateTimes.start | Startdatum und -uhrzeit des reservierbaren Elements. Datentyp: Zeichenfolge Format: jjjj-mm-tt hh:mm:ss |
[Tabelle : 33. Anforderungstextparameter]

### Header

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter [Unterstützte REST API-Header](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.").
{#wsd_search-POST-avail_score__entry__42}{#wsd_search-POST-avail_score__accept-RESTAPI}{#wsd_search-POST-avail_score__content_type-JSON-only-entry-RESTAPI}

| Kopfzeile | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
[Tabelle : 34. Anforderungskopfzeilen]

{#wsd_search-POST-avail_score__entry__48}

| Kopfzeile | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 35. Antwortkopfzeilen]

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter [HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API.
{#wsd_search-POST-avail_score__entry__52}{#wsd_search-POST-avail_score__entry-200-status-code}{#wsd_search-POST-avail_score__entry-401-status-code}{#wsd_search-POST-avail_score__entry-404-status-code}{#wsd_search-POST-avail_score__entry-500-status-code}

| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
[Tabelle : 36. Statuscodes]

### Parameter des Antwort-Haupttexts

{#wsd_search-POST-avail_score__entry__62}

| Name | Beschreibung |
|-|-|
| Ergebnis | Geben Sie Ergebnisse für die angegebene Verfügbarkeitspunktzahl zurück. Datentyp: Objekt "result": { "reservable_sys_id": { "available": Number, "score": "String", "total": Number } } |
| Ergebnis.verfügbar | Anzahl der verfügbaren reservierbaren Elemente, die die angegebenen Suchkriterien erfüllen. Datentyp: Zahl |
| result.score | Verfügbarkeitspunktzahl. Anzahl der verfügbaren reservierbaren Elemente über die Gesamtanzahl der reservierbaren Elemente, die die angegebenen Suchkriterien erfüllt haben. Beispiel: Wenn available 2 und total 4 ist, ist der Wert score 2/4. Datentyp: Zeichenfolge |
| Ergebnis.gesamt | Gesamtzahl der reservierbaren Elemente, die die angegebenen Suchkriterien erfüllt haben. Datentyp: Zahl |
[ ]

### cURL-Anforderung

Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/search/availability_score" \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{
      \"reservableType\": \"location\",
      \"reservableIds\": [
        \"fe1f744edb7650106c731dcd139619ca\",
        \"5eafb44edb7650106c731dcd13961943\"
      ],
      \"recurringPattern\": {
        \"duration\": 3600000,
        \"repeats\": \"daily\",
        \"options\": {
          \"count\": 150,
          \"daysOfWeek\": \"\",
          \"every\": 1
        },
        \"label\": \"Repeats daily, 5 times\",
        \"startDate\": \"2022-04-26T14:00:00Z\"
      },
      \"startEndDateTimes\": [
        {
          \"start\": \"2022-07-05 14:00:00\",
          \"end\": \"2022-07-05 15:00:00\"
        },
        {
          \"start\": \"2022-07-06 14:00:00\",
          \"end\": \"2022-07-06 15:00:00\"
        }
      ]
    }" \
    --user "username":"password"

Ergebnisse zurückgeben:

    {
      "result": {
        "fe1f744edb7650106c731dcd139619ca": {
          "available": 2,
          "total": 2,
          "score": "2/2"
        },
        "5eafb44edb7650106c731dcd13961943": {
          "available": 2,
          "total": 2,
          "score": "2/2"
        }
      }


