WSD Reservierbare Modul-API

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 15 Minuten Lesedauer
  • Die Workplace Service Delivery (WSD) Reservable Module- API ruft Details eines reservierbaren Moduls aus einer ServiceNow -Instanz ab.

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

    Für den Zugriff auf diese API muss der Aufrufer ü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 im Namespace sn_wsd_rsv ausgeführt.

    Weitere Informationen zu Workplace Reservation Managementfinden Sie unter Workplace Reservation Management.

    WSD Reservierbares Modul – GET /sn_wsd_rsv/reservable_module/{sys_id}

    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}

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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 umkehrbaren Moduldatensatzes. Befindet sich in der Tabelle „Reservierbares Modul“ [sn_wsd_rsv_reservable_module].

    Datentyp: Zeichenfolge

    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    is_buildings_tree_data_required Kennzeichnung, die angibt, ob die dem reservierbaren Modell zugeordneten Gebäudedaten zurückgegeben werden sollen.
    Gültige Werte:
    • true: Gebäudedaten zurückgeben.
    • false: Gebäudedaten nicht zurückgeben.

    Datentyp: Boolesch

    Standardwert: false

    Arbeitsbereich

    Nur verfügbar, wenn das Plugin „Space Management“ (sn_wsd_spc_mgmt_neight) aktiviert ist.

    Sys_id des Arbeitsbereichsdatensatzes, der in der codierten Abfrage verwendet werden soll. Befindet sich in der Tabelle „Arbeitsbereich“ [sn_wsd_spcmgmt_neight

    Weitere Informationen zu Bereichsreservierungen in der Nähe finden Sie unter Create neighborhood reservations.

    Der Endpunkt überprüft, ob die Umgebung gültig ist, und ruft dann die Daten ab, die für den Pfad zum Durchsuchen nach Umgebung 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 HTTP-Antwortcodesder REST-API.

    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.

    Antworttextparameter (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}
      }
    }
    result.allow_invitees Kennzeichnung, die angibt, ob Mitarbeiter der Reservierung eingeladene Personen hinzufügen können.
    Gültige Werte:
    • true: Erlaubt Mitarbeitern, eingeladene Personen zur Reservierung hinzuzufügen.
    • false: Mitarbeiter dürfen der Reservierung keine eingeladenen Personen hinzufügen.

    Datentyp: Boolesch

    result.allow_whol_day Kennzeichnung, die angibt, ob Benutzer das reservierbare Element für den gesamten Tag reservieren können.
    Gültige Werte:
    • true: Erlaubt Benutzern, für den gesamten Tag zu reservieren.
    • false: Benutzer können nicht für den gesamten Tag reservieren.

    Datentyp: Boolesch

    result.apply_to_shift Kennzeichnung, die angibt, ob schichtbasierte Reservierungen für das reservierbare Modul aktiviert sind.
    Gültige Werte:
    • true: Schichtbasierte Reservierungen zulassen.
    • false: Schichtbasierte Reservierungen nicht zulassen.

    Datentyp: Boolesch

    result.browse_by_area_enabled Kennzeichnung, die angibt, ob Benutzer nach reservierbaren Modulen nach Bereich suchen können.
    Gültige Werte:
    • true: Ermöglicht Benutzern das Durchsuchen reservierbarer Module nach Bereich.
    • false: Benutzer können reservierbare Module nicht nach Bereich durchsuchen.

    Datentyp: Boolesch

    result.browse_by_neight_enabled Nur verfügbar, wenn das Plugin „Space Management – sn_wsd_spc_mgmt“ installiert ist.

    Kennzeichnung, die angibt, ob Benutzer in den reservierbaren Modulen nach Arbeitsbereichen suchen können.

    Gültige Werte:
    • true: Ermöglicht Benutzern das Durchsuchen reservierbarer Module nach Arbeitsbereich.
    • false: Benutzer können reservierbare Module nicht nach Arbeitsbereichen durchsuchen.

    Datentyp: Boolesch

    result.browse_near_a_person_enabled Kennzeichnung, die angibt, ob Benutzer nach reservierbaren Modulen suchen können, die von einer bestimmten Person gefunden wurden.
    Gültige Werte:
    • true: Ermöglicht Benutzern das Durchsuchen reservierbarer Module in der Nähe einer Person.
    • false: Benutzer können keine reservierbaren Module in der Nähe einer Person durchsuchen.

    Datentyp: Boolesch

    result.buildingTreeData Wird nur zurückgegeben, wenn der Abfrageparameter is_buildings_tree_data_required auf truefestgelegt ist. Hierarchie der Gebäude, die dem reservierbaren Modul 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 Gebäudetabelle [sn_wsd_core_building].
    Jeder untergeordnete Knoten [ ] spiegelt eine andere Gebäudeebene/-hierarchie wider:
    • buildingsTreeData: Region
    • buildingsTreeData.child: Site
    • 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.child Details zum Standort, Campus oder Gebäude, das dem reservierbaren Modul zugeordnet ist. Alle Parameter in allen untergeordneten Knoten [ ] sind identisch. Sie gelten nur für verschiedene Gebäudeentitäten und werden in diesem Abschnitt nur einmal 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.child.data.sys_id Sys_id der zugeordneten Gebäudeentität.

    Datentyp: Zeichenfolge

    result.buildingsTreeData.untergeordnete Elemente.Daten.Tabelle Name der Tabelle, in der sich der in der sys_id identifizierte Gebäudeentitätsdatensatz befindet.

    Datentyp: Zeichenfolge

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

    Datentyp: Zeichenfolge

    result.buildingsTreeData.child.data.​timezone.value Interner Wert im Datensatz für die Zeitzone.

    Datentyp: Zeichenfolge

    result.buildingsTreeData.childes.isSelectable Kennzeichnung, die angibt, ob die zugeordnete Gebäudeentität für das reservierbare Modell verfügbar (auswählbar) ist.
    Gültige Werte:
    • true: Gebäudeentität ist für das reservierbare Modul verfügbar.
    • false: Gebäudeentität ist für das reservierbare Modul nicht verfügbar.

    Datentyp: Boolesch

    result.buildingsTreeData.childes.isValid Kennzeichnung, die angibt, ob die zugeordnete Gebäudeentität für das reservierbare Modell gültig ist.
    Gültige Werte:
    • true: Gebäudeentität ist für das reservierbare Modul gültig.
    • „false“: Gebäudeentität ist für das reservierbare Modul nicht gültig.

    Datentyp: Boolesch

    result.buildingsTreeData.untergeordnete Elemente.bezeichnung Name der Gebäudeentität.

    Datentyp: Zeichenfolge

    result.buildingsTreeData.untergeordnete Elemente.uId Sys_id des zugeordneten Gebäudeentitätsdatensatzes.

    Datentyp: Zeichenfolge

    result.buildingSysIds Liste der sys_ids der Gebäude, die dem reservierbaren Modul zugeordnet sind.

    Datentyp: Array von Zeichenfolgen

    result.checkin_before_minutes Zeitraum vor Beginn einer Reservierung, in dem ein Benutzer in seine Reservierung einchecken kann.

    Einheit: Minuten

    Datentyp: Zahl

    result.display_number_of_attendees Kennzeichnung, die angibt, ob Benutzer die Anzahl der Teilnehmer in der Reservierung angeben können.
    Gültige Werte:
    • true: Benutzer können die Anzahl der Teilnehmer angeben.
    • false: Benutzer können die angezeigte Anzahl der Teilnehmer nicht angeben.

    Datentyp: Boolesch

    result.display_on_behalb_von Kennzeichnung, die angibt, ob Reservierungen im Namen einer anderen Person vorgenommen werden können.
    Gültige Werte:
    • true: Im Auftrag von unterstützt.
    • false: Im Namen von nicht unterstützt.

    Datentyp: Boolesch

    result.display_sensitivity Kennzeichnung, die angibt, ob Benutzer die Vertraulichkeit der Reservierung festlegen können, z. B. „Normal“ oder „Privat“.
    Gültige Werte:
    • true: Empfindlichkeit kann festgelegt werden.
    • false: Empfindlichkeit kann nicht festgelegt werden. Der Standardwert ist „Normal“.

    Datentyp: Boolesch

    result.display_value Anzeigewert des reservierbaren Moduls.

    Datentyp: Zeichenfolge

    result.enable_browse_by_area Kennzeichnung, die angibt, ob Benutzer nach reservierbaren Modulen nach Bereich suchen können. Identisch mit browse_by_area_enabled.
    Gültige Werte:
    • true: Ermöglicht Benutzern das Durchsuchen reservierbarer Module nach Bereich.
    • false: Benutzer können reservierbare Module nicht nach Bereich durchsuchen.

    Datentyp: Boolesch

    result.enable_browse_by_neight Kennzeichnung, die angibt, ob Benutzer nach reservierbaren Modulen nach Arbeitsbereichen suchen können.
    Gültige Werte:
    • true: Ermöglicht Benutzern das Durchsuchen reservierbarer Module nach Arbeitsbereich.
    • false: Benutzer können reservierbare Module nicht nach Arbeitsbereichen durchsuchen.

    Datentyp: Boolesch

    result.enable_browse_near_a_person Kennzeichnung, die angibt, ob Benutzer nach reservierbaren Modulen suchen können, die von einer bestimmten Person gefunden wurden. Identisch mit browse_near_a_person_enabled.
    Gültige Werte:
    • true: Ermöglicht Benutzern das Durchsuchen reservierbarer Module in der Nähe einer Person.
    • false: Benutzer können keine reservierbaren Module in der Nähe einer Person durchsuchen.

    Datentyp: Boolesch

    result.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:
    • true: Aspektfilter sind aktiviert.
    • false: Aspektfilter sind nicht aktiviert.

    Datentyp: Boolesch

    result.enable_group_reservations Kennzeichnung, die angibt, ob Benutzer eine Gruppenreservierung vornehmen können.
    Gültige Werte:
    • true: Gruppenreservierungen möglich.
    • false: Gruppenreservierungen können nicht vorgenommen werden.

    Datentyp: Boolesch

    result.enable_ical_generation Kennzeichnung, die angibt, ob Benutzer einen iCalendar für die Reservierung generieren können.
    Gültige Werte:
    • true: iCalendar-Generierung zulässig.
    • false: iCalendar-Generierung ist nicht zulässig.

    Datentyp: Boolesch

    result.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 in Übereinstimmung mit dem beschreibenden Text im Workplace Service Portal angezeigt.

    Datentyp: Zeichenfolge

    result.layout_mapping Details zur Struktur der Layoutzuordnung von Standorten. Verwenden Sie diese Daten, um die Informationen in der Benutzeroberfläche zu gestalten.

    Datentyp: Objekt

    "layout_mapping": {
      "body": [Array],
      "description": [Array],
      "image": "String",
      "subtitle": [Array],
      "subtitle_asc": [Array],
      "title": [Array]
    }
    result.layout_mapping.body 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"
      }
    ]
    result.layout_mapping.body.field Platzhalter für die Zuordnung der Front-End-UI-Daten.

    Datentyp: Zeichenfolge

    result.layout_mapping.body.field_to_display Platzhalter für die Zuordnung der Front-End-UI-Daten.

    Datentyp: Zeichenfolge

    result.layout_mapping.body.icon Platzhalter für die Zuordnung der Front-End-UI-Daten.

    Datentyp: Zeichenfolge

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

    result.layout_mapping.image Platzhalter für die Zuordnung der Front-End-UI-Daten.

    Datentyp: Zeichenfolge

    result.layout_mapping.subtitle Platzhalter für die Zuordnung der Front-End-UI-Daten.

    Datentyp: Array

    result.layout_mapping.subtitle_asc Platzhalter für die Zuordnung der Front-End-UI-Daten.

    Datentyp: Array

    result.layout_mapping.title Platzhalter für die Zuordnung der Front-End-UI-Daten.

    Datentyp: Array

    result.max_days_in_zukünftig Maximale Anzahl der Tage in der Zukunft, für die ein Benutzer das reservierbare Modul reservieren kann.

    Datentyp: Zahl

    result.max_occurrences Maximale Anzahl wiederkehrender Reservierungen, wenn wiederkehrende Reservierungen für das reservierbare Modul verfügbar sind.

    Datentyp: Zahl

    result.name Name des reservierbaren Moduls.

    Datentyp: Zeichenfolge

    result.nbhBuildingIds Wird nur zurückgegeben, wenn das Plugin „Space Management“ installiert ist, der Parameter browse_by_neighborhood_enabled auf „ true“ festgelegt ist und der Parameter neighborhood in den Abfrageparametern übergeben wird.

    Liste der sys_ids der Gebäude, die dem reservierbaren Modul zugeordnet und für den Arbeitsbereich konfiguriert sind.

    Datentyp: Array von Zeichenfolgen

    result.nbhBuildingsData Wird nur zurückgegeben, wenn das Plugin „Space Management“ installiert ist, der Parameter browse_by_neighborhood_enabled auf „ true“ festgelegt ist und der Parameter neighborhood in den Abfrageparametern übergeben wird.

    Liste der sys_ids der Gebäude, die dem reservierbaren Modul 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.

    Beispiel:

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

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

    Datentyp: Array von Objekten

    result.nbhBuildingsTreeData Wird nur zurückgegeben, wenn das Plugin „Space Management“ installiert ist, der Parameter browse_by_neighborhood_enabled auf „ true“ festgelegt ist und der Parameter neighborhood in den Abfrageparametern übergeben wird.

    Hierarchie der Gebäude, die dem reservierbaren Modul und 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 Gebäudetabelle [sn_wsd_core_building].
    result.nbhBuildingsTreeData.child Beschreibt die Hierarchie der untergeordneten Elemente, die dem Gebäude zugeordnet sind.
    Jeder untergeordnete [] Knoten spiegelt eine andere Gebäudeebene/-hierarchie wider:
    • buildingsTreeData: Region
    • buildingsTreeData.child: Site
    • BuildingsTreeData.Children.Children: Campus
    • BuildingsTreeData.Children.Children.Children: Gebäude

    Datentyp: Array

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

    Die Parameter im Array child[] sind die gleichen wie im Objekt nbhBuildingsTreeData, nur für den zugeordneten Standorttyp. Region, Standort, Campus oder Gebäude.

    result.nbhBuildingsTreeData.data Details zur zugeordneten Entität; Region, Standort, Campus oder Gebäude.

    Datentyp: Objekt

    "data": {
      "sys_id": "String",
      "table": "String",
      "timezone": {Object}
    }
    result.nbhBuildingsTreeData.data.sysId Sys_id des zugeordneten Entitätsdatensatzes.

    Datentyp: Zeichenfolge

    result.nbhBuildingsTreeData.data.tabelle Tabelle, in der sich der zugeordnete Datensatz befindet.

    Datentyp: Zeichenfolge

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

    Datentyp: Objekt

    "timezone": {
      "displayValue": "String",
      "value": "String"
    }
    result.nbhBuildingsTreeData.data.timezone.displayValue Zeitzonenwert, der in einer Benutzeroberfläche verwendet werden soll.

    Datentyp: Zeichenfolge

    result.nbhBuildingsTreeData.data.timezone.value Interner Zeitzonenwert.

    Datentyp: Zeichenfolge

    result.nbhBuildingsTreeData.isSelectable Kennzeichnung, die angibt, ob die zugeordnete Entität für das reservierbare Modell verfügbar (auswählbar) ist.
    Gültige Werte:
    • true: Entität ist für das reservierbare Modul verfügbar.
    • false: Entität ist für das reservierbare Modul nicht verfügbar.

    Datentyp: Boolesch

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

    Datentyp: Boolesch

    result.nbhBuildingsTreeData.label Name der reservierbaren Ansicht.

    Datentyp: Zeichenfolge

    result.nbhBuildingsTreeData.uId Sys_id der zugeordneten Entität.

    Datentyp: Zeichenfolge

    result.override_approval_policy Option zum Festlegen, wie die Genehmigungsrichtlinie zu implementieren ist. Die Auswahlmöglichkeiten lauten wie folgt:
    • Keine Überschreibung: Die Genehmigungsrichtlinie wird implementiert, wie im Feld Genehmigung erforderlich für einen Arbeitsplatzbereich oder -raum festgelegt.
    • Genehmigung immer erforderlich: Die Genehmigungsrichtlinie ist unabhängig von der Einstellung im Feld Genehmigung erforderlich für einen Arbeitsplatzbereich oder -raum erforderlich.
    • Genehmigung nie erforderlich: Die Genehmigungsrichtlinie wird unabhängig von der Einstellung im Feld Genehmigung erforderlichl für einen Arbeitsplatzbereich oder -raum entfernt.

    Datentyp: Zeichenfolge

    result.require_cancel_notes Kennzeichnung, die angibt, ob Benutzer eine Stornierungsnotiz eingeben müssen, bevor sie ein reservierbares Modul stornieren.
    Gültige Werte:
    • true: Stornierungshinweis erforderlich.
    • false: Stornierungshinweis nicht erforderlich.

    Datentyp: Boolesch

    result.require_cc_dept_check Kennzeichnung, die angibt, ob zwischen dem Arbeitsbereichselement und dem angemeldeten Benutzer eine Kostenstelle oder Abteilungsabweichung besteht.
    Gültige Werte:
    • true: Auf Nichtübereinstimmung prüfen.
    • false: Nicht auf Nichtübereinstimmung prüfen.

    Datentyp: Boolesch

    result.require_subject Kennzeichnung, die angibt, ob der Benutzer bei der Reservierung einen Betreff eingeben muss.
    Gültige Werte:
    • true: Betreff erforderlich.
    • false: Betreff ist nicht erforderlich.

    Datentyp: Boolesch

    result.reservable_columns Liste der Spalten eines reservierbaren Elements. Befindet sich in der Tabelle „Arbeitsplatzstandort“ [sn_wsd_core_workplace_location].

    Datentyp: Array

    result.reservable_container_field Ebene des Containers, z. B. eine Gruppe von Schreibtischen in einem bestimmten Bereich.

    Datentyp: Zeichenfolge

    result.reservable_filter Filterbedingungen, die verwendet werden, um reservierbare Elemente in der zugehörigen Tabelle „Reservierbar“ herauszufiltern. Die Tabelle „Reservierbar“ ist ein Feld in der Tabelle „Reservierbares Modul“ [sn_wsd_rsv_reservable_module]. Diese Filterbedingungen wurden auf die Tabelle angewendet, die im Feld Reservierbare Tabelle enthalten ist.

    Datentyp: Zeichenfolge

    result.reservable_quantity_field Die reservierbare Menge aller Arbeitsbereiche. Die Menge wird verwendet, wenn einem Bereich angrenzende Arbeitsbereiche zugewiesen werden. Weitere Informationen finden Sie unter Aneinander angrenzende Bereiche einem Bereich zuweisen.

    Datentyp: Zeichenfolge

    result.reservable_table Tabelle, die die reservierbaren Arbeitsplatzelemente enthält.

    Datentyp: Zeichenfolge

    result.reservable_type Typ des reservierbaren Elements, z. B. Standort.

    Datentyp: Zeichenfolge

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

    Befindet sich in der Tabelle „Reservierbare Ansicht“ [sn_wsd_rsv_reservable_view].

    Datentyp: Objekt

    "reservable_views": {
      "iconClass": "String",
      "isDefault": Boolean,
      "label": "String",
      "order": Number,
      "type": "String"
    }
    result.reservable_views.iconClass Symbolklasse der reservierbaren Ansicht.

    Datentyp: Zeichenfolge

    result.reservable_views.isDefault Kennzeichnung, die angibt, ob diese reservierbare Ansicht als Standard für reservierbare Module festgelegt werden soll.
    Gültige Werte:
    • true: Als Standard festlegen.
    • false: Nicht als Standard festlegen.

    Datentyp: Boolesch

    result.reservable_views.label Name der reservierbaren Ansicht.

    Datentyp: Zeichenfolge

    result.reservable_views.order Reihenfolge, in der die Ansichten für das reservierbare Modul in der Benutzeroberfläche angezeigt werden. Die niedrigere Ordnungszahl kommt in der Benutzeroberfläche zuerst. Bei gleicher Reihenfolgennummer wird eine zufällige Reihenfolge zugewiesen.

    Datentyp: Zahl

    result.reservable_views.type Back-End-Name der reservierbaren Ansicht. Wird für die interne Verarbeitung verwendet.

    Datentyp: Zeichenfolge

    result.reservation_paths 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"
    }
    result.reservation_paths.displayValue Anzeigewert für den Reservierungspfad, z. B. „In der Nähe einer Person suchen“.

    Datentyp: Zeichenfolge

    result.reservation_paths.value Interner Wert für den Reservierungspfad, z. B. „browse_near_a_person“.

    Datentyp: Zeichenfolge

    result.search_limit Maximale Anzahl der Suchergebnisse, die zurückgegeben werden sollen, wenn ein Benutzer nach einem Arbeitsplatzstandort sucht.

    Datentyp: Zahl

    result.selection_type

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

    Dies 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

    result.short_description Kurze Beschreibung des reservierbaren Moduls.

    Datentyp: Zeichenfolge

    result.show_map_view Kennzeichnung, die angibt, ob die Zuordnungsansicht für reservierbare Module aktiviert werden soll.
    Gültige Werte:
    • true: Kartenansicht aktivieren.
    • false: Kartenansicht nicht aktivieren.

    Datentyp: Boolesch

    result.sys_id Sys_id des reservierbaren Moduls.

    Datentyp: Zeichenfolge

    result.timeSlots 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

    result.timeSlots.short_description Kurze Beschreibung des Zeitfensters.

    Datentyp: Zeichenfolge

    result.timeSlots.slot_end Endzeit des Zeitfensters.

    Datentyp: Zeichenfolge

    result.timeSlots.slot_start Startzeit des Zeitfensters.

    Datentyp: Zeichenfolge

    result.timeSlots.sys_id Sys_id des Zeitfenster-Datensatzes.

    Befindet sich in der Zeitfenstertabelle [sn_wsd_rsv_time_slot].

    Datentyp: Zeichenfolge

    result.title Titel des reservierbaren Moduls.

    Datentyp: Zeichenfolge

    result.virtual_meeting_provider Details zum virtuellen Anbieter, der dem reservierbaren Modul zugeordnet ist.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge

    result.virtual_meeting_provider.sys_id Sys_id des Anbieters der virtuellen Besprechung.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Dieses Code-Beispiel 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"
      }
    }