WSD – API für reservierbares Modul

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 15 Minuten Lesedauer
  • Die Workplace Service Delivery(WSD) Reservierbares Modul Die API stellt Endpunkte bereit, um Details eines reservierbaren Moduls von einem abzurufen ServiceNow Instanz.

    Ein reservierbares Modul gruppiert ähnliche Arten von Arbeitsplatzelementen. Mitarbeiter können diese ähnlichen Elemente in einer einzelnen Kategorie anzeigen. Beispielsweise ist ein Raum ein reservierbares Modul und enthält ähnliche Arbeitsplatzelemente wie Besprechungsräume, Konferenzräume und andere Räume.

    Um auf diese API zuzugreifen, muss der Anrufer über die Rolle sn_wsd_Core.Workplace_user verfügen, und das Plugin „Workplace Reservation Management“ (sn_wsd_rsv) muss aktiviert sein. Diese API wird in ausgeführt sn_wsd_rsv Namespace.

    Für zusätzliche Informationen zu Workplace Reservation Management, Siehe Workplace Reservation Management.

    Reservierbares WSD-Modul – GET /sn_wsd_rsv/reservable_Module/{sys_ID} AB

    Gibt die Details für ein angegebenes reservierbares Modul zurück.

    URL-Format

    Versionierte URL: /api/sn_wsd_rsv/{api_Version}/reservable_Module/{sys_ID}

    Standard-URL: /api/sn_wsd_rsv/reservable_Module/{sys_ID}

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfadparameter
    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

    sys_id SYS_ID des abzurufenden stornierbaren Moduldatensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Reservierbares Modul [sn_wsd_rsv_reservable_Module]

    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    Ist_buildings_Tree_Data_required Kennzeichnung, die angibt, ob die Gebäudedaten zurückgegeben werden sollen, die dem reservierbaren Modell zugeordnet sind.
    Gültige Werte:
    • Wahr: Geben Sie die Gebäudedaten zurück.
    • Falsch: Geben Sie die Gebäudedaten nicht zurück.

    Datentyp: Boolesch

    Standardwert: false

    Arbeitsbereich

    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.

    Der Endpunkt überprüft, ob der Arbeitsbereich gültig ist, und ruft dann die Daten ab, die für den Pfad „nach Arbeitsbereich durchsuchen“ erforderlich sind.

    Datentyp: Zeichenfolge

    Tabelle : 3. Anforderungstextparameter (XML oder JSON)
    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 .

    Tabelle : 4. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json

    Tabelle : 5. Antwortkopfzeilen
    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 .

    Tabelle : 6. Statuscodes
    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 für das angeforderte reservierbare Modul.

    Datentyp: Objekt

    {
      "result": {
        "allow_invitees": Boolean,
        "allow_whole_day": Boolean,
        "apply_to_shift": Boolean,
        "browse_by_area_enabled": Boolean,
        "browse_by_neighborhood_enabled": Boolean,
        "browse_near_a_person_enabled": Boolean,
        "buildingsTreeData": [Array],
        "buildingSysIds": [Array],
        "checkin_before_minutes": Number,
        "display_number_of_attendees": Boolean,
        "display_on_behalf_of": Boolean,
        "display_sensitivity": Boolean,
        "display_value": "String",
        "enable_browse_by_area": Boolean,
        "enable_browse_by_neighborhood": Boolean,
        "enable_browse_near_a_person": Boolean,
        "enable_facet_filter": Boolean,
        "enable_group_reservations": Boolean,
        "enable_ical_generation": Boolean,
        "font_awesome_icon": "String",
        "inline_title": "String",      
        "layout_mapping": {JSON Object},
        "max_days_in_future": Number,
        "max_occurrences": Number,
        "name": "String",
        "nbhBuildingIds": [Array],
        "nbhBuildingsData": [Array];
        "nbhBuildingsTreeData": [Array],
        "override_approval_policy": "String",
        "require_cancel_notes": Boolean,
        "require_cc_dept_check": Boolean,
        "require_subject": Boolean,
        "reservable_columns": [Array],
        "reservable_container_field": "String",
        "reservable_filter": "String",
        "reservable_quantity_field": "String",
        "reservable_table": "String",
        "reservable_type": "String",
        "reservable_views": [Array],
        "reservation_paths": [Array],
        "search_limit": Number,
        "selection_type": "String",
        "short_description": "String",
        "show_map_view": Boolean,
        "sys_id": "String",
        "timeSlots": [Array],
        "title": "String",
        "virtual_meeting_provider": {Object}
      }
    }
    Ergebnis.allow_eingeladene Personen Kennzeichnung, die angibt, ob Mitarbeiter der Reservierung eingeladene Personen hinzufügen können.
    Gültige Werte:
    • Wahr: Mitarbeitern erlauben, der Reservierung eingeladene Personen hinzuzufügen.
    • Falsch: Mitarbeiter dürfen der Reservierung keine eingeladenen Personen hinzufügen.

    Datentyp: Boolesch

    Ergebnis.Allow_whole_day Kennzeichnung, die angibt, ob Anwender das reservierbare Element für den ganzen Tag reservieren können.
    Gültige Werte:
    • Wahr: Zulassen, dass Anwender für den gesamten Tag reservieren können.
    • Falsch: Zulassen, dass Anwender den ganzen Tag nicht reservieren.

    Datentyp: Boolesch

    Ergebnis.Anwenden_to_Shift Kennzeichnung, die angibt, ob schichtbasierte Reservierungen für das reservierbare Modul aktiviert sind.
    Gültige Werte:
    • Wahr: Schichtbasierte Reservierungen zulassen.
    • Falsch: Schichtbasierte Reservierungen nicht zulassen.

    Datentyp: Boolesch

    result.browse_by_area_enabled Kennzeichnung, die angibt, ob Anwender nach Bereich nach reservierbaren Modulen suchen können.
    Gültige Werte:
    • Wahr: Zulassen, dass Anwender reservierbare Module nach Bereich durchsuchen.
    • Falsch: Anwender dürfen reservierbare Module nicht nach Bereich durchsuchen.

    Datentyp: Boolesch

    result.browse_by_neighborhood_enabled Nur verfügbar, wenn das Plugin „Platzmanagement – sn_wsd_spc_mgmt“ installiert ist.

    Kennzeichnung, die angibt, ob Anwender in den reservierbaren Modulen nach Arbeitsbereich suchen können.

    Gültige Werte:
    • Wahr: Zulassen, dass Anwender reservierbare Module nach Arbeitsbereich durchsuchen können.
    • Falsch: Anwender dürfen reservierbare Module nicht nach Arbeitsbereich durchsuchen.

    Datentyp: Boolesch

    result.browse_near_a_person_enabled Kennzeichnung, die angibt, ob Anwender nach reservierbaren Modulen suchen können, die sich bei einer bestimmten Person befinden.
    Gültige Werte:
    • Wahr: Zulassen, dass Anwender reservierbare Module in der Nähe einer Person durchsuchen können.
    • Falsch: Zulassen, dass Anwender reservierbare Module in der Nähe einer Person durchsuchen.

    Datentyp: Boolesch

    Ergebnis.BuildingTreeDaten Wird nur zurückgegeben, wenn is_buildings_tree_data_requiredAbfrageparameter ist auf festgelegt Wahr . Hierarchie der Gebäude, die dem Modul „Reservierbar“ zugeordnet sind.
    Hierarchiereihenfolge:
    • Region: Befindet sich in der Tabelle „Region“ [sn_wsd_Core_Region].
    • Site: Befindet sich in der Tabelle „Site“ [sn_wsd_Core_Site].
    • Campus: Befindet sich in der Tabelle „Campus“ [sn_wsd_Core_Campus].
    • Gebäude: Befindet sich in der Tabelle „Gebäude“ [sn_wsd_Core_Building].
    Jeweils Untergeordnete Elemente[ ] Der Knoten spiegelt eine andere Gebäudeebene/einen anderen Hiearchy wider:
    • BuildingsTreeData: Region
    • buildingsTreeData.children: Website
    • buildingsTreeData.children.children: Campus
    • buildingsTreeData.children.children.children: Gebäude

    Datentyp: Array von Objekten

    "buildingsTreeData": [
      {
        "children": [Array],
        "data": {Object},
        "isSelectable": Boolean,
        "isValid": Boolean,
        "label": "String",
        "uId": "String"
      }
    ]
    result.buildingsTreeData.children Details zum Standort, Campus oder Gebäude, die dem Modul „Reservierbar“ zugeordnet sind. Jeder der Parameter in allen Untergeordnete Elemente[ ] Knoten sind identisch. Sie gelten nur für verschiedene Gebäudeentitäten und werden nur einmal in diesem Abschnitt beschrieben.

    Datentyp: Array von Objekten

    "children": [
      {
        "children": [Array],
        "data": {Object},
        "isSelectable": Boolean,
        "isValid": Boolean,
        "label": "String",
        "uId": "String"
      }
    ]
    result.buildingsTreeData.children.data Details zur Gebäudeentität.

    Datentyp: Objekt

    "data": {
      "sysId": "String",
      "table": "String",
      "timezone": {Object}
    }
    result.buildingsTreeData.children.data.sys_id SYS_ID der zugeordneten Gebäudeentität.

    Datentyp: Zeichenfolge

    result.buildingsTreeData.children.data.table Name der Tabelle, in der sich der in der sys_ID identifizierte Gebäudeentitätsdatensatz befindet.

    Datentyp: Zeichenfolge

    result.buildingsTreeData.children.data.​Zeitzone Details zur Zeitzone der Gebäudeentität.
    "timezone": {
      "displayValue": "String",
      "value":  "String"
    }
    result.buildingsTreeData.children.data.​Zeitzone.Anzeigewert Anzeigewert im Datensatz für die Zeitzone.

    Datentyp: Zeichenfolge

    result.buildingsTreeData.children.data.​Zeitzone.Wert Interner Wert im Datensatz für die Zeitzone.

    Datentyp: Zeichenfolge

    result.buildingsTreeData.children.isSelectable Kennzeichnung, die angibt, ob die zugehörige Gebäudeentität für das reservierbare Modell verfügbar (auswählbar) ist.
    Gültige Werte:
    • Wahr: Die Gebäudeentität ist für das reservierbare Modul verfügbar.
    • Falsch: Die Gebäudeentität ist für das reservierbare Modul nicht verfügbar.

    Datentyp: Boolesch

    result.buildingsTreeData.children.isValid Kennzeichnung, die angibt, ob die zugehörige Gebäudeentität für das reservierbare Modell gültig ist.
    Gültige Werte:
    • Wahr: Die Gebäudeentität ist für das reservierbare Modul gültig.
    • Falsch: Die Gebäudeentität ist für das reservierbare Modul nicht gültig.

    Datentyp: Boolesch

    result.buildingsTreeData.children.label Name der Gebäudeentität.

    Datentyp: Zeichenfolge

    result.buildingsTreeData.children.uId SYS_ID des zugehörigen Gebäudeentitätsdatensatzes.

    Datentyp: Zeichenfolge

    Ergebnis.BuildSysIds Liste der sys_IDs der Gebäude, die dem Modul „Reservierbar“ zugeordnet sind.

    Datentyp: Array von Zeichenfolgen

    result.checkin_before_minutes Zeitraum, bis eine Reservierung beginnt, bis ein Anwender seine Reservierung einchecken kann.

    Einheit: Minuten

    Datentyp: Zahl

    Ergebnis.Display_number_of_attendees Kennzeichnung, die angibt, ob Anwender die Anzahl der Teilnehmer in der Reservierung angeben können.
    Gültige Werte:
    • Wahr: Anwender können die Anzahl der Teilnehmer angeben.
    • Falsch: Anwender können die Anzeigenanzahl der Teilnehmer nicht angeben.

    Datentyp: Boolesch

    Ergebnis.Anzeige_im_Namen_von Kennzeichnung, die angibt, ob Reservierungen im Namen einer anderen Person vorgenommen werden können.
    Gültige Werte:
    • Wahr: Im Namen von unterstützt.
    • Falsch: Im Namen von wird nicht unterstützt.

    Datentyp: Boolesch

    Ergebnis.Display_Sensitivity Kennzeichnung, die angibt, ob Anwender die Vertraulichkeit der Reservierung festlegen können, z. B. „Normal“ oder „Privat“.
    Gültige Werte:
    • Wahr: Empfindlichkeit kann festgelegt werden.
    • Falsch: Empfindlichkeit kann nicht festgelegt werden. Standardmäßig ist „Normal“ festgelegt.

    Datentyp: Boolesch

    Ergebnis.Anzeigewert Anzeigewert des reservierbaren Moduls.

    Datentyp: Zeichenfolge

    Ergebnis.enable_Browse_by_area Kennzeichnung, die angibt, ob Anwender nach Bereich nach reservierbaren Modulen suchen können. Identisch mit browse_by_area_enabled.
    Gültige Werte:
    • Wahr: Zulassen, dass Anwender reservierbare Module nach Bereich durchsuchen.
    • Falsch: Anwender dürfen reservierbare Module nicht nach Bereich durchsuchen.

    Datentyp: Boolesch

    Ergebnis.enable_Browse_by_Workspace Kennzeichnung, die angibt, ob Anwender nach Arbeitsbereich nach reservierbaren Modulen suchen können.
    Gültige Werte:
    • Wahr: Zulassen, dass Anwender reservierbare Module nach Arbeitsbereich durchsuchen können.
    • Falsch: Anwender dürfen reservierbare Module nicht nach Arbeitsbereich durchsuchen.

    Datentyp: Boolesch

    Ergebnis.enable_Browse_near_a_Person Kennzeichnung, die angibt, ob Anwender nach reservierbaren Modulen suchen können, die sich bei einer bestimmten Person befinden. Identisch mit browse_near_a_person_enabled.
    Gültige Werte:
    • Wahr: Zulassen, dass Anwender reservierbare Module in der Nähe einer Person durchsuchen können.
    • Falsch: Zulassen, dass Anwender reservierbare Module in der Nähe einer Person durchsuchen.

    Datentyp: Boolesch

    Ergebnis.enable_facet_Filter Kennzeichnung, die angibt, ob die Aspektfilterung für Arbeitsplatzelemente aktiviert ist. Wenn diese Option aktiviert ist, basieren die angezeigten Filteroptionen auf den Suchergebnissen. Nur die Elemente, die im generierten Suchergebnis verfügbar sind, stehen Benutzern zur Auswahl im Filter zur Verfügung.
    Gültige Werte:
    • Wahr: Aspektfilter sind aktiviert.
    • Falsch: Aspektfilter sind nicht aktiviert.

    Datentyp: Boolesch

    Ergebnis.enable_Group_Reservierungen Kennzeichnung, die angibt, ob Anwender eine Gruppenreservierung vornehmen können.
    Gültige Werte:
    • Wahr: Gruppenreservierungen möglich.
    • Falsch: Gruppenreservierungen können nicht vorgenommen werden.

    Datentyp: Boolesch

    Ergebnis.enable_ical_Generation Kennzeichnung, die angibt, ob Anwender einen iCalendar für die Reservierung generieren können.
    Gültige Werte:
    • Wahr: ICalendar-Generierung zulässig.
    • Falsch: ICalendar-Generierung ist nicht zulässig.

    Datentyp: Boolesch

    Ergebnis.font_Awesome_icon Name des Schriftartsymbols, das an das reservierbare Modul angehängt ist.

    Datentyp: Zeichenfolge

    result.inline_title Inline-Titel des reservierbaren Moduls. Der Titel wird entsprechend dem beschreibenden Text im Arbeitsplatzserviceportal angezeigt.

    Datentyp: Zeichenfolge

    Ergebnis.Layout_Mapping Details zur Struktur der Layoutzuordnung von Standorten. Verwenden Sie diese Daten, um die Informationen in der Anwenderoberfläche darzustellen.

    Datentyp: Objekt

    "layout_mapping": {
      "body": [Array],
      "description": [Array],
      "image": "String",
      "subtitle": [Array],
      "subtitle_asc": [Array],
      "title": [Array]
    }
    Ergebnis.Layout_Mapping.Textkörper Platzhalter für die Zuordnung der Front-End-UI-Daten.

    Datentyp: Array von Objekten

    "body": [
      {
        "field": "String",
        "field_to_display": "String",
        "icon": "String",
        "label": "String"
      }
    ]
    Ergebnis.Layout_Mapping.body.field Platzhalter für die Zuordnung der Front-End-UI-Daten.

    Datentyp: Zeichenfolge

    Ergebnis.Layout_Mapping.body.field_to_Display Platzhalter für die Zuordnung der Front-End-UI-Daten.

    Datentyp: Zeichenfolge

    Ergebnis.Layout_Mapping.body.icon Platzhalter für die Zuordnung der Front-End-UI-Daten.

    Datentyp: Zeichenfolge

    Ergebnis.Layout_Mapping.body.label Platzhalter für die Zuordnung der Front-End-UI-Daten.

    Datentyp: Zeichenfolge

    result.layout_mapping.description Platzhalter für die Zuordnung der Front-End-UI-Daten. Beschreibung der Layoutzuordnung.

    Datentyp: Array

    Ergebnis.Layout_Mapping.image Platzhalter für die Zuordnung der Front-End-UI-Daten.

    Datentyp: Zeichenfolge

    Ergebnis.Layout_Mapping.Untertitel Platzhalter für die Zuordnung der Front-End-UI-Daten.

    Datentyp: Array

    Ergebnis.Layout_Mapping.subtitle_asc Platzhalter für die Zuordnung der Front-End-UI-Daten.

    Datentyp: Array

    Ergebnis.Layout_Mapping.title Platzhalter für die Zuordnung der Front-End-UI-Daten.

    Datentyp: Array

    Ergebnis.max_Days_in_Future Maximale Anzahl der Tage in der Zukunft, an denen ein Anwender das reservierbare Modul reservieren kann.

    Datentyp: Zahl

    Ergebnis.max_vorkommen Maximale Anzahl wiederkehrender Reservierungsvorkommen, wenn wiederkehrende Reservierungen für das reservierbare Modul verfügbar sind.

    Datentyp: Zahl

    result.name Name des reservierbaren Moduls.

    Datentyp: Zeichenfolge

    Ergebnis.nbhBuildingIds Wird nur zurückgegeben, wenn das Platzmanagement-Plugin installiert ist browse_by_neighborhood_enabledParameter ist auf festgelegt Wahr , Und neighborhoodParameter wird in den Abfrageparametern übergeben.

    Liste der sys_IDs der Gebäude, die dem Modul „Reservierbar“ zugeordnet und für den Arbeitsbereich konfiguriert sind.

    Datentyp: Array von Zeichenfolgen

    Ergebnis.nbhBuildingsDaten Wird nur zurückgegeben, wenn das Platzmanagement-Plugin installiert ist browse_by_neighborhood_enabledParameter ist auf festgelegt Wahr , Und neighborhoodParameter wird in den Abfrageparametern übergeben.

    Liste der sys_IDs der Gebäude, die dem Modul „Reservierbar“ zugeordnet und für den Arbeitsbereich konfiguriert sind. Jedes Gebäudeelement enthält auch eine Liste von sys_IDs der entsprechenden Stockwerke, die für das Gebäude verfügbar sind.

    Zum Beispiel:

    "nbhBuildingsData": {
      "4703a4cedb3650106c731dcd13961945": [
        "0f9e304edb7650106c731dcd13961911"
      ],
      "6c0364cedb3650106c731dcd13961927": [
        "b23328cedb3650106c731dcd139619f9"
      ]
    }

    Datentyp: Array von Objekten

    Tabelle: Datensätze, die den sys_IDs des Gebäudes zugeordnet sind, befinden sich in der Tabelle „Gebäude“ [sn_wsd_Core_Building]. Datensätze, die den sys_IDs des Stockwerks zugeordnet sind, befinden sich in der Tabelle „Stockwerk“ [sn_wsd_Core_floor].

    Ergebnis.nbhBuildingsTreeData Wird nur zurückgegeben, wenn das Platzmanagement-Plugin installiert ist browse_by_neighborhood_enabledParameter ist auf festgelegt Wahr , Und neighborhoodParameter wird in den Abfrageparametern übergeben.

    Hierarchie der Gebäude, die dem reservierbaren Modul und dem Arbeitsbereich zugeordnet sind.

    Datentyp: Array von Objekten

    "buildingsTreeData": [
      {
        "children": [Array],
        "data": {Object},
        "isSelectable": Boolean,
        "isValid": Boolean,
        "label": "String",
        "uId": "String"
      }
    ]
    Hierarchiereihenfolge:
    • Region: Befindet sich in der Tabelle „Region“ [sn_wsd_Core_Region].
    • Site: Befindet sich in der Tabelle „Site“ [sn_wsd_Core_Site].
    • Campus: Befindet sich in der Tabelle „Campus“ [sn_wsd_Core_Campus].
    • Gebäude: Befindet sich in der Tabelle „Gebäude“ [sn_wsd_Core_Building].
    result.nbhBuildingsTreeData.children Beschreibt die Hierarchie der untergeordneten Elemente, die dem Gebäude zugeordnet sind.
    Jeweils Untergeordnete Elemente[] Knoten spiegelt eine andere Gebäudebene/Hierarchie wider:
    • BuildingsTreeData: Region
    • buildingsTreeData.children: Website
    • buildingsTreeData.children.children: Campus
    • buildingsTreeData.children.children.children: Gebäude

    Datentyp: Array von Objekten

    "children": [
      {
        "children": [Array],
        "data": {Object},
        "isSelectable": Boolean,
        "isValid": Boolean,
        "label": "String",
        "uId": "String"
      }
    ]

    Die Parameter in Untergeordnete Elemente[] Array sind mit denen in identisch nbhBuildingsTreeDataObjekt, nur für den zugehörigen Standorttyp: Region, Standort, Campus oder Gebäude.

    result.nbhBuildingsTreeData.data Details zur zugehörigen Entität: Region, Standort, Campus oder Gebäude.

    Datentyp: Objekt

    "data": {
      "sys_id": "String",
      "table": "String",
      "timezone": {Object}
    }
    Ergebnis.nbhBuildingsTreeData.Data.sysId SYS_ID des zugehörigen Entitätsdatensatzes.

    Datentyp: Zeichenfolge

    Ergebnis.nbhBuildingsTreeData.Data.table Tabelle, in der sich der zugeordnete Datensatz befindet.

    Datentyp: Zeichenfolge

    Ergebnis.nbhBuildingsTreeData.Data.timezone Informationen zur Zeitzone, in der sich die zugeordnete Entität befindet.

    Datentyp: Objekt

    "timezone": {
      "displayValue": "String",
      "value": "String"
    }
    Ergebnis.nbhBuildingsTreeData.Data.timezone.DisplayValue Zeitzonenwert, der in einer Anwenderoberfläche verwendet werden soll.

    Datentyp: Zeichenfolge

    Ergebnis.nbhBuildingsTreeData.Data.timezone.value Interner Zeitzonenwert.

    Datentyp: Zeichenfolge

    Ergebnis.nbhBuildingsTreeData.isAuswählbar Kennzeichnung, die angibt, ob die zugeordnete Entität für das reservierbare Modell verfügbar (auswählbar) ist.
    Gültige Werte:
    • Wahr: Entität ist für das reservierbare Modul verfügbar.
    • Falsch: Entität ist für das reservierbare Modul nicht verfügbar.

    Datentyp: Boolesch

    Ergebnis.nbhBuildingsTreeData.isValid Kennzeichnung, die angibt, ob die zugeordnete Entität für das reservierbare Modell gültig ist.
    Gültige Werte:
    • Wahr: Entität ist für das reservierbare Modul gültig.
    • Falsch: Entität ist für das reservierbare Modul nicht gültig.

    Datentyp: Boolesch

    Ergebnis.nbhBuildingsTreeData.label Name der reservierbaren Ansicht.

    Datentyp: Zeichenfolge

    Ergebnis.nbhBuildingsTreeData.UID SYS_ID der zugeordneten Entität.

    Datentyp: Zeichenfolge

    Ergebnis.Override_Approval_Policy Option zum Festlegen, wie die Genehmigungsrichtlinie zu implementieren ist.
    Auswahlmöglichkeiten:
    • Keine Überschreibung: Die Genehmigungsrichtlinie wird wie in festgelegt implementiert Erfordert Genehmigung Feld eines Arbeitsplatzbereichs oder -Raums.
    • Genehmigung immer erforderlich: Die Genehmigungsrichtlinie ist unabhängig davon erforderlich, was in festgelegt ist Erfordert Genehmigung Feld eines Arbeitsplatzbereichs oder -Raums.
    • Keine Genehmigung erforderlich: Die Genehmigungsrichtlinie wird unabhängig davon entfernt, was in festgelegt ist Erfordert Genehmigung l-Feld eines Arbeitsplatzbereichs oder -Raums.

    Datentyp: Zeichenfolge

    Ergebnis.require_Cancel_Notes Kennzeichnung, die angibt, ob Anwender eine Stornierungsnotiz eingeben müssen, bevor sie ein reservierbares Modul stornieren.
    Gültige Werte:
    • Wahr: Stornierungsnotiz erforderlich.
    • Falsch: Stornierungsnotiz nicht erforderlich.

    Datentyp: Boolesch

    Ergebnis.require_cc_dept_Check Kennzeichnung, die angibt, ob überprüft werden soll, ob zwischen dem Arbeitsbereichselement und dem angemeldeten Anwender eine Kostenstelle oder eine Abteilungskonflikt besteht.
    Gültige Werte:
    • Wahr: Auf Nichtübereinstimmung prüfen.
    • Falsch: Überprüfen Sie nicht auf eine Nichtübereinstimmung.

    Datentyp: Boolesch

    Ergebnis.require_subject Kennzeichnung, die angibt, ob der Anwender bei der Reservierung einen Betreff eingeben muss.
    Gültige Werte:
    • Wahr: Betreff erforderlich.
    • Falsch: Betreff ist nicht erforderlich.

    Datentyp: Boolesch

    Ergebnis.reservierbare_Spalten Liste der Spalten eines reservierbaren Elements.

    Datentyp: Array

    Tabelle: Arbeitsplatzstandort [sn_wsd_Core_Workplace_location]

    Ergebnis.reservierbar_Container_field Ebene des Containers, z. B. eine Gruppe von Schreibtischen in einem bestimmten Bereich.

    Datentyp: Zeichenfolge

    Ergebnis.reservierbar_Filter Filterbedingungen, die zum Herausfiltern reservierbarer Elemente in der zugehörigen Tabelle „reservierbar“ verwendet werden. Die Tabelle „Reservierbar“ ist ein Feld in der Tabelle „Reservierbares Modul“ [sn_wsd_rsv_reservable_Module]. Diese Filterbedingungen wurden auf die Tabelle in der Tabelle „Reservierbar“ angewendet.

    Datentyp: Zeichenfolge

    Ergebnis.reservierbar_Quantity_field Die reservierbare Menge aller Arbeitsbereiche. Die Menge wird verwendet, wenn einem Bereich Nachbarschaftsbereiche zugewiesen werden. Weitere Informationen finden Sie unter Weisen Sie einem Bereich Arbeitsbereiche zu .

    Datentyp: Zeichenfolge

    Ergebnis.reservierbar_Tabelle Tabelle, die die reservierbaren Arbeitsplatzelemente enthält.

    Datentyp: Zeichenfolge

    Ergebnis.reservierbar_Typ Typ des reservierbaren Elements, z. B. Standort.

    Datentyp: Zeichenfolge

    Ergebnis.reservierbare_Ansichten Details zu den verschiedenen Ansichten, die dem reservierbaren Modul zugeordnet sind, z. B. Kartenansicht oder Zeitplanansicht.

    Datentyp: Objekt

    "reservable_views": {
      "iconClass": "String",
      "isDefault": Boolean,
      "label": "String",
      "order": Number,
      "type": "String"
    }

    Tabelle: Reservierbare Ansicht [sn_wsd_rsv_reservable_View]

    Ergebnis.reservierbar_Ansichten.SymbolKlasse Symbolklasse der reservierbaren Ansicht.

    Datentyp: Zeichenfolge

    Ergebnis.reservierbar_Ansichten.isStandard Kennzeichnung, die angibt, ob diese reservierbare Ansicht als Standard für reservierbare Module festgelegt werden soll.
    Gültige Werte:
    • Wahr: Als Standard festlegen.
    • Falsch: Nicht als Standard festlegen.

    Datentyp: Boolesch

    Ergebnis.reservierbar_Ansichten.Bezeichnung Name der reservierbaren Ansicht.

    Datentyp: Zeichenfolge

    Ergebnis.reservierbar_Ansichten.Auftrag Reihenfolge, in der die Ansichten für das reservierbare Modul in der Anwenderoberfläche angezeigt werden. Die untere Reihenfolgenummer steht in der Anwenderoberfläche an erster Stelle. Bei derselben Ordnungsnummer wird ihr eine zufällige Reihenfolge zugewiesen.

    Datentyp: Zahl

    Ergebnis.reservierbar_Ansichten.Typ Back-End-Name der reservierbaren Ansicht. Wird für die interne Verarbeitung verwendet.

    Datentyp: Zeichenfolge

    Ergebnis.reservation_Pfade Reservierungspfade, die den reservierbaren Modulen zugeordnet sind, z. B. alle durchsuchen, in der Nähe einer Person suchen.

    Datentyp: Array von Objekten

    "reservation_paths": [
      {
        "displayValue": "String",
        "value": "String"
      }
    ]
    Ergebnis.reservation_Pfade.Anzeigewert Anzeigewert für den Reservierungspfad, z. B. „in der Nähe einer Person suchen“.

    Datentyp: Zeichenfolge

    Ergebnis.reservation_Pfade.Wert Interner Wert für den Reservierungspfad, z. B. „Browse_near_a_Person“.

    Datentyp: Zeichenfolge

    result.search_limit Maximale Anzahl von Suchergebnissen, die zurückgegeben werden sollen, wenn ein Anwender nach einem Arbeitsplatzstandort sucht.

    Datentyp: Zahl

    result.selection_type

    Der Typ der Auswahl, die in den Suchergebnissen angezeigt werden soll.

    Kann eine der folgenden Optionen sein:
    • Bestimmte Einheit: Das Suchergebnis zeigt alle Arbeitsplatzelemente an.
    • Container: Das Suchergebnis zeigt das übergeordnete Element oder den Container der Arbeitsplatzelemente an.

    Datentyp: Zeichenfolge

    Ergebnis.Kurzbeschreibung Kurze Beschreibung des reservierbaren Moduls.

    Datentyp: Zeichenfolge

    Ergebnis.Show_Map_View Kennzeichnung, die angibt, ob die Kartenansicht für reservierbare Module aktiviert werden soll.
    Gültige Werte:
    • Wahr: Kartenansicht aktivieren.
    • Falsch: Kartenansicht nicht aktivieren.

    Datentyp: Boolesch

    Ergebnis.sys_ID SYS_ID des reservierbaren Moduls.

    Datentyp: Zeichenfolge

    Ergebnis.Zeitfenster Details zu den Zeitfenstern, die einem reservierbaren Modul zugeordnet sind.

    Datentyp: Array von Objekten

    [
      {
        "name": "String",
        "short_description": "String",
        "slot_end": "String",
        "slot_start": "String",
        "sys_id": "String"
      }
    ]
    result.timeSlots.name Name des Zeitfensters.

    Datentyp: Zeichenfolge

    Ergebnis.Zeitfenster.short_description Kurze Beschreibung des Zeitfensters.

    Datentyp: Zeichenfolge

    Ergebnis.Zeitfenster.Slot_End Endzeit des Zeitfensters.

    Datentyp: Zeichenfolge

    Ergebnis.Zeitfenster.Slot_Start Startzeit des Zeitfensters.

    Datentyp: Zeichenfolge

    Ergebnis.Zeitfenster.sys_ID SYS_ID des Zeitfenster-Datensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Zeitfenster [sn_wsd_rsv_time_Slot]

    Ergebnis.Titel Titel des reservierbaren Moduls.

    Datentyp: Zeichenfolge

    Ergebnis.Virtual_Meeting_Provider Details zum virtuellen Anbieter, der dem reservierbaren Modul zugeordnet ist.

    Datentyp: Objekt

    "virtual_meeting_provider": {
      "display_value": "String",
      "sys_id": "String"
    }
    Ergebnis.Virtual_Meeting_Provider.Display_value Anzeigewert des Anbieters der virtuellen Besprechung.

    Datentyp: Zeichenfolge

    Ergebnis.Virtual_Meeting_Provider.sys_ID SYS_ID des Anbieters der virtuellen Besprechung.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Dieses Codebeispiel zeigt, wie ein reservierbares Modul mit den Gebäudestrukturdaten angefordert wird.

    curl "http://instance.servicenow.com/api/sn_wsd_rsv/reservable_module/5db44502dbb650106c731dcd13961937&is_buildings_tree_data_required=true" \
    --request GET \
    --header "Accept:application/json" \
    --user "username":"password"

    Antworttext:

    {
      "result": {
        "sys_id": "5db44502dbb650106c731dcd13961937", "name": "Desks",
        "title": "Desks",
        "inline_title": "desk",
        "font_awesome_icon": "fa-desktop",
        "reservable_table": "sn_wsd_core_space",
        "reservable_filter": "active=true^is_reservable=true^location_type=5f017383eb512010b89bfdfc9c5228c8^building.is_reservable=true^floor.is_reservable=true^EQ",
        "short_description": "Reserve a single desks",
        "reservable_type": "location",
        "require_subject": null,
        "require_cancel_notes": false,
        "virtual_meeting_provider": {
          "sys_id": "e33d9e6853c201103cf7ddeeff7b1205",
          "display_value": "Template"
        },
        "allow_invitees": null,
        "display_number_of_attendees": null,
        "display_on_behalf_of": null,
        "display_sensitivity": null,
        "max_days_in_future": "90",
        "allow_whole_day": "1",
        "selection_type": "unit",
        "reservable_container_field": null,
        "reservable_quantity_field": null,
        "apply_to_shift": null,
        "max_occurrences": "90",
        "enable_facet_filter": false,
        "search_limit": 10000,
        "enable_ical_generation": null,
        "enable_group_reservations": null,
        "enable_browse_near_a_person": "1",
        "enable_browse_by_area": "1",
        "enable_browse_by_neighborhood": "1",
        "show_map_view": false,
        "require_cc_dept_check": false,
        "display_value": "Desks",
        "browse_near_a_person_enabled": true,
        "browse_by_area_enabled": true,
        "browse_by_neighborhood_enabled": true,
        "reservable_columns": [
          "sys_id",
          "external_id",
          "email",
          "name",
          "title",
          "description",
          "image",
          "number",
          "site",
          "campus",
          "building",
          "floor",
          "area",
          "capacity",
          "reservable_quantity",
          "location_type",
          "order",
          "requires_check_in",
          "is_reservable"
        ],
        "layout_mapping": { 
          "title": [
            "name"
          ],
          "description": [ 
            "description"
          ],
          "subtitle": [
            "campus",
            "building",
            "floor",
            "area"
          ],
          "subtitle_asc": [
            "area",
            "floor",
            "building",
            "campus"
          ],
          "image": "image",
          "body": [
            {
              "label": "Capacity",
              "icon": "fa-users",
              "field": "capacity",
              "field_to_display": ""
            },
            {
              "label": "Standard services",
              "icon": "fa-check",
              "field": "standard_services",
              "field_to_display": "name"
            },
            {
              "label": "Reservable purposes",
              "icon": "fa-tags",
              "field": "reservable_purposes",
              "field_to_display": "name"
            }
          ]
        },
        "timeSlots": [
          {
            "sys_id": "d5331cf2dbb5f01038e42b24ca961906",
            "name": "All day",
            "short_description": "8am - 6pm",
            "slot_start": "08:00",
            "slot_end": "18:00"
          },
          {
            "sys_id": "de131cf2dbb5f01038e42b24ca961931",
            "name": "Before noon",
            "short_description": "8am - 12pm",
            "slot_start": "08:00",
            "slot_end": "12:00"
          },
          {
            "sys_id": "6e99ab5ddbb930102e8e853e68961929",
            "name": "After noon",
            "short_description": "1pm - 6pm",
            "slot_start": "13:00",
            "slot_end": "18:00"
          }
        ],
        "buildingSysIds": [
          "9e0364cedb3650106c731dcd1396192b"
        ],
        "buildingsTreeData": [
          {
            "isValid": true,
            "label": "Europe",
            "uId": "2d626c4edb3650106c731dcd1396194b",
            "isSelectable": false,
            "children": [
              {
                "isValid": true,
                "label": "Western Europe",
                "uId": "b17220cedb3650106c731dcd1396197a",
                "isSelectable": false,
                "children": [
                  {
                    "isValid": true,
                    "label": "Amsterdam Campus",
                    "uId": "44d2e0cedb3650106c731dcd13961988",
                    "isSelectable": false,
                    "children": [
                      {
                        "isValid": true,
                        "label": "AMS-B1",
                        "uId": "9e0364cedb3650106c731dcd1396192b",
                        "isSelectable": true,
                        "children": [],
                        "data": {
                          "sysId": "9e0364cedb3650106c731dcd1396192b",
                          "table": "sn_wsd_core_building",
                          "timezone": {
                            "value": "Europe/Amsterdam",
                            "displayValue": "Europe/Amsterdam"
                          }
                        }
                      }
                    ],
                    "data": {
                      "sysId": "44d2e0cedb3650106c731dcd13961988",
                      "table": "sn_wsd_core_campus",
                      "timezone": null
                    }
                  }
                ],
                "data": {
                  "sysId": "b17220cedb3650106c731dcd1396197a",
                  "table": "sn_wsd_core_site",
                  "timezone": null
                }
              }
            ],
            "data": {
              "sysId": "2d626c4edb3650106c731dcd1396194b",
              "table": "sn_wsd_core_region",
              "timezone": null
            }
          }
        ],
        "reservable_views": [
          {
            "type": "card",
            "label": "Card view",
            "iconClass": "fa-th-large",
            "isDefault": true,
            "order": "1"
          },
          {
            "type": "schedule",
            "label": "Schedule view",
            "iconClass": "fa-calendar-o",
            "isDefault": false,
            "order": "2"
          }
        ],
        "checkin_before_minutes": 30,
        "reservation_paths": [
          {
            "value": "browse_all",
            "displayValue": "Browse all"
          },
          {
            "value": "browse_near_a_person",
            "displayValue": "Browse near a person"
          },
          {
            "value": "browse_by_area",
            "displayValue": "Browse by area"
          }
        ],
        "override_approval_policy": "never_required"
      }
    }