WSD-Such-API
Die Workplace Service Delivery(WSD) Suchen Die API stellt Endpunkte zur Suche nach verfügbaren Standorten und Arbeitsplatzelementen bereit, z. B. reservierbare Elemente, reservierbare Module und verfügbare Schichten.
Um auf diese API zuzugreifen, muss der Anrufer über die Rolle sn_wsd_Core.Workplace_user verfügen, und die Plugins „Arbeitsplatzsicherheitsmanagement“ (sn_wsd_Core) und „Arbeitsplatzreservierungsmanagement“ (sn_wsd_rsv) müssen aktiviert sein.
Diese API wird in ausgeführt sn_wsd_rsv Namespace.
Für zusätzliche Informationen zu Workplace Reservation Management, Siehe Management Von Arbeitsplatzreservierungen .
WSD-Suche: RUFT /api/sn_wsd_rsv/search/Availability AB
Überprüft, ob die angegebenen reservierbaren Elemente für die angegebenen Zeiten verfügbar sind.
URL-Format
Versionierte URL: /api/sn_wsd_rsv/{api_Version}/search/Availability
Standard-URL: /api/sn_wsd_rsv/search/Availability
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Ende | Erforderlich. Endzeit, die für die Suche nach verfügbaren reservierbaren Modulen verwendet werden soll. Dieser Wert muss nach dem in angegebenen Wert liegen startParameter. Datentyp: Zeichenfolge Format: UTC oder Ortszeit (jjjj-mm-tt hh:mm:ss) |
| Include_Reservierungen_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:
Datentyp: Boolesch Standardwert: false |
| Reservierbare_IDs | Erforderlich. Kommagetrennte Liste reservierbarer sys_IDs, die auf die Verfügbarkeit ausgewertet werden sollen. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzstandort [sn_wsd_Core_Workplace_location] |
| Reservation_IDs | Kommagetrennte Liste der vorhandenen Reservierungs-sys_IDs. Übergeben Sie diesen Parameter, wenn Sie die zugehörigen Reservierungen bearbeiten möchten. Die Sperrzeit für diese sys_IDs für die entsprechenden reservierbaren Elemente wird als verfügbar behandelt. Datentyp: Zeichenfolge Standard: Keine Tabelle: Arbeitsplatzreservierung [sn_wsd_rsv_reservation] |
| Reservierbares_Modul | Erforderlich. SYS_ID des reservierbaren Moduls, das in die Suche aufgenommen werden soll. A Reservierbares Modul Gruppiert ähnliche Arten von Arbeitsplatzelementen. Datentyp: Zeichenfolge Tabelle: Reservierbares Modul [sn_wsd_rsv_reservable_Module] |
| Schedule_View_obj | Details zur zurückzugebenden Zeitplanansicht. Übergeben Sie dieses Objekt, wenn Sie 24-Stunden-Verfügbarkeitsdaten für Reservierungen benötigen, die mehr als einen Tag umfassen. Die Rückgabeergebnisse enthalten nur verfügbare Zeiten und Reservierungen für das angegebene Datum. Damit diese Funktionalität ordnungsgemäß funktioniert, die Parameter ignore_same_day_validationUnd include_reservations_within_daysMuss auf festgelegt werden Wahr . Datentyp: Objekt |
| Schedule_View_obj.schedule_View_date | Datum, für das mit der Rückgabe der Reservierungsverfügbarkeit begonnen werden soll. Dieses Datum muss sich in der in angegebenen Zeitzone befinden schedule_view_obj.timezoneParameter. Datentyp: Zeichenfolge Format: JJJJ-MM-TT |
| Schedule_View_obj.timezone | Zeitzone wird erstellt, die zur Bestimmung der zurückzugebenden Reservierungsverfügbarkeitsdaten verwendet werden soll. 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. Wenn dieser Parameter übergeben wird, wird endParameter ist nicht erforderlich. Weitere Informationen zu schichtbasierten Reservierungen finden Sie unter Aktivieren Sie die schichtbasierte Reservierung . Datentyp: Zeichenfolge Tabelle: Schicht [sn_wsd_Core_Shift] |
| Start | Erforderlich. Startzeit, die für die Suche nach verfügbaren reservierbaren Modulen verwendet werden soll. Dieser Wert muss vor dem in angegebenen Wert liegen endParameter. Datentyp: Zeichenfolge Format: UTC oder Ortszeit (jjjj-mm-tt hh:mm:ss) |
| Name | Beschreibung |
|---|---|
| Keine |
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 .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Anforderungstexts. Unterstützte Typen: application/json, application/xmlOder, text/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
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 REST API-HTTP-Antwortcodes .
| 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. |
Parameter des Antwort-Haupttexts
| Name | Beschreibung |
|---|---|
| Ergebnis | Liste aller verfügbaren wiederverwendbaren Elemente für die angegebenen Zeiten. Datentyp: Array von Objekten |
| Ergebnis.VerfügbarZeiten | Liste der Daten/Uhrzeiten, zu denen das zugehörige reservierbare Element verfügbar ist. Datentyp: Array |
| Ergebnis.Gebäude | Details zum Gebäude, das dem reservierbaren Element zugeordnet ist. Datentyp: Objekt |
| Ergebnis.Gebäude.Anzeigewert | Anzeigewert für das Gebäude. Datentyp: Zeichenfolge |
| result.building.name | Name des Gebäudes Datentyp: Zeichenfolge |
| Ergebnis.Gebäude.sys_ID | SYS_ID des zugehörigen Gebäudedatensatzes. Datentyp: Zeichenfolge |
| result.campus | Details zum Campus, der dem reservierbaren Element zugeordnet ist. Datentyp: Objekt |
| result.campus.display_value | Anzeigenummer des Campus, auf dem sich das reservierbare Element befindet, z. B. East Bay. Datentyp: Zeichenfolge |
| result.campus.name | Name des Campus. Datentyp: Zeichenfolge |
| result.campus.sys_id | SYS_ID des zugeordneten Datensatzes. Datentyp: Zeichenfolge Tabelle: Campus [sn_wsd_Core_Campus] |
| Ergebnis.E-Mail | E-Mail-Adresse für das zugehörige reservierbare Element. Datentyp: Zeichenfolge |
| Ergebnis.Stockwerk | Details zum Stockwerk, das dem reservierbaren Element zugeordnet ist. Datentyp: Objekt |
| Ergebnis.Stockwerk.Display_value | 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. Datentyp: Zeichenfolge Tabelle: Stockwerk [sn_wsd_Core_floor] |
| Ergebnis.is_available | Kennzeichnung, die angibt, ob das reservierbare Element für die Reservierung verfügbar ist. Gültige Werte:
Datentyp: Boolesch |
| result.name | Name des reservierbaren Elements. Datentyp: Zeichenfolge |
| Ergebnis.Reservierungen | Details zur zugehörigen Reservierung. Datentyp: Array von Objekten |
| Ergebnis.Reservierungen.Configuration_item | Konfigurationselemente, die der Reservierung entsprechen. Datentyp: Zeichenfolge Tabelle: Konfigurationselement [cmdb_ci] |
| Ergebnis.Reservierungen.Ende | Enddatum und -Uhrzeit der Reservierung. Datentyp: Zeichenfolge Format: UTC: jjjj-mm-ddThh:mm:ssZ, z. B. 2021-02-05T18:00:00Z |
| Ergebnis.Reservierungen.is_Collided | Kennzeichnung, die angibt, ob die Reservierung mit der Start- und Endzeit der Suche kollidiert. Dies gibt an, dass der zugeordnete reservierbare Standort bereits für den angegebenen Suchzeitraum reserviert ist. Mögliche Werte:
Datentyp: Boolesch |
| Ergebnis.Reservierungen.Standort | Details zum Standort der Reservierung. Datentyp: Objekt |
| Ergebnis.Reservierungen.Standort.Standort | SYS_ID des zugehörigen Standortdatensatzes. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzstandort [sn_wsd_Core_Workplace_location] |
| Ergebnis.Reservierungen.Standort.Zeitzone | Details zur Zeitzone, die dem Standort zugeordnet ist. Datentyp: Objekt |
| Ergebnis.Reservierungen.Standort.Zeitzone.Anzeigewert | Anzeigewert für die Zeitzone, zu der dieser Standort gehört. Datentyp: Zeichenfolge |
| Ergebnis.Reservierungen.Standort.Zeitzone.Wert | Interner Wert für die Zeitzone, zu der dieser Standort gehört. Datentyp: Zeichenfolge |
| Ergebnis.Reservierungen.Nummer | Reservierungsnummer. Datentyp: Zeichenfolge |
| Ergebnis.Reservierungen.angefordert_für | Details zur Person, für die die Reservierung angefordert wurde. Datentyp: Objekt |
| result.reservations.requested_for.name | Name des Anwenders, für den die Reservierung angefordert wurde. Datentyp: Zeichenfolge |
| Ergebnis.Reservierungen.angefordert_für.sys_ID | SYS_ID des Anwenders, für den die Reservierung angefordert wird. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
| Ergebnis.Reservierungen.reservation_purpose | Details zum Zweck der Reservierung. Datentyp: Objekt |
| Ergebnis.Reservierungen.reservation_purpose.Display_value | Anzeigewert für den Zweck der Reservierung, z. B. Unternehmensbesprechung. Datentyp: Zeichenfolge |
| Ergebnis.Reservierungen.reservation_purpose.value | 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-ddThh:mm:ssZ, z. B. 2021-02-05T18:00:00Z |
| Ergebnis.Reservierungen.Status | Details zum Status der Reservierung für den Standort. Datentyp: Objekt |
| Ergebnis.Reservierungen.Status.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 |
| Ergebnis.Reservierungen.sys_ID | Erforderlich. SYS_ID des Reservierungsdatensatzes. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzreservierung [sn_wsd_rsv_reservation] |
cURL-Anforderung
Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird. Hinweis: Zeilenumbrüche wurden den Abfrageparametern 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
Sucht basierend auf den angegebenen Suchkriterien nach der besten Übereinstimmung mit reservierbaren Elementen.
URL-Format
Versionierte URL: /api/sn_wsd_rsv/{api_Version}/search/BEST_match
Standard-URL: /api/sn_wsd_rsv/search/BEST_match
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| BEST_match_count | Anzahl der am besten übereinstimmenden Reservierungsteile, die zurückgegeben werden sollen. Datentyp: Zahl Standard: 1 |
| Ende | Erforderlich. Endzeit, die für die Suche nach verfügbaren reservierbaren Modulen verwendet werden soll. Dieser Wert muss nach dem in angegebenen Wert liegen startParameter. Datentyp: Zeichenfolge Format: UTC oder Ortszeit (jjjj-mm-tt hh:mm:ss) |
| Include_reservable_purposes | Kennzeichnung, die angibt, ob der Zweck der Reservierung des Arbeitsplatzstandorts für jedes reservierbare Element in den Rückgabeergebnissen zurückgegeben werden soll. Gültige Werte:
Datentyp: Boolesch Standardwert: false Tabelle: Reservierbarer Zweck [sn_wsd_rsv_reservable_purpose] |
| Include_Reservierungen_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:
Datentyp: Boolesch Standardwert: false |
| Include_Standard_-Services | Kennzeichnung, die angibt, ob die Standardserviceinformationen in der Antwort zurückgegeben werden sollen. Diese Informationen befinden sich in der Tabelle „Standardservice“ [sn_wsd_rsv_Standard_Service]. Ein Standardservice beschreibt grundlegende Vorkehrungen, die bei der Reservierung mit einem reservierbaren Arbeitsplatzelement verfügbar sind, z. B. Whiteboards, zusätzliche Monitore und ähnliche Services. Weitere Informationen zu Standardservices finden Sie unter Standardservices . Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| q | Erforderlich. Codierte Abfrage, die zum Filtern der Suchergebnisse verwendet werden soll. In dieser Abfrage müssen Sie die sys_ID des Gebäudes angeben, und Sie können Parameter wie Stockwerk, Fläche, Kapazität, Standardservices und reservierbare Zwecke angeben. Alle übergebenen Parameter müssen sys_IDs sein, mit Ausnahme der Kapazität, die eine Zahl ist. Beispiel: Sie können diese Informationen in den folgenden Tabellen finden:
Datentyp: Zeichenfolge |
| Reservierbares_Modul | Erforderlich. SYS_ID des reservierbaren Moduls, das in die Suche aufgenommen werden soll. A Reservierbares Modul Gruppiert ähnliche Arten von Arbeitsplatzelementen. Datentyp: Zeichenfolge Tabelle: Reservierbares Modul [sn_wsd_rsv_reservable_Module] |
| Start | Erforderlich. Startzeit, die für die Suche nach verfügbaren reservierbaren Modulen verwendet werden soll. Dieser Wert muss vor dem in angegebenen Wert liegen endParameter. Datentyp: Zeichenfolge Format: UTC oder Ortszeit (jjjj-mm-tt hh:mm:ss) |
| Time_Slot | SYS_ID eines Zeitfenster-Datensatzes, für den wir nach dem am besten passenden reservierbaren Element suchen. Datentyp: Zeichenfolge Standard: Keine Tabelle: Zeitfenster [sn_wsd_rsv_time_Slot] |
| Feld | Bevorzugte Zeitzone, z. B. Europa/Amsterdam. Datentyp: Zeichenfolge Standard: Keine |
| Header | Beschreibung |
|---|---|
| Keine |
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 .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
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 REST API-HTTP-Antwortcodes .
| 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. |
Parameter des Antwort-Haupttexts
| Name | Beschreibung |
|---|---|
| Ergebnis | Ergebnisse für die beste reservierbare Übereinstimmung zurückgeben. Datentyp: Objekt |
| Ergebnis.StockwerkAusgewählteGebäude | Details zu den Stockwerken, auf denen sich das reservierbare Element befindet. Datentyp: Array von Objekten |
| Ergebnis.StockwerkAusgewählteGebäude.Display_value | Anzeigenummer des Stockwerks, in dem sich das reservierbare Element befindet, z. B. 12. Datentyp: Zeichenfolge |
| Ergebnis.StockwerkAusgewählteGebäude.external_ID | Externer Bezeichner für das Stockwerk. Datentyp: Zeichenfolge |
| result.floorsOfSelectedBuilding.name | Name des Stockwerks, in dem sich das reservierbare Element befindet. Datentyp: Zeichenfolge |
| Ergebnis.StockwerkAusgewählteGebäude.sys_ID | SYS_ID des zugeordneten Datensatzes. Datentyp: Zeichenfolge Tabelle: Stockwerk [sn_wsd_Core_floor] |
| Ergebnis.hasWeitere | Kennzeichnung, die angibt, ob in den Rückgabeergebnissen weitere Reservierungsmöglichkeiten vorhanden sind. Mögliche Werte:
Datentyp: Boolesch |
| Ergebnis.nextItemIndex | Index für den nächsten abzurufenden reservierbaren Datensatz. Verwenden Sie diesen Wert, wenn Sie durch reservierbare Datensätze paginieren. Datentyp: Zahl |
| Ergebnis.ReservierbarContainer | Wird nur für reservierbare Module zurückgegeben, deren Feld „selection_type“ auf festgelegt ist Container . Ein Container ist eine Gruppierung ähnlicher Elemente, z. B. einer Gruppe von Schreibtischen. Datentyp: Array von Objekten |
| Ergebnis.ReservierbarContainer.Gebäude | Details zum Gebäude, das dem reservierbaren Container zugeordnet ist. Datentyp: Objekt |
| Ergebnis.ReservierbarContainer.Gebäude.Display_value | Anzeigewert für das Gebäude. Datentyp: Zeichenfolge |
| result.reservableContainers.building.name | Name des Gebäudes Datentyp: Zeichenfolge |
| Ergebnis.ReservierbarContainer.Gebäude.sys_ID | SYS_ID des zugehörigen Gebäudedatensatzes. Datentyp: Zeichenfolge |
| result.reservableContainers.campus | Details zum Campus, auf dem sich das reservierbare Element befindet.
Datentyp: Objekt
Tabelle: Campus [sn_wsd_Core_Campus] |
| result.reservableContainers.campus.Display_value | Anzeigenummer des Campus, auf dem sich das reservierbare Element befindet, z. B. East Bay. Datentyp: Zeichenfolge |
| result.reservableContainers.campus.name | Name des Campus. Datentyp: Zeichenfolge |
| result.reservableContainers.campus.sys_id | SYS_ID des zugeordneten Datensatzes. Datentyp: Zeichenfolge Tabelle: Campus [sn_wsd_Core_Campus] |
| result.reservableContainers.capacity | Maximale Anzahl von Personen für das reservierbare Element. Datentyp: Zahl |
| Ergebnis.ReservierbarContainer.Display_value | Anzeigewert für den reservierbaren Container. Datentyp: Zeichenfolge |
| Ergebnis.ReservierbarContainer.Stockwerk | Details zum Stockwerk, das dem reservierbaren Container zugeordnet ist. Datentyp: Objekt |
| Ergebnis.ReservierbarContainer.Stockwerk.Display_value | 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.ReservierbarContainer.Stockwerk.sys_ID | SYS_ID des zugeordneten Datensatzes. Datentyp: Zeichenfolge Tabelle: Stockwerk [sn_wsd_Core_floor] |
| Ergebnis.ReservierbarContainer.Image | Details zu einem Bild, das das Layout für das zugehörige reservierbare Element darstellt. Datentyp: Objekt Tabelle: Images [DB_image] |
| result.reservableContainers.image.link | Link zu einem Bild, das das Layout für dieses reservierbare Element darstellt. Datentyp: Zeichenfolge Tabelle: Images [DB_image] |
| Ergebnis.ReservierbarContainer.Image.sys_ID | SYS_ID des zugeordneten Bilddatensatzes. Datentyp: Zeichenfolge |
| Ergebnis.ReservierbarContainer.sys_ID | SYS_ID des zugeordneten Containerdatensatzes. Datentyp: Zeichenfolge Tabelle: Die Tabelle, in der sich dieser befindet, kann für jeden Containertyp konfiguriert werden. Standardmäßig befindet sie sich in der Tabelle „Bereich“ [sn_wsd_Core_area]. |
| Ergebnis.ReservierbarEinheiten | Details zu den reservierbaren Einheiten, die den angegebenen Suchkriterien entsprechen. Eine reservierbare Einheit ist ein einzelnes reservierbares Element, z. B. ein Schreibtisch oder ein Stuhl. Datentyp: Array von Objekten |
| Ergebnis.ReservierbarEinheiten.Fläche | Details zum Bereich, in dem sich das reservierbare Modul befindet. Datentyp: Objekt Tabelle: Bereich [sn_wsd_Core_area] |
| Ergebnis.reservierbarEinheiten.Bereich.Anzeige_Wert | Anzeigewert für den reservierbaren Modulbereich. Datentyp: Zeichenfolge |
| Ergebnis.reservierbarEinheiten.Bereich.sys_ID | SYS_ID des Bereichsdatensatzes, der dem reservierbaren Element zugeordnet ist. Datentyp: Zeichenfolge |
| Ergebnis.ReservierbarEinheiten.VerfügbarZeiten | Liste der Daten/Uhrzeiten, zu denen das zugehörige reservierbare Element verfügbar ist. Datentyp: Array |
| Ergebnis.ReservierbarEinheiten.Gebäude | Details zum Gebäude, in dem sich das reservierbare Element befindet. Datentyp: Objekt Tabelle: Gebäude [sn_wsd_Core_Building] |
| Ergebnis.ReservierbarEinheiten.Gebäude.Anzeige_Wert | Anzeigewert für das Gebäude. Datentyp: Zeichenfolge |
| Ergebnis.reservierbarEinheiten.Gebäude.sys_ID | SYS_ID des zugehörigen Gebäudedatensatzes. Datentyp: Zeichenfolge |
| result.reservableUnits.campus | Details zum Campus, auf dem sich das reservierbare Element befindet.
Datentyp: Objekt
Tabelle: Campus [sn_wsd_Core_Campus] |
| result.reservableUnits.campus.display_value | Anzeigenummer des Campus, auf dem sich das reservierbare Element befindet, z. B. East Bay. Datentyp: Zeichenfolge |
| result.reservableUnits.campus.sys_id | SYS_ID des zugeordneten Datensatzes. Datentyp: Zeichenfolge Tabelle: Campus [sn_wsd_Core_Campus] |
| result.reservableUnits.capacity | 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 Standort und Auswirkung . Mögliche Werte:
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 |
| Ergebnis.reservierbarEinheiten.external_ID | Externe ID des reservierbaren Elements, das zum Synchronisieren eines in CMS zugeordneten Bereichs verwendet wird. Dieser Wert wird nur ausgefüllt, wenn diesem Standort eine Karte zugeordnet ist. Datentyp: Zeichenfolge |
| Ergebnis.ReservierbarEinheiten.Stockwerk | Details zum Stockwerk, auf dem sich das reservierbare Element befindet.
Datentyp: Objekt
Tabelle: Stockwerk [sn_wsd_Core_floor] |
| Ergebnis.ReservierbarEinheiten.Stockwerk.Display_value | Anzeigenummer des Stockwerks, in dem sich das reservierbare Element befindet, z. B. 12. Datentyp: Zeichenfolge |
| Ergebnis.reservierbarEinheiten.Stockwerk.sys_ID | SYS_ID des zugeordneten Datensatzes. Datentyp: Zeichenfolge Tabelle: Stockwerk [sn_wsd_Core_floor] |
| Ergebnis.ReservierbarEinheiten.Bild | Details zu einem Bild, das das Layout für das zugehörige reservierbare Element darstellt. Datentyp: Objekt Tabelle: Images [DB_image] |
| result.reservableUnits.image.link | Link zu einem Bild, das das Layout für dieses reservierbare Element darstellt. Datentyp: Zeichenfolge Tabelle: Images [DB_image] |
| Ergebnis.reservierbarEinheiten.Image.sys_ID | SYS_ID des zugeordneten Bilddatensatzes. Datentyp: Zeichenfolge |
| result.reservableUnits.includedInResult | Kennzeichnung, die angibt, ob das aktuelle reservierbare Element in den Rückgabeergebnissen enthalten ist. Gültige Werte:
Datentyp: Boolesch |
| Ergebnis.reservierbarEinheiten.ist_verfügbar | Kennzeichnung, die angibt, ob das reservierbare Element für die Reservierung verfügbar ist. Gültige Werte:
Datentyp: Boolesch |
| Ergebnis.reservierbarEinheiten.ist_Favorit | Kennzeichnung, die angibt, ob das reservierbare Element als einer der Favoriten des zugehörigen Anwenders gekennzeichnet ist. Gültige Werte:
Datentyp: Boolesch |
| Ergebnis.reservierbarEinheiten.ist_reservierbar | Kennzeichnung, die angibt, ob dieses reservierbare Element reserviert werden kann. Hinweis: Wenn include_unavailable_itemsAbfrageparameter ist auf „wahr“ festgelegt, nicht verfügbare Standorte werden ebenfalls zurückgegeben. Wenn in diesem Fall bereits ein Standort reserviert ist, wird der verwendet is_availableParameter ist „falsch“, aber is_reservableIst „wahr“. Gültige Werte:
Datentyp: Boolesch |
| Ergebnis.reservierbarEinheiten.ist_reserviert | Kennzeichnung, die angibt, ob das reservierbare Element bereits reserviert ist. Gültige Werte:
Datentyp: Boolesch |
| Ergebnis.reservierbarEinheiten.ist_ausgewählt | Kennzeichnung, die angibt, ob das reservierbare Element bereits reserviert ist. Gültige Werte:
Datentyp: Boolesch |
| Ergebnis.reservierbarEinheiten.Standort_Typ | Details zum Typ des Standorts des reservierbaren Elements, z. B. Arbeitsplatz/Schreibtisch, Café oder Fitnessstudio. Datentyp: Objekt Tabelle: Arbeitsplatzstandort [sn_wsd_Core_Workplace_location] |
| Ergebnis.reservableEinheiten.Location_type.Display_value | Anzeigewert des Standorttyps. Datentyp: Zeichenfolge |
| result.reservableUnits.location_type.name | Name des Standorttyps, z. B. Keller oder Speicher. Identisch mit Anzeigewert. Datentyp: Zeichenfolge |
| Ergebnis.reservierbarEinheiten.Location_type.sys_ID | SYS_ID des zugeordneten Datensatzes. Datentyp: Zeichenfolge Tabelle: Bereichstyp [sn_wsd_Core_space_type] |
| result.reservableUnits.name | Name des reservierbaren Elements. Datentyp: Zeichenfolge |
| Ergebnis.ReservierbarEinheiten.Nummer | Eindeutiger Bezeichner des reservierbaren Elements. Dieser Wert ist visuell lesbarer als die sys_ID. Datentyp: Zeichenfolge |
| Ergebnis.ReservierbarEinheiten.Reihenfolge | Auftragsnummer für das reservierbare Element. Datentyp: Zahl |
| Ergebnis.reservableEinheiten.need_Approval | Kennzeichnung, die angibt, ob die Reservierung des reservierbaren Elements eine Genehmigung erfordert. Mögliche Werte:
Datentyp: Boolesch |
| Ergebnis.reservierbarEinheiten.erfordert_Check_in | Kennzeichnung, die angibt, ob der Anwender für das reservierbare Element einchecken muss. Gültige Werte:
Datentyp: Boolesch |
| Ergebnis.reservierbarEinheiten.reservierbare_Zwecke | Details zum Zweck der Reservierung des zugehörigen reservierbaren Elements. Datentyp: Array von Objekten |
| Ergebnis.reservierbare Einheiten.reservierbare_Zwecke.Name | Name des reservierbaren Elements. Datentyp: Zeichenfolge |
| Ergebnis.reservierbare Einheiten.reservierbare_Zwecke.Short_description | Kurze Beschreibung des reservierbaren Elements. Datentyp: Zeichenfolge |
| Ergebnis.reservierbare Einheiten.reservierbare_Zwecke.sys_ID | SYS_ID des Datensatzes für reservierbare Zwecke. Datentyp: Zeichenfolge Tabelle: Reservierbarer Zweck [sn_wsd_rsv_reservable_purpose] |
| Ergebnis.ReservierbarEinheiten.Reservierungen | Details zu den Reservierungen, die dem reservierbaren Element zugeordnet sind. Wird nur ausgefüllt, wenn include_reservations_within_daysAbfrageparameter ist „wahr“ und reservation_idsParameter enthält Reservierungs-IDs, d. h. für dieses reservierbare Element sind bereits Reservierungen vorhanden. Datentyp: Array von Objekten |
| Ergebnis.reservierbarEinheiten.Reservierungen.Configuration_item | Konfigurationselemente, die der Reservierung entsprechen. Datentyp: Zeichenfolge Tabelle: Konfigurationselement [cmdb_ci] |
| Ergebnis.ReservierbarEinheiten.Reservierungen.Ende | Enddatum und -Uhrzeit der Reservierung. Datentyp: Zeichenfolge Format: UTC: jjjj-mm-ddThh:mm:ssZ, z. B. 2021-02-05T18:00:00Z |
| Ergebnis.reservierbarEinheiten.Reservierungen.is_Collided | Kennzeichnung, die angibt, ob die Reservierung mit der Start- und Endzeit der Suche kollidiert. Dies gibt an, dass der zugeordnete reservierbare Standort bereits für den angegebenen Suchzeitraum reserviert ist. Mögliche Werte:
Datentyp: Boolesch |
| Ergebnis.ReservierbarEinheiten.Reservierungen.Standort | Details zum Standort der Reservierung. Datentyp: Objekt |
| Ergebnis.ReservierbarEinheiten.Reservierungen.Standort.Standort | SYS_ID des zugehörigen Standortdatensatzes. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzstandort [sn_wsd_Core_Workplace_location] |
| Ergebnis.ReservierbarEinheiten.Reservierungen.Standort.Zeitzone | Details zur Zeitzone, die dem Standort zugeordnet ist. Datentyp: Objekt |
| Ergebnis.ReservierbarEinheiten.Reservierungen.Standort.Zeitzone.Anzeigewert | Anzeigewert für die Zeitzone, zu der dieser Standort gehört. Datentyp: Zeichenfolge |
| Ergebnis.ReservierbarEinheiten.Reservierungen.Standort.Zeitzone.Wert | Interner Wert für die Zeitzone, zu der dieser Standort gehört. Datentyp: Zeichenfolge |
| Ergebnis.ReservierbarEinheiten.Reservierungen.Nummer | Eindeutiger Bezeichner des reservierbaren Elements. Dieser Wert ist visuell lesbarer als die sys_ID. Datentyp: Zeichenfolge |
| Ergebnis.reservierbarEinheiten.Reservierungen.Angefordert_für | Details zur Person, für die die Reservierung angefordert wurde. Datentyp: Objekt |
| Ergebnis.ReservierbarEinheiten.Reservierungen.requested_for.name | Name des Anwenders, für den die Reservierung angefordert wurde. Datentyp: Zeichenfolge |
| Ergebnis.reservierbarEinheiten.Reservierungen.Angefordert_für.sys_ID | SYS_ID des Anwenders, für den die Reservierung angefordert wird. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
| Ergebnis.reservierbarEinheiten.Reservierungen.Reservation_purpose | Details zum Zweck der Reservierung. Datentyp: Objekt |
| Ergebnis.reservierbarEinheiten.Reservierungen.Reservation_purpose.Display_value | Anzeigewert für den Zweck der Reservierung, z. B. Unternehmensbesprechung. Datentyp: Zeichenfolge |
| Ergebnis.reservierbarEinheiten.Reservierungen.Reservation_purpose.value | Interner Wert für den Zweck der Reservierung, z. B. Company_Meeting. Datentyp: Zeichenfolge |
| Ergebnis.ReservierbarEinheiten.Reservierungen.Start | Startdatum und -Uhrzeit der Reservierung. Datentyp: Zeichenfolge Format: UTC – jjjj-mm-ddThh:mm:ssZ, z. B. 2021-02-05T18:00:00Z |
| Ergebnis.ReservierbarEinheiten.Reservierungen.Status | Details zum Status der Reservierung für den Standort. Datentyp: Objekt |
| Ergebnis.reservierbarEinheiten.Reservierungen.Status.Display_value | Anzeigewert für den aktuellen Status der Reservierung, z. B. bestätigt. Datentyp: Zeichenfolge |
| Ergebnis.ReservierbarEinheiten.Reservierungen.Status.Wert | Interner Wert für den aktuellen Status der Reservierung, z. B. 2. Datentyp: Zeichenfolge |
| Ergebnis.ReservierbarEinheiten.Reservierungen.Betreff | Betreff der Reservierung. Datentyp: Zeichenfolge |
| Ergebnis.reservierbarEinheiten.Reservierungen.sys_ID | Erforderlich. SYS_ID des Reservierungsdatensatzes. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzreservierung [sn_wsd_rsv_reservation] |
| Ergebnis.reservierbare Einheiten.reservierbare Menge | Maximale Anzahl, mit der das zugeordnete reservierbare Element gleichzeitig reserviert werden kann. Dieser Wert wird verwendet, wenn einem Bereich Arbeitsbereiche zugewiesen werden. Datentyp: Ganzzahl |
| Ergebnis.ReservierbarEinheiten.ShowPrivacyOption | Kennzeichnung, die angibt, ob ein Mitarbeiter die Datenschutzeinstellungen für das zugehörige reservierbare Element überschreiben kann. Weitere Informationen zu diesen Datenschutzeinstellungen finden Sie unter Datenschutzeinstellungen für Standort und Auswirkung . Gültige Werte:
Datentyp: Boolesch |
| result.reservableUnits.site | Details zum Standort, auf dem sich das reservierbare Element befindet. Datentyp: Objekt Tabelle: Site [sn_wsd_Core_Site] |
| Ergebnis.reservierbarEinheiten.Site.Display_value | Anzeigewert der Site. Datentyp: Zeichenfolge |
| Ergebnis.reservierbarEinheiten.Site.sys_ID | SYS_ID des zugehörigen Site-Datensatzes. Datentyp: Zeichenfolge Tabelle: Site [sn_wsd_Core_Site] |
| Ergebnis.reservierbarEinheiten.Standard_Services | Zugehörige Standardservices, z. B. Flipchart, Projektorbildschirm, Whiteboard und Markierungen. Datentyp: Array von Objekten
|
| Ergebnis.reservableEinheiten.Standard_Services.Font_Awesome_icon | Name des Miniaturansichtssymbols, das dem Standardservice zugeordnet ist. Datentyp: Zeichenfolge |
| result.reservableUnits.standard_services.name | Name des Miniaturansichtssymbols, das dem Standardservice zugeordnet ist. Datentyp: Zeichenfolge |
| Ergebnis.reservableEinheiten.Standard_Services.Short_description | Kurze Beschreibung des Standardservice. Datentyp: Zeichenfolge |
| Ergebnis.reservierbarEinheiten.Standard_Services.sys_ID | SYS_ID des Standardservicedatensatzes. Datentyp: Zeichenfolge Tabelle: Standardservice [sn_wsd_rsv_Standard_Service] |
| Ergebnis.reservierbare Einheiten.sys_ID | SYS_ID des reservierbaren Datensatzes. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzstandort [sn_wsd_Core_Workplace_location] |
| Ergebnis.ReservierbarEinheiten.tableName | Name der Tabelle, in der sich der reservierbare Datensatz befindet. Datentyp: Zeichenfolge |
| Ergebnis.ReservierbarEinheiten.Titel | 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
Bestimmt, ob eine überlappende Reservierung basierend auf den übergebenen Parametern vorhanden ist.
URL-Format
Versionierte URL: /api/sn_wsd_rsv/{api_Version}/search/overlapping_reservation
Standard-URL: /api/sn_wsd_rsv/search/overlapping_reservation
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Ende | Erforderlich. Endzeit, die zum Überprüfen auf überlappende Reservierungen verwendet werden soll. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TTTHH:MM:SSZ |
| Recurring_pattern | Details zum wiederkehrenden Muster für die Reservierung. Datentyp: Objekt |
| Recurring_pattern.duration | Dauer der Überprüfung. Datentyp: Zahl Einheit: Sekunden |
| Recurring_pattern.options | Details zu den Optionen, die der wiederkehrenden Reservierung zugeordnet sind. Datentyp: Objekt |
| Recurring_pattern.options.count | Anzahl der Wiederholungen des Musters. Datentyp: Zahl |
| Recurring_pattern.options.daysOfWeek | Wochentage, an denen auf Überschneidungen überprüft werden soll. Gültige Werte:
Um beispielsweise Dienstag, Donnerstag und Freitag anzugeben, übergeben Sie 245 (kein Trennzeichen). Datentyp: Zeichenfolge |
| Recurring_pattern.options.every | Zu überprüfendes Musterwiederholungsintervall. Beispiel: Wenn dieser Wert ist 2 , Überprüft das Wiederholungsmuster basierend auf der Auswahl in repeatsParameter, z. B. „jeder zweite Tag“ oder „jede zweite Woche“. Datentyp: Zahl |
| Recurring_pattern.options.repeats | Wiederholtes Muster für die Überprüfung der Reservierungsüberschneidung. Mögliche Werte: (Groß-/Kleinschreibung beachten)
Datentyp: Zeichenfolge |
| Reservierbare_ID | SYS_ID des reservierbaren Moduls, um auf überlappende Reservierungen zu prüfen. Datentyp: Zeichenfolge Tabelle: Reservierbares Modul [sn_wsd_rsv_reservable_Module] |
| Reservierungs-ID | SYS_ID der Reservierung, die auf Überschneidungen überprüft werden soll. Dieser Wert wird im Bearbeitungs-Flow von übergeordneten Elementen mit mehreren oder Gruppen benötigt. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzreservierung [sn_wsd_rsv_reservation] |
| Shift_info_object | Details der Schicht, die auf Überschneidungen überprüft werden soll. Weitere Informationen zu schichtbasierten Reservierungen finden Sie unter Aktivieren Sie die schichtbasierte Reservierung . Datentyp: Objekt |
| Shift_info_object.applyUmschalt | Kennzeichnung, die angibt, ob schichtbasierte Reservierungen für das reservierbare Modul aktiviert sind. Gültige Werte:
Datentyp: Boolesch |
| Shift_info_object.Shift | SYS_ID der Schicht, die der Reservierung zugeordnet werden soll. Wenn dieser Parameter übergeben wird, wird endParameter ist nicht erforderlich. Datentyp: Zeichenfolge Tabelle:Schicht [sn_wsd_Core_Shift] |
| Shift_info_object.timezone | Zeitzone der Schicht, um auf Überschneidungen zu überprüfen. Datentyp: Zeichenfolge |
| Start | Erforderlich. Startzeit, die zum Überprüfen auf überlappende Reservierungen verwendet werden soll. Datentyp: Zeichenfolge FORMAT: JJJ-MM-TTTHH:MM:SSZ |
| user_id | Erforderlich. SYS_ID des Anwenders, der auf überlappende Reservierungen überprüft werden soll. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
| Name | Beschreibung |
|---|---|
| Keine |
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 .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
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 REST API-HTTP-Antwortcodes .
| 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. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnisse | Details der Ergebnisse der Überlappungsprüfung. Datentyp: Objekt |
| Ergebnisse.isVeraltet | Kennzeichnung, die angibt, ob eine überlappende Reservierung vorhanden ist. Gültige Werte:
Datentyp: Boolesch |
| Ergebnisse.reservableId | 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 Sie nach einer Reservierungsüberschneidung für einen bestimmten Anwender und für einen bestimmten, vom angegebenen Zeitraum suchen startUnd endParameter.
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: RUFT /api/sn_wsd_rsv/search/reservierbar AB
Sucht mithilfe einer angegebenen reservierbaren Modellkonfiguration nach verfügbaren reservierbaren Elementen.
URL-Format
Versionierte URL: /api/sn_wsd_rsv/{api_Version}/search/reservierbar
Standard-URL: /api/sn_wsd_rsv/search/reservierbar
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Ende | Erforderlich. Endzeit, die für die Suche nach verfügbaren reservierbaren Modulen verwendet werden soll. Dieser Wert muss nach dem in angegebenen Wert liegen startParameter. Datentyp: Zeichenfolge Format: UTC oder Ortszeit (jjjj-mm-tt hh:mm:ss) |
| Exclude_reservables | Liste von einer oder mehreren sys_IDs von reservierbaren Elementen, die aus den Suchergebnissen ausgeschlossen werden sollen. Datentyp: Zeichenfolge oder Array Tabelle: Die Tabelle, in der sich diese sys_IDs befinden, wird im Feld „Reservierbares Modul“ in der Tabelle „Reservierbares Modul“ [sn_wsd_rsv_reservable_Module] angegeben. Es kann sich entweder um die Tabelle „Bereich“ [sn_wsd_Core_space] oder „Raum“ [sn_wsd_Core_room] handeln. |
| Ignorieren_same_day_validation | Kennzeichnung, die angibt, ob die Reservierungssuche die Änderung der Datumsvalidierung zwischen den Start- und Endparametern ignoriert. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| Include_reservable_purposes | Kennzeichnung, die angibt, ob der Zweck der Reservierung des Arbeitsplatzstandorts für jedes reservierbare Element in den Rückgabeergebnissen zurückgegeben werden soll. Gültige Werte:
Datentyp: Boolesch Standardwert: false Tabelle: Reservierbarer Zweck [sn_wsd_rsv_reservable_purpose] |
| Include_Reservierungen_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:
Datentyp: Boolesch Standardwert: false |
| Include_Standard_-Services | Kennzeichnung, die angibt, ob die Standardserviceinformationen in der Antwort zurückgegeben werden sollen. Diese Informationen befinden sich in der Tabelle „Standardservice“ [sn_wsd_rsv_Standard_Service]. Ein Standardservice beschreibt grundlegende Vorkehrungen, die bei der Reservierung mit einem reservierbaren Arbeitsplatzelement verfügbar sind, z. B. Whiteboards, zusätzliche Monitore und ähnliche Services. Weitere Informationen zu Standardservices finden Sie unter Standardservices . Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| Near_by_location_ID | Erforderlich, wenn rsv_pathParameter ist auf festgelegt Browse_near_a_Person . SYS_ID des Standorts, der in der codierten Abfrage verwendet werden soll. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzstandort [sn_wsd_Core_Workplace_location] |
| Arbeitsbereich | Erforderlich, wenn Nur verfügbar, wenn das Plugin „Platzmanagement“ (sn_wsd_spc_mgmt_Workspace) aktiviert ist. SYS_ID des Arbeitsbereichsdatensatzes, der in der codierten Abfrage verwendet werden soll. Weitere Informationen zu Platzreservierungen im Arbeitsbereich finden Sie unter Create neighborhood reservations. Datentyp: Zeichenfolge Tabelle: Arbeitsbereich [sn_wsd_spcmgmt_Workspace] |
| Next_item_index | Index des nächsten abzurufenden Elements. Übergeben Sie diesen Parameter beim Paginieren der Rückgabeergebnisse. 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, die zum Filtern der Suchergebnisse verwendet werden soll. In dieser Abfrage müssen Sie die sys_ID des Gebäudes angeben, und Sie können Parameter wie Stockwerk, Fläche, Kapazität, Standardservices und reservierbare Zwecke angeben. Alle übergebenen Parameter müssen sys_IDs sein, mit Ausnahme der Kapazität, die eine Zahl ist. Beispiel: Sie können diese Informationen in den folgenden Tabellen finden:
Datentyp: Zeichenfolge |
| Reservierbares_Modul | Erforderlich. SYS_ID des reservierbaren Moduls, das in die Suche aufgenommen werden soll. A Reservierbares Modul Gruppiert ähnliche Arten von Arbeitsplatzelementen. Datentyp: Zeichenfolge Tabelle: Reservierbares Modul [sn_wsd_rsv_reservable_Module] |
| Reservation_IDs | Kommagetrennte Liste der vorhandenen Reservierungs-sys_IDs. Übergeben Sie diesen Parameter, wenn Sie die zugehörigen Reservierungen bearbeiten möchten. Die Sperrzeit für diese sys_IDs für die entsprechenden reservierbaren Elemente wird als verfügbar behandelt. Datentyp: Zeichenfolge Standard: Keine Tabelle: Arbeitsplatzreservierung [sn_wsd_rsv_reservation] |
| rsv_path | Reservierungspfad, der auf die Suche angewendet werden soll. Gültige Werte:
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 mehr als einen Tag umfassen. Die Rückgabeergebnisse enthalten nur verfügbare Zeiten und Reservierungen für das angegebene Datum. Damit diese Funktionalität ordnungsgemäß funktioniert, die Parameter ignore_same_day_validationUnd include_reservations_within_daysMuss auf festgelegt werden Wahr . Datentyp: Objekt |
| Schedule_View_obj.schedule_View_date | Datum, für das mit der Rückgabe der Reservierungsverfügbarkeit begonnen werden soll. Dieses Datum muss sich in der in angegebenen Zeitzone befinden schedule_view_obj.timezoneParameter. Datentyp: Zeichenfolge Format: JJJJ-MM-TT |
| Schedule_View_obj.timezone | Zeitzone wird erstellt, die zur Bestimmung der zurückzugebenden Reservierungsverfügbarkeitsdaten verwendet werden soll. Beispiel: USA/Pazifik. Datentyp: Zeichenfolge |
| Start | Erforderlich. Startzeit, die für die Suche nach verfügbaren reservierbaren Modulen verwendet werden soll. Dieser Wert muss vor dem in angegebenen Wert liegen endParameter. Datentyp: Zeichenfolge Format: UTC oder Ortszeit (jjjj-mm-tt hh:mm:ss) |
| Schicht | SYS_ID der Schicht, die der Reservierung zugeordnet werden soll. Wenn dieser Parameter übergeben wird, wird endParameter ist nicht erforderlich. Weitere Informationen zu schichtbasierten Reservierungen finden Sie unter Aktivieren Sie die schichtbasierte Reservierung . Datentyp: Zeichenfolge Tabelle: Schicht [sn_wsd_Core_Shift] |
| Sortieren_nach | Gewünschte Sortierreihenfolge der zurückgegebenen reservierbaren Elemente. Gültige Werte:
Datentyp: Zeichenfolge Standard: A_z |
| Feld | Bevorzugte Zeitzone, z. B. Europa/Amsterdam. Datentyp: Zeichenfolge Standard: Keine |
| Name | Beschreibung |
|---|---|
| Keine |
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 .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Anforderungstexts. Unterstützte Typen: application/json, application/xmlOder, text/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
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 REST API-HTTP-Antwortcodes .
| 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. |
Parameter des Antwort-Haupttexts
| Name | Beschreibung |
|---|---|
| Ergebnis | Ergebnisse für die angegebene Suche zurückgeben. Datentyp: Objekt |
| Ergebnis.Filter | Details zu den Stockwerken, Standardservices und reservierbaren Zwecken der reservierbaren Elemente. Wenn include_standard_servicesOder include_reservable_purposesParameter sind auf „falsch“ festgelegt, standard_servicesUnd reservable_purposesSind leere Arrays. Datentyp: Objekt |
| Ergebnis.Filter.Stockwerke | Details zum Stockwerk, auf dem sich das reservierbare Element befindet.
Datentyp: Objekt |
| Ergebnis.Filter.Stockwerke.Display_value | Anzeigenummer des Stockwerks, in dem sich das reservierbare Element befindet, z. B. 12. Datentyp: Zeichenfolge |
| Ergebnis.Filter.Stockwerke.sys_ID | SYS_ID des zugeordneten Datensatzes. Datentyp: Zeichenfolge Tabelle: Stockwerk [sn_wsd_Core_floor] |
| Ergebnis.Filter.Standard_Services | Wird nur ausgefüllt, wenn include_standard_servicesParameter ist auf „wahr“ festgelegt. Zugehörige Standardservices, z. B. Flipchart, Projektorbildschirm, Whiteboard und Markierungen. Datentyp: Array von Objekten
|
| Ergebnis.Filter.Standard_Services.Font_Awesome_icon | Name des Miniaturansichtssymbols, das dem Standardservice zugeordnet ist. Datentyp: Zeichenfolge |
| result.filter.standard_services.name | Name des Standardservice. Datentyp: Zeichenfolge |
| Ergebnis.Filter.Standard_Services.short_description | Kurze Beschreibung des Standardservice. Datentyp: Zeichenfolge |
| Ergebnis.Filter.Standard_Services.sys_ID | SYS_ID des Standardservicedatensatzes. Datentyp: Zeichenfolge Tabelle: Standardservice [sn_wsd_rsv_Standard_Service] |
| Ergebnis.Filter.reservierbar_Zwecke | Details zum Zweck der Reservierung des zugehörigen reservierbaren Elements. Datentyp: Array von Objekten |
| result.filter.reservable_purposes.name | Name des reservierbaren Elements. Datentyp: Zeichenfolge |
| Ergebnis.Filter.reservierbare_Zwecke.Short_description | Kurze Beschreibung des reservierbaren Elements. Datentyp: Zeichenfolge |
| Ergebnis.Filter.reservierbar_Zwecke.sys_ID | SYS_ID des Datensatzes für reservierbare Zwecke. Datentyp: Zeichenfolge Tabelle: Reservierbarer Zweck [sn_wsd_rsv_reservable_purpose] |
| Ergebnis.hasWeitere | Kennzeichnung, die angibt, ob in den Rückgabeergebnissen weitere Reservierungsmöglichkeiten vorhanden sind. Mögliche Werte:
Datentyp: Boolesch |
| Ergebnis.nextFavIndex | Index für den nächsten Favoriten, der für den Anwender reserviert werden kann. Verwenden Sie diesen Wert, wenn Sie durch die bevorzugten reservierbaren Elemente des Anwenders paginieren. Datentyp: Zahl |
| Ergebnis.nextItemIndex | Index für den nächsten abzurufenden reservierbaren Datensatz. Verwenden Sie diesen Wert, wenn Sie durch reservierbare Datensätze paginieren. Datentyp: Zahl |
| Ergebnis.ReservierbarContainer | Wird nur für reservierbare Module zurückgegeben, deren Feld „selection_type“ auf festgelegt ist Container . Ein Container ist eine Gruppierung ähnlicher Elemente, z. B. einer Gruppe von Schreibtischen. Datentyp: Array von Objekten |
| Ergebnis.ReservierbarContainer.Gebäude | Details zum Gebäude, das dem reservierbaren Container zugeordnet ist. Datentyp: Objekt |
| Ergebnis.ReservierbarContainer.Gebäude.Display_value | Anzeigewert für das Gebäude. Datentyp: Zeichenfolge |
| result.reservableContainers.building.name | Name des Gebäudes Datentyp: Zeichenfolge |
| Ergebnis.ReservierbarContainer.Gebäude.sys_ID | SYS_ID des zugehörigen Gebäudedatensatzes. Datentyp: Zeichenfolge |
| result.reservableContainers.campus | Details zum Campus, auf dem sich das reservierbare Element befindet.
Datentyp: Objekt
Tabelle: Campus [sn_wsd_Core_Campus] |
| result.reservableContainers.campus.Display_value | Anzeigenummer des Campus, auf dem sich das reservierbare Element befindet, z. B. East Bay. Datentyp: Zeichenfolge |
| result.reservableContainers.campus.name | Name des Campus. Datentyp: Zeichenfolge |
| result.reservableContainers.campus.sys_id | SYS_ID des zugeordneten Datensatzes. Datentyp: Zeichenfolge Tabelle: Campus [sn_wsd_Core_Campus] |
| result.reservableContainers.capacity | Maximale Anzahl von Personen für das reservierbare Element. Datentyp: Zahl |
| Ergebnis.ReservierbarContainer.Display_value | Anzeigewert für den reservierbaren Container. Datentyp: Zeichenfolge |
| Ergebnis.ReservierbarContainer.Stockwerk | Details zum Stockwerk, das dem reservierbaren Container zugeordnet ist. Datentyp: Objekt |
| Ergebnis.ReservierbarContainer.Stockwerk.Display_value | 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.ReservierbarContainer.Stockwerk.sys_ID | SYS_ID des zugeordneten Datensatzes. Datentyp: Zeichenfolge Tabelle: Stockwerk [sn_wsd_Core_floor] |
| Ergebnis.ReservierbarContainer.Image | Link zu einem Bild, das das Layout für dieses reservierbare Element darstellt. Datentyp: Zeichenfolge Tabelle: Images [DB_image] |
| result.reservableContainers.image.link | Link zu einem Bild, das das Layout für dieses reservierbare Element darstellt. Datentyp: Zeichenfolge Tabelle: Images [DB_image] |
| Ergebnis.ReservierbarContainer.Image.sys_ID | SYS_ID des zugeordneten Bilddatensatzes. Datentyp: Zeichenfolge |
| Ergebnis.ReservierbarContainer.sys_ID | SYS_ID des zugeordneten Containerdatensatzes. Datentyp: Zeichenfolge Tabelle: Die Tabelle, in der sich dieser befindet, kann für jeden Containertyp konfiguriert werden. Standardmäßig befindet sie sich in der Tabelle „Bereich“ [sn_wsd_Core_area]. |
| Ergebnis.ReservierbarEinheiten | Details zu den reservierbaren Einheiten, die den angegebenen Suchkriterien entsprechen. Eine reservierbare Einheit ist ein einzelnes reservierbares Element, z. B. ein Schreibtisch oder ein Stuhl. Datentyp: Array von Objekten |
| Ergebnis.ReservierbarEinheiten.Fläche | Details zum Bereich, in dem sich das reservierbare Modul befindet. Datentyp: Objekt Tabelle: Bereich [sn_wsd_Core_area] |
| Ergebnis.reservierbarEinheiten.Bereich.Anzeige_Wert | Anzeigewert für den reservierbaren Modulbereich. Datentyp: Zeichenfolge |
| Ergebnis.reservierbarEinheiten.Bereich.sys_ID | SYS_ID des Bereichsdatensatzes, der dem reservierbaren Element zugeordnet ist. Datentyp: Zeichenfolge |
| Ergebnis.ReservierbarEinheiten.VerfügbarZeiten | Liste der Daten/Uhrzeiten, zu denen das zugehörige reservierbare Element verfügbar ist. Datentyp: Array |
| Ergebnis.ReservierbarEinheiten.Gebäude | Details zum Gebäude, in dem sich das reservierbare Element befindet. Datentyp: Objekt Tabelle: Gebäude [sn_wsd_Core_Building] |
| Ergebnis.ReservierbarEinheiten.Gebäude.Anzeige_Wert | Anzeigewert für das Gebäude. Datentyp: Zeichenfolge |
| Ergebnis.reservierbarEinheiten.Gebäude.sys_ID | SYS_ID des zugehörigen Gebäudedatensatzes. Datentyp: Zeichenfolge |
| result.reservableUnits.campus | Details zum Campus, auf dem sich das reservierbare Element befindet.
Datentyp: Objekt
Tabelle: Campus [sn_wsd_Core_Campus] |
| result.reservableUnits.campus.display_value | Anzeigenummer des Campus, auf dem sich das reservierbare Element befindet, z. B. East Bay. Datentyp: Zeichenfolge |
| result.reservableUnits.campus.sys_id | SYS_ID des zugeordneten Datensatzes. Datentyp: Zeichenfolge Tabelle: Campus [sn_wsd_Core_Campus] |
| result.reservableUnits.capacity | 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 |
| Ergebnis.reservierbarEinheiten.external_ID | Externe ID des reservierbaren Elements, das zum Synchronisieren eines in CMS zugeordneten Bereichs verwendet wird. Dieser Wert wird nur ausgefüllt, wenn diesem Standort eine Karte zugeordnet ist. Datentyp: Zeichenfolge |
| Ergebnis.ReservierbarEinheiten.Stockwerk | Details zum Stockwerk, auf dem sich das reservierbare Element befindet.
Datentyp: Objekt
Tabelle: Stockwerk [sn_wsd_Core_floor] |
| Ergebnis.ReservierbarEinheiten.Stockwerk.Display_value | Anzeigenummer des Stockwerks, in dem sich das reservierbare Element befindet, z. B. 12. Datentyp: Zeichenfolge |
| Ergebnis.reservierbarEinheiten.Stockwerk.sys_ID | SYS_ID des zugeordneten Datensatzes. Datentyp: Zeichenfolge Tabelle: Stockwerk [sn_wsd_Core_floor] |
| Ergebnis.ReservierbarEinheiten.Bild | Details zu einem Bild, das das Layout für das zugehörige reservierbare Element darstellt. Datentyp: Objekt Tabelle: Images [DB_image] |
| result.reservableUnits.image.link | Link zu einem Bild, das das Layout für dieses reservierbare Element darstellt. Datentyp: Zeichenfolge Tabelle: Images [DB_image] |
| Ergebnis.reservierbarEinheiten.Image.sys_ID | SYS_ID des zugeordneten Bilddatensatzes. Datentyp: Zeichenfolge |
| result.reservableUnits.includedInResult | Kennzeichnung, die angibt, ob das aktuelle reservierbare Element in den Rückgabeergebnissen enthalten ist. Gültige Werte:
Datentyp: Boolesch |
| Ergebnis.reservierbarEinheiten.ist_verfügbar | Kennzeichnung, die angibt, ob das reservierbare Element für die Reservierung verfügbar ist. Gültige Werte:
Datentyp: Boolesch |
| Ergebnis.reservierbarEinheiten.ist_Favorit | Kennzeichnung, die angibt, ob das reservierbare Element als einer der Favoriten des zugehörigen Anwenders gekennzeichnet ist. Gültige Werte:
Datentyp: Boolesch |
| Ergebnis.reservierbarEinheiten.ist_reservierbar | Kennzeichnung, die angibt, ob dieses reservierbare Element reserviert werden kann. Hinweis: Wenn include_unavailable_itemsAbfrageparameter ist auf „wahr“ festgelegt, nicht verfügbare Standorte werden ebenfalls zurückgegeben. Wenn in diesem Fall bereits ein Standort reserviert ist, wird der verwendet is_availableParameter ist „falsch“, aber is_reservableIst „wahr“. Gültige Werte:
Datentyp: Boolesch |
| Ergebnis.reservierbarEinheiten.ist_reserviert | Kennzeichnung, die angibt, ob das reservierbare Element bereits reserviert ist. Gültige Werte:
Datentyp: Boolesch |
| Ergebnis.reservierbarEinheiten.ist_ausgewählt | Kennzeichnung, die angibt, ob das reservierbare Element bereits reserviert ist. Gültige Werte:
Datentyp: Boolesch |
| Ergebnis.reservierbarEinheiten.Standort_Typ | Details zum Typ des Standorts des reservierbaren Elements, z. B. Arbeitsplatz/Schreibtisch, Café oder Fitnessstudio. Datentyp: Objekt Tabelle: Arbeitsplatzstandort [sn_wsd_Core_Workplace_location] |
| Ergebnis.reservableEinheiten.Location_type.Display_value | Anzeigewert des Standorttyps. Datentyp: Zeichenfolge |
| result.reservableUnits.location_type.name | Name des Standorttyps, z. B. Keller oder Speicher. Identisch mit Anzeigewert. Datentyp: Zeichenfolge |
| Ergebnis.reservierbarEinheiten.Location_type.sys_ID | SYS_ID des zugeordneten Datensatzes. Datentyp: Zeichenfolge Tabelle: Bereichstyp [sn_wsd_Core_space_type] |
| result.reservableUnits.name | Name des reservierbaren Elements. Datentyp: Zeichenfolge |
| Ergebnis.ReservierbarEinheiten.Nummer | Eindeutiger Bezeichner des reservierbaren Elements. Dieser Wert ist visuell lesbarer als die sys_ID. Datentyp: Zeichenfolge |
| Ergebnis.ReservierbarEinheiten.Reihenfolge | Auftragsnummer für das reservierbare Element. Datentyp: Zahl |
| Ergebnis.reservableEinheiten.need_Approval | Kennzeichnung, die angibt, ob die Reservierung des reservierbaren Elements eine Genehmigung erfordert. Mögliche Werte:
Datentyp: Boolesch |
| Ergebnis.reservierbarEinheiten.erfordert_Check_in | Kennzeichnung, die angibt, ob der Anwender für das reservierbare Element einchecken muss. Gültige Werte:
Datentyp: Boolesch |
| Ergebnis.reservierbarEinheiten.reservierbare_Zwecke | Details zum Zweck der Reservierung des zugehörigen reservierbaren Elements. Datentyp: Array von Objekten |
| Ergebnis.reservierbare Einheiten.reservierbare_Zwecke.Name | Name des reservierbaren Elements. Datentyp: Zeichenfolge |
| Ergebnis.reservierbare Einheiten.reservierbare_Zwecke.Short_description | Kurze Beschreibung des reservierbaren Elements. Datentyp: Zeichenfolge |
| Ergebnis.reservierbare Einheiten.reservierbare_Zwecke.sys_ID | SYS_ID des Datensatzes für reservierbare Zwecke. Datentyp: Zeichenfolge Tabelle: Reservierbarer Zweck [sn_wsd_rsv_reservable_purpose] |
| Ergebnis.ReservierbarEinheiten.Reservierungen | Details zu den Reservierungen, die dem reservierbaren Element zugeordnet sind. Wird nur ausgefüllt, wenn include_reservations_within_daysAbfrageparameter ist „wahr“ und reservation_idsParameter enthält Reservierungs-IDs, d. h. für dieses reservierbare Element sind bereits Reservierungen vorhanden. Datentyp: Array von Objekten |
| Ergebnis.reservierbarEinheiten.Reservierungen.Configuration_item | Konfigurationselemente, die der Reservierung entsprechen. Datentyp: Zeichenfolge Tabelle: Konfigurationselement [cmdb_ci] |
| Ergebnis.ReservierbarEinheiten.Reservierungen.Ende | Enddatum und -Uhrzeit der Reservierung. Datentyp: Zeichenfolge Format: UTC: jjjj-mm-ddThh:mm:ssZ, z. B. 2021-02-05T18:00:00Z |
| Ergebnis.reservierbarEinheiten.Reservierungen.is_Collided | Kennzeichnung, die angibt, ob die Reservierung mit der Start- und Endzeit der Suche kollidiert. Dies gibt an, dass der zugeordnete reservierbare Standort bereits für den angegebenen Suchzeitraum reserviert ist. Mögliche Werte:
Datentyp: Boolesch |
| Ergebnis.ReservierbarEinheiten.Reservierungen.Standort | Details zum Standort der Reservierung. Datentyp: Objekt |
| Ergebnis.ReservierbarEinheiten.Reservierungen.Standort.Standort | SYS_ID des zugehörigen Standortdatensatzes. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzstandort [sn_wsd_Core_Workplace_location] |
| Ergebnis.ReservierbarEinheiten.Reservierungen.Standort.Zeitzone | Details zur Zeitzone, die dem Standort zugeordnet ist. Datentyp: Objekt |
| Ergebnis.ReservierbarEinheiten.Reservierungen.Standort.Zeitzone.Anzeigewert | Anzeigewert für die Zeitzone, zu der dieser Standort gehört. Datentyp: Zeichenfolge |
| Ergebnis.ReservierbarEinheiten.Reservierungen.Standort.Zeitzone.Wert | Interner Wert für die Zeitzone, zu der dieser Standort gehört. Datentyp: Zeichenfolge |
| Ergebnis.ReservierbarEinheiten.Reservierungen.Nummer | Eindeutiger Bezeichner des reservierbaren Elements. Dieser Wert ist visuell lesbarer als die sys_ID. Datentyp: Zeichenfolge |
| Ergebnis.reservierbarEinheiten.Reservierungen.Angefordert_für | Details zur Person, für die die Reservierung angefordert wurde. Datentyp: Objekt |
| Ergebnis.ReservierbarEinheiten.Reservierungen.requested_for.name | Name des Anwenders, für den die Reservierung angefordert wurde. Datentyp: Zeichenfolge |
| Ergebnis.reservierbarEinheiten.Reservierungen.Angefordert_für.sys_ID | SYS_ID des Anwenders, für den die Reservierung angefordert wird. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
| Ergebnis.reservierbarEinheiten.Reservierungen.Reservation_purpose | Details zum Zweck der Reservierung. Datentyp: Objekt |
| Ergebnis.reservierbarEinheiten.Reservierungen.Reservation_purpose.Display_value | Anzeigewert für den Zweck der Reservierung, z. B. Unternehmensbesprechung. Datentyp: Zeichenfolge |
| Ergebnis.reservierbarEinheiten.Reservierungen.Reservation_purpose.value | Interner Wert für den Zweck der Reservierung, z. B. Company_Meeting. Datentyp: Zeichenfolge |
| Ergebnis.ReservierbarEinheiten.Reservierungen.Start | Startdatum und -Uhrzeit der Reservierung. Datentyp: Zeichenfolge Format: UTC – jjjj-mm-ddThh:mm:ssZ, z. B. 2021-02-05T18:00:00Z |
| Ergebnis.ReservierbarEinheiten.Reservierungen.Status | Details zum Status der Reservierung für den Standort. Datentyp: Objekt |
| Ergebnis.reservierbarEinheiten.Reservierungen.Status.Display_value | Anzeigewert für den aktuellen Status der Reservierung, z. B. bestätigt. Datentyp: Zeichenfolge |
| Ergebnis.ReservierbarEinheiten.Reservierungen.Status.Wert | Interner Wert für den aktuellen Status der Reservierung, z. B. 2. Datentyp: Zeichenfolge |
| Ergebnis.ReservierbarEinheiten.Reservierungen.Betreff | Betreff der Reservierung. Datentyp: Zeichenfolge |
| Ergebnis.reservierbarEinheiten.Reservierungen.sys_ID | Erforderlich. SYS_ID des Reservierungsdatensatzes. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzreservierung [sn_wsd_rsv_reservation] |
| Ergebnis.reservierbare Einheiten.reservierbare Menge | Maximale Anzahl, mit der das zugeordnete reservierbare Element gleichzeitig reserviert werden kann. Dieser Wert wird verwendet, wenn einem Bereich Arbeitsbereiche zugewiesen werden. Datentyp: Ganzzahl |
| result.reservableUnits.site | Details zum Standort, auf dem sich das reservierbare Element befindet. Datentyp: Objekt Tabelle: Site [sn_wsd_Core_Site] |
| Ergebnis.reservierbarEinheiten.Site.Display_value | Anzeigewert der Site. Datentyp: Zeichenfolge |
| Ergebnis.reservierbarEinheiten.Site.sys_ID | SYS_ID des zugehörigen Site-Datensatzes. Datentyp: Zeichenfolge Tabelle: Site [sn_wsd_Core_Site] |
| Ergebnis.reservierbarEinheiten.Standard_Services | Zugehörige Standardservices, z. B. Flipchart, Projektorbildschirm, Whiteboard und Markierungen. Datentyp: Array von Objekten
|
| Ergebnis.reservableEinheiten.Standard_Services.Font_Awesome_icon | Name des Miniaturansichtssymbols, das dem Standardservice zugeordnet ist. Datentyp: Zeichenfolge |
| result.reservableUnits.standard_services.name | Name des Miniaturansichtssymbols, das dem Standardservice zugeordnet ist. Datentyp: Zeichenfolge |
| Ergebnis.reservableEinheiten.Standard_Services.Short_description | Kurze Beschreibung des Standardservice. Datentyp: Zeichenfolge |
| Ergebnis.reservierbarEinheiten.Standard_Services.sys_ID | SYS_ID des Standardservicedatensatzes. Datentyp: Zeichenfolge Tabelle: Standardservice [sn_wsd_rsv_Standard_Service] |
| Ergebnis.reservierbare Einheiten.sys_ID | SYS_ID des reservierbaren Datensatzes. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzstandort [sn_wsd_Core_Workplace_location] |
| Ergebnis.ReservierbarEinheiten.tableName | Name der Tabelle, in der sich der reservierbare Datensatz befindet. Datentyp: Zeichenfolge |
| Ergebnis.ReservierbarEinheiten.Titel | Titel des reservierbaren Elements. Datentyp: Zeichenfolge |
| Ergebnis.Gesamtverarbeitete | Gesamtanzahl der verarbeiteten Datensätze. Datentyp: Zahl |
cURL-Anforderung
Dieses Beispiel zeigt, wie mit diesem Endpunkt nach reservierbaren Elementen gesucht wird. Hinweis: Zeilenumbrüche wurden den Abfrageparametern 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}
Gibt eine codierte Abfrage zurück, mit der Sie in der Tabelle „Schicht“ [sn_wsd_Core_Shift] nach verfügbaren Schichten 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
Versionierte URL: /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
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Gebäude_ID | SYS_ID des Gebäudes, das in die Suchabfrage aufgenommen werden soll. Datentyp: Zeichenfolge Tabelle: Gebäude [sn_wsd_Core_Building] |
| module_id | SYS_ID des reservierbaren Moduls, das in die Suchabfrage aufgenommen werden soll. Ein reservierbares Modul gruppiert ähnliche Arten von Arbeitsplatzelementen, z. B. Stühle oder Schreibtische. Datentyp: Zeichenfolge Tabelle: Reservierbares Modul [sn_wsd_Core_reservable_Module] |
| Name | Beschreibung |
|---|---|
| Keine |
| 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 |
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 .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Anforderungstexts. Unterstützte Typen: application/json, application/xmlOder, text/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
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 REST API-HTTP-Antwortcodes .
| 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. |
Parameter des Antwort-Haupttexts
| Name | Beschreibung |
|---|---|
| Ergebnis | Codierte Abfrage, die zum Abrufen der angegebenen verfügbaren Schichten verwendet werden soll. Datentyp: Objekt |
| ModuleHasShift | Kennzeichnung, die angibt, ob für das angegebene reservierbare Modul Schichten aktiviert sind. Gültige Werte:
Datentyp: Boolesch |
| query | Codierte Abfrage zum Abrufen von Schichtinformationen für das angegebene reservierbare Modul. Datentyp: Zeichenfolge |
cURL-Anforderung
Das folgende Codebeispiel zeigt, wie Sie diesen Endpunkt verwenden, 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
Gibt eine Verfügbarkeitspunktzahl für reservierbare Elemente für angegebene Zeitfenster zurück.
URL-Format
Versionierte URL: /api/sn_wsd_rsv/{api_Version}/search/Availability_score
Standard-URL: /api/sn_wsd_rsv/search/availability_score
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| RecurringPattern | Erforderlich, wenn startEndDateTimesParameter ist nicht angegeben. Wiederkehrendes Muster, das zum Suchen nach reservierbaren Elementen verwendet werden soll, die für die angegebenen wiederkehrenden Ereignisse verfügbar sind. Datentyp: Objekt |
| 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. Wird täglich 5 Mal wiederholt . Datentyp: Zeichenfolge |
| RecurringPattern.options | Verfügbarkeitsoptionen für die wiederkehrende Reservierung, nach der gesucht werden soll. Datentyp: Objekt |
| RecurringPattern.options.count | Erforderlich, wenn endDateWurde nicht übergeben. Wenn beide bestanden werden, countWird verwendet. Anzahl der Wiederholungen des Besprechungsmusters. Datentyp: Zahl |
| RecurringPattern.options.daysOfWeek | Erforderlich, wenn recurringPattern.repeatsParameter ist auf festgelegt Wöchentlich . Wochentage, an denen das reservierbare Element benötigt wird. Gültige Werte:
Um beispielsweise Dienstag, Donnerstag und Freitag anzugeben, übergeben Sie 245 (kein Trennzeichen). Wenn repeatIst wöchentlich, countIst 5, und daysOfWeekIst 245, dann ist die Summe in den Rückgabeergebnissen gleich Datentyp: Zeichenfolge |
| RecurringPattern.options.endDate | Erforderlich, wenn recurringPattern.options.countWurde nicht übergeben. Wenn beide bestanden werden, countWird 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 |
| Wiederkehrendes Muster.Wiederholungen | Erforderlich. Wiederkehrendes Muster für das reservierbare Element. Gültige Werte (Groß-/Kleinschreibung beachten):
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 aufgenommen werden sollen. Datentyp: Array Tabelle: Arbeitsplatzstandort [sn_wsd_Core_Workplace_location] |
| Reservierbarer Typ | Erforderlich. Typ des reservierbaren Elements, das in die Verfügbarkeitspunktzahl aufgenommen werden soll. Wird verwendet, um die Suche zu verfeinern. Gültige Werte (Groß-/Kleinschreibung beachten):
Datentyp: Zeichenfolge |
| StartEndDateTimes | Liste der Start- und Enddaten und -Zeiten in der Zeitzone des Anwenders, nach der gesucht werden soll. Datentyp: Array von Objekten Standard: Muss angegeben werden recurringPatternParameter. |
| 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 |
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 .
| 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. |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
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 REST API-HTTP-Antwortcodes .
| 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. |
Parameter des Antwort-Haupttexts
| Name | Beschreibung |
|---|---|
| Ergebnis | Ergebnisse für die angegebene Verfügbarkeitspunktzahl zurückgeben. Datentyp: Objekt |
| Ergebnis.reservierbar_sys_ID | Details zur Verfügbarkeitspunktzahl. Datentyp: Objekt |
| Ergebnis.reservierbar_sys_ID.verfügbar | Anzahl der verfügbaren reservierbaren Elemente, die die angegebenen Suchkriterien erfüllen. Datentyp: Zahl |
| Ergebnis.reservierbar_sys_ID.Punktzahl | Verfügbarkeitspunktzahl Anzahl der verfügbaren reservierbaren Elemente über der Gesamtzahl der reservierbaren Elemente, die die angegebenen Suchkriterien erfüllen. Beispiel: Wenn availableIst 2 und totalIst 4, die scoreWert ist 2/4. Datentyp: Zeichenfolge |
| result.reservable_sys_id.total | Gesamtanzahl der reservierbaren Elemente, die die angegebenen Suchkriterien erfüllen. 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\": \"\",
},
\"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"
}
}