WSD RESERVIERBAR V2-API

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 15 Minuten Lesedauer

    • Die Workplace Service Delivery(WSD) Reservierbar V2 Die API stellt Endpunkte bereit, um Details eines reservierbaren Elements abzurufen, einer Entität, die reserviert werden kann, z. B. eines Arbeitsplatzstandorts, von einem ServiceNowInstanz.

    Die WSD reservierbar V2 API ist eine neue Version von WSD reservierbare API. Die WSD reservierbar V2 Die API ruft Details aller reservierbaren Bereiche im WSD-Portal ab, die Sie während der Reservierung auswählen. Das Original WSD reservierbar Die API-Version hat einen GET-Aufruf verwendet, aber den Pfadparameter „sys_ID“ auf 35 Zeichen beschränkt. Das neue WSD reservierbar V2 Die API-Version ist ein POST-Aufruf und verwendet alle sys_IDs im Anforderungstext, um Zeichenbeschränkungen zu vermeiden.

    Um auf diese API zuzugreifen, muss der Aufrufer über die Rolle „sn_wsd_core.workplace_user“ verfügen.

    Diese API wird in ausgeführt sn_wsd_rsv Namespace. Um auf diese API zuzugreifen, muss das Plugin „Arbeitsplatzreservierungsverwaltung“ (sn_wsd_rsv) aktiviert sein.

    Für zusätzliche Informationen zu Management von Arbeitsplatz-Reservierungen, Siehe Verwaltung Von Arbeitsplatzreservierungen .

    WSD reservierbar V2 API – POST /sn_wsd_rsv/v2/reservierbar/list_reservierbar

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

    URL-Format

    Standard-URL: api/sn_wsd_rsv/v2/reservierbar/list_reservierbar VERÖFFENTLICHEN

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfad-Parameter
    Name Beschreibung
    api_version Erforderlich. Version des Endpunkts, auf den zugegriffen werden soll. Geben Sie An v2 Um diese API zu verwenden, andernfalls verwenden v1 Verwendet die Standardversion der reservierbaren WSD-API.

    Datentyp: Zeichenfolge
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 3. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    Include_flexible_Services Kennzeichnung, die angibt, ob die flexiblen Services, die dem reservierbaren Element in zugeordnet sind, an die Antwort zurückgegeben werden sollen.

    Ein flexibler Service ist eine zusätzliche Bereitstellung, die mit einem reservierbaren Arbeitsplatzelement verfügbar ist, wenn eine Reservierung vorgenommen wird. Beispiel: Klassenraumstil: Zeilen von Tabellen, die angeordnet sind, wobei alle Teilnehmer zur Vorderseite des Raums zeigen. Weitere Informationen zu flexiblen Services finden Sie unter Erstellen Sie einen flexiblen Service .

    Gültige Werte:
    • Wahr: Geben Sie die flexiblen Serviceinformationen zurück.
    • Falsch: Geben Sie die flexiblen Serviceinformationen nicht zurück.

    Datentyp: Boolescher Wert

    Standard: Falsch
    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:
    • Wahr: Standardserviceinformationen zurückgeben.
    • Falsch: Geben Sie die Standardserviceinformationen nicht zurück.

    Datentyp: Boolescher Wert

    Standard: Falsch
    Include_reservable_purposes Optional. Kennzeichnung, die angibt, ob der Zweck zurückgegeben werden soll, der dem reservierbaren Element zugeordnet ist.
    Gültige Werte:
    • Wahr: Gibt den Zweck des reservierbaren Elements zurück.
    • Falsch: Geben Sie den Zweck des reservierbaren Elements nicht zurück.

    Datentyp: Boolescher Wert

    Standard: Falsch
    Include_Layouts Kennzeichnung, die angibt, ob die Standortlayoutinformationen in der Antwort zurückgegeben werden sollen.

    Informationen zum Standortlayout umfassen z. B. Kapazität, maximale Kapazität, Vorbereitung und Bereinigungsdauer.

    Gültige Werte:
    • Wahr: Informationen zum Standortlayout zurückgeben.
    • Falsch: Geben Sie die Informationen zum Standortlayout nicht zurück.

    Datentyp: Boolescher Wert

    Standard: Falsch

    Tabelle: Standortlayout [sn_wsd_rsv_m2m_location_layout]
    reservable_module_sys_id Erforderlich. SYS_ID des reservierbaren Moduls, z. B. Schreibtisch, Besprechungsraum usw.

    Ein reservierbares Modul gruppiert ähnliche Arten von Arbeitsplatzelementen.

    Weitere Informationen zu reservierbaren Modulen finden Sie unter Konfigurieren Sie ein reservierbares Modul .

    Datentyp: Zeichenfolge

    Standard: Leerer Wert

    Tabelle: Reservierbares Modul [sn_wsd_rsv_reservable_module]
    Reservation_Start_time Startzeit der Reservierung, um die Vorlaufzeit zusätzlicher Services zu validieren.

    Format: UTC-Format, jjjj-MM-tt HH:mm:ss

    Datentyp: Zeichenfolge
    Space_sys_IDs Erforderlich. Kommagetrennte sys_IDs der ausgewählten Bereiche.

    Datentyp: Zeichenfolge

    Standard: Leerer Wert

    Header

    Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 4. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json
    Inhaltstyp Datenformat des Antworttexts. Unterstützt nur Anwendung/JSON.
    Tabelle : 5. Antwort-Header
    Header 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.
    404Reservierbare Elemente konnten nicht gefunden werden.

    Suchen Sie nach der Tabelle „WSD-Kernbereiche“ [sn_wsd_core_spaces], und stellen Sie sicher, dass der Platzdatensatz vorhanden ist.
    500Fehler aufgetreten! Reservierbare Elemente können nicht abgerufen werden.

    Dies ist ein Serverfehler. Wenden Sie sich an die Systemverwaltung.

    Antworttext-Parameter

    Name Beschreibung
    Ergebnis Details zu jedem übereinstimmenden reservierbaren Element.

    Datentyp: Array von Objekten

    {
  "result": [
    {
      "allow_invitees": Boolean,
      "area": {Object},
      "building": {Object},
      "campus": {Object},
      "capacity": Number,
      "description": "String",
      "display_number_of_attendees": Boolean,
      "display_on_behalf_of": Boolean,
      "display_sensitivity": Boolean,
      "email": "String",
      "employee_override_privacy": Boolean
      "enable_group_reservations": Boolean,
      "enable_reservation_privacy": Boolean,
      "external_id": "String",
      "flexible_services": [Array],
      "floor": {Object},
      "image": {Object},
      "is_reservable": Boolean,
      "layouts": [Array],
      "location_type": {Object},
      "meetingProviders": [Array],
      "moduleType": "String",
      "name": "String",
      "number": "String",
      "order": Number,
      "require_approval": Boolean,
      "requires_check_in": Boolean,
      "require_subject": Boolean,
      "reservable_quantity": Number,
      "site": {Object},
      "standard_services": [Array],
      "sys_id": "String",
      "title": "String",
      "type": "String",
      "tableName": "String"
    }
  ]
}
    Ergebnis.allow_eingeladene Personen Kennzeichnung, die angibt, ob Mitarbeiter der Reservierung eingeladene Personen hinzufügen können.
    Gültige Werte:
    • Wahr: Mitarbeitern erlauben, eingeladene Personen zur Reservierung hinzuzufügen.
    • Falsch: Mitarbeiter dürfen der Reservierung keine eingeladenen Personen hinzufügen.

    Datentyp: Boolescher Wert
    Ergebnis.Bereich Bereich, in dem sich das reservierbare Element befindet.

    Datentyp: Objekt

    "area": {
   "display_value": "String",
   "sys_id": "String"
}

    Tabelle: Bereich [sn_wsd_core_area]
    Ergebnis.Bereich.Anzeige_Wert Anzeigewert für den Bereich.

    Datentyp: Zeichenfolge
    Ergebnis.Bereich.sys_ID SYS_ID des zugeordneten Bereichsdatensatzes.

    Datentyp: Zeichenfolge
    Ergebnis.Gebäude Gebäude, in dem sich das reservierbare Element befindet.

    Datentyp: Objekt

    "building": {
  "display_value": "String",
  "sys_id": "String",
  "timezone": {Object}
}

    Tabelle: Gebäude [sn_wsd_core_building]
    Ergebnis.Gebäude.Anzeigewert Anzeigewert für das Gebäude.

    Datentyp: Zeichenfolge
    Ergebnis.Gebäude.sys_ID SYS_ID des zugeordneten Gebäudedatensatzes.

    Datentyp: Zeichenfolge
    Ergebnis.Gebäude.Zeitzone Details der Zeitzone für das Gebäude.

    Datentyp: Objekt

    "timezone": {
  "displayValue": "String",
  "value": "String"
}
    Ergebnis.Gebäude.Zeitzone.Display_value Anzeigewert der Zeitzone, in der sich das zugehörige Gebäude befindet.

    Datentyp: Zeichenfolge
    Ergebnis.Gebäude.Zeitzone.Wert Interner Wert der Zeitzone, in der sich das zugehörige Gebäude befindet.

    Datentyp: Zeichenfolge
    result.campus Campus, auf dem sich das reservierbare Element befindet.

    Datentyp: Objekt

    "campus": {
  "display_value": "String",
  "sys_id": "String"
}

    Tabelle: Campus [sn_wsd_core_campus]
    result.campus.display_value Anzeigewert für den Campus.

    Datentyp: Zeichenfolge
    result.campus.sys_id SYS_ID des zugeordneten Campus-Datensatzes.

    Datentyp: Zeichenfolge
    result.capacity Anzahl der Personen, die das reservierbare Element aufnehmen kann.

    Datentyp: Zahl
    result.description Beschreibung des reservierbaren Elements.

    Datentyp: Zeichenfolge
    result.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: Boolescher Wert
    result.display_on_behalf_of 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: Boolescher Wert
    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. Der Standardwert ist „Normal“.

    Datentyp: Boolescher Wert
    Ergebnis.E-Mail E-Mail-Adresse, die dem reservierbaren Element zugeordnet ist.

    Datentyp: Zeichenfolge
    Ergebnis.Employee_override_privacy Kennzeichnung, die angibt, ob Anwender die Datenschutzeinstellung für das zugehörige reservierbare Element überschreiben können.

    Weitere Informationen zu diesen Datenschutzeinstellungen finden Sie unter Datenschutzeinstellungen und Auswirkung des Standorts .

    Gültige Werte:
    • Wahr: Anwender können die Datenschutzeinstellung für das zugehörige reservierbare Element überschreiben.
    • Falsch: Anwender können die Datenschutzeinstellung für das zugehörige reservierbare Element nicht überschreiben.
    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: Boolescher Wert
    Ergebnis.enable_reservation_privacy

    Kennzeichnung, die die Standardeinstellung für den Datenschutz bei Reservierungen angibt.

    Weitere Informationen zu diesen Datenschutzeinstellungen finden Sie unter Location privacy settings and impact.

    Mögliche Werte:
    • Wahr: Reservierungen sind standardmäßig privat.
    • Falsch: Reservierungen sind standardmäßig nicht privat.

    Datentyp: Boolescher Wert
    Ergebnis.external_ID Externe ID des reservierbaren Elements.

    Datentyp: Zeichenfolge
    Ergebnis.flexible_Services Wird nur ausgefüllt, wenn include_flexible_servicesDer Parameter ist auf „wahr“ festgelegt, und das Plugin „Arbeitsplatzfallmanagement“ ist installiert. Beschreibung der flexiblen Services, die den reservierbaren Elementen zugeordnet sind. Es kann einen übergeordneten flexiblen Service und mehrere untergeordnete flexible Services geben.

    Datentyp: Array von Objekten

    flexible_services": [
  {
    "additional_text": "String",
    "allow_only_single_service_item_selection": Boolean,
    "category": "String",
    "currency_code": "String",
    "flexible_service": [Array],
    "label": "String",
    "sub_category": "String",
    "sub_title": "String",
    "text": "String",
    "title": {Object}
  }
]

    Tabelle: Arbeitsplatzservice-Element [sn_wsd_case_workplace_service_item]
    Ergebnis.flexible_Services.zusätzlicher_Text Text, der den Anwender auffordert, zusätzliche flexible Services auszuwählen.

    Datentyp: Zeichenfolge
    result.flexible_services.allow_only_single_​Service_item_selection Kennzeichnung, die angibt, ob Anwender nur ein Serviceelement aus der Gruppe der flexiblen Services innerhalb einer Reservierung auswählen können.
    Gültige Werte:
    • Wahr: Es kann nur eine einzelne Auswahl getroffen werden.
    • Falsch: Mehrfachauswahl möglich.

    Datentyp: Boolescher Wert
    result.flexible_services.category Kategorie der flexiblen Services.

    Datentyp: Zeichenfolge
    Result.flexible_Services.currency_Code Währungscode, der zur Berechnung des Währungsbetrags bei der Bestellung flexibler Services verwendet wird.

    Datentyp: Zeichenfolge
    Ergebnis.flexible_Services.flexible_Service Flexible Services, die einem übergeordneten flexiblen Service entsprechen.

    Datentyp: Array von Objekten

    "flexible_service": [
  {
    "flexible_service": [Array],
    "label": "String",
    "sub_category": "String"
 }
]

    Tabelle: Arbeitsplatzservice-Element [sn_wsd_case_workplace_service_item]
    Result.flexible_Services.flexible_Service.​Flexible_Service Details zu jedem flexiblen Service, der einem übergeordneten flexiblen Service entspricht.

    Datentyp: Array von Objekten

    "flexible_service": [
  {
    "additional_text": "String",
    "capacity_enabled": Boolean,
    "category": "String",
    "category_label": "String",
    "cleanup_duration": "String",
    "image": "String",
    "max_capacity": Number,
    "name": "String",
    "preparation_duration": "String",
    "price_per_unit": {Object},
    "quantity_enabled": Boolean,
    "quantity_required": Boolean,
    "short_description": "String",
    "sub_category": "String",
    "sub_category_label": "String",
    "sub_title": "String",
    "sys_id": "String",
    "text": "String",
    "title": {Object}
  }
]
    Result.flexible_Services.flexible_Service.​Flexible_Service.zusätzlicher_Text Text, der verwendet wird, um einen Anwender aufzufordern, zusätzliche flexible Services auszuwählen.

    Datentyp: Zeichenfolge
    Result.flexible_Services.flexible_Service.​flexible_service.capacity_enabled Kennzeichnung, die angibt, ob die Kapazität des Raums in der Reservierung angezeigt werden soll. Wenn dieser Wert auf „wahr“ festgelegt ist, quantity_enabledIst immer „falsch“.
    Gültige Werte:
    • Wahr: Kapazität muss angezeigt werden.
    • Falsch: Kapazität darf nicht angezeigt werden.

    Datentyp: Boolescher Wert
    Result.flexible_Services.flexible_Service.​flexible_service.category Kategorie des flexiblen Service.

    Datentyp: Zeichenfolge
    Result.flexible_Services.flexible_Service.​flexible_service.category_label Kategoriebezeichnung des flexiblen Service.

    Datentyp: Zeichenfolge
    Result.flexible_Services.flexible_Service.​Flexible_Service.Cleanup_duration Zeit, die zum Bereinigen oder Entfernen des Service benötigt wird, der dem reservierbaren Element hinzugefügt wurde.

    Datentyp: Zahl

    Einheit: Millisekunden
    Result.flexible_Services.flexible_Service.​Flexible_Service.image Link zum Image des flexiblen Service.

    Datentyp: Zeichenfolge
    Result.flexible_Services.flexible_Service.​Flexible_Service.max_Capacity Maximale Anzahl von Personen, die das reservierbare Element aufnehmen kann.

    Datentyp: Zahl
    Result.flexible_Services.flexible_Service.​flexible_service.name Name des flexiblen Service.

    Datentyp: Zeichenfolge
    Result.flexible_Services.flexible_Service.​Flexible_Service.Preparation_duration Zeit, die benötigt wird, um den Service dem reservierbaren Element hinzuzufügen.

    Datentyp: Zeichenfolge

    Einheit: Millisekunden
    Result.flexible_Services.flexible_Service.​flexible_service.price_per_unit Details zu den Kosten für das Hinzufügen des flexiblen Service zum reservierbaren Element.

    Datentyp: Objekt

    "price_per_unit": {
  "code": "String",
  "value": "String"
}
    Result.flexible_Services.flexible_Service.​flexible_service.price_per_unit.code Währungscode, der bei der Berechnung der Kosten verwendet werden soll, z. B. GBP oder USD.

    Datentyp: Zeichenfolge
    Result.flexible_Services.flexible_Service.​flexible_service.price_per_unit.value Kosten für jede Einheit des flexiblen Service in der im Codeparameter definierten Währung.

    Datentyp: Zeichenfolge
    Result.flexible_Services.flexible_Service.​Flexible_Service.quantity_enabled Kennzeichnung, die angibt, ob das Mengenfeld in der Reservierung angezeigt werden soll. Wenn dieser Wert auf „wahr“ festgelegt ist, capacity_enabledIst immer „falsch“.
    Gültige Werte:
    • Wahr: Menge muss angezeigt werden.
    • Falsch: Menge darf nicht angezeigt werden.

    Datentyp: Boolescher Wert
    Result.flexible_Services.flexible_Service.​Flexible_Service.quantity_required Kennzeichnung, die angibt, ob die Menge erforderlich ist.
    Gültige Werte:
    • Wahr: Menge ist erforderlich.
    • Falsch: Menge ist nicht erforderlich.

    Datentyp: Boolescher Wert

    Result.flexible_Services.flexible_Service.​Flexible_Service.short_description

    		 Kurze Beschreibung des flexiblen Service.

    Datentyp: Zeichenfolge
    Result.flexible_Services.flexible_Service.​Flexible_Service.sub_category Unterkategoriename des flexiblen Service, z. B. Chair_Layout.

    Datentyp: Zeichenfolge
    Result.flexible_Services.flexible_Service.​flexible_service.sub_category_label Unterkategorie-Bezeichnung des flexiblen Service, z. B. Stuhllayout.

    Datentyp: Zeichenfolge
    Result.flexible_Services.flexible_Service.​Flexible_Service.sub_title Untertitelname des untergeordneten flexiblen Service.

    Datentyp: Zeichenfolge
    Result.flexible_Services.flexible_Service.​Flexible_Service.sys_ID SYS_ID des flexiblen Service.

    Datentyp: Zeichenfolge
    Result.flexible_Services.flexible_Service.​Flexible_Service.Text Text, der verwendet wird, um einen Anwender zur Auswahl flexibler Services aufzufordern.

    Datentyp: Zeichenfolge
    Result.flexible_Services.flexible_Service.​Flexible_Service.title Details für die Titel, die beim Hinzufügen und Bearbeiten des untergeordneten flexiblen Service in der Anwenderoberfläche verwendet werden sollen.

    Datentyp: Objekt

    "title": {
  "add": "String",
  "edit": "String"
}
    Result.flexible_Services.flexible_Service.​Flexible_Service.title.add Titel, der beim Hinzufügen eines untergeordneten flexiblen Service in der Anwenderoberfläche verwendet wird.

    Datentyp: Zeichenfolge
    Result.flexible_Services.flexible_Service.​Flexible_Service.title.Edit Titel, der beim Bearbeiten eines untergeordneten flexiblen Service in der Anwenderoberfläche verwendet wird.

    Datentyp: Zeichenfolge
    Result.flexible_Services.flexible_Service.label Flexible Servicebezeichnung.

    Datentyp: Zeichenfolge
    Result.flexible_Services.flexible_Service.​Sub_category Unterkategorie der übergeordneten flexiblen Services, z. B. zusätzlicher Stuhl.

    Datentyp: Zeichenfolge
    Result.flexible_Services.flexible_Service.​Sub_title Untertitelname des übergeordneten flexiblen Service.

    Datentyp: Zeichenfolge
    Ergebnis.flexible_Services.flexible_Service.Text Text, der verwendet wird, um einen Anwender aufzufordern, einen übergeordneten flexiblen Service auszuwählen.

    Datentyp: Zeichenfolge
    Result.flexible_Services.flexible_Service.title Details für die Titel, die beim Hinzufügen und Bearbeiten des übergeordneten flexiblen Service in der Anwenderoberfläche verwendet werden sollen.

    Datentyp: Objekt

    "title": {
  "add": "String",
  "edit": "String"
}
    Result.flexible_Services.flexible_Service.title.​Hinzufügen Titel, der beim Hinzufügen eines übergeordneten flexiblen Service in der Anwenderoberfläche verwendet wird.

    Datentyp: Zeichenfolge
    Result.flexible_Services.flexible_Service.title.​Bearbeiten Titel, der beim Bearbeiten eines übergeordneten flexiblen Service in der Anwenderoberfläche verwendet wird.

    Datentyp: Zeichenfolge
    Ergebnis.Stockwerk Details zum Stockwerk, auf dem sich das reservierbare Element befindet.

    Datentyp: Objekt

    "floor": {
  "display_value": "String",
  "sys_id": "String"
}

    Tabelle: Stockwerk [sn_wsd_core_floor]
    Ergebnis.Stockwerk.Anzeigewert Anzeigenummer des Stockwerks, in dem sich das reservierbare Element befindet, z. B. 12.

    Datentyp: Zeichenfolge
    Ergebnis.Stockwerk.sys_ID SYS_ID des zugeordneten Datensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Stockwerk [sn_wsd_core_floor]
    Ergebnis.Bild Details zu einem Bild, das das zugehörige reservierbare Element darstellt.

    Datentyp: Objekt

    "image": {
  "link": "String",
  "sys_id": "String"
}

    Tabelle: Images [DB_image]
    result.image.link Link zu einem Bild, das das reservierbare Element darstellt.

    Datentyp: Zeichenfolge
    Ergebnis.Image.sys_ID SYS_ID des zugeordneten Bilddatensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Images [DB_image]
    Result.is_reservierbar Kennzeichnung, die angibt, ob der flexible Service reserviert werden kann.
    Gültige Werte:
    • Wahr: Flexibler Service kann reserviert werden.
    • Falsch: Flexibler Service kann nicht reserviert werden.

    Datentyp: Boolescher Wert
    Ergebnisse.Layouts Wird nur ausgefüllt, wenn include_layoutsParameter ist auf „wahr“ festgelegt.

    Liste der Layouts, die dem reservierbaren Element zugeordnet sind.

    Datentyp: Array von Objekten

    "layouts": [
  {
    "capacity": Number,
    "cleanup_duration": "String",
    "image": {Object},
    "is_default": Boolean,
    "max_capacity": Number,
    "name": "String",
    "preparation_duration": "String",
    "short_description": "String",
    "sys_id": "String"
  }
]
    result.layouts.capacity Anzahl der Personen, die an der Besprechung teilnehmen.

    Datentyp: Zahl
    Ergebnis.Layouts.Cleanup_duration Zeit, die zum Bereinigen des reservierbaren Elements für dieses Layout benötigt wird.

    Datentyp: Zahl

    Einheit: Millisekunden
    Ergebnis.Layouts.Bild Details zu einem Bild, das das Layout für das zugehörige reservierbare Element darstellt.

    Datentyp: Objekt

    "image": {
  "link": "String",
  "sys_id": "String"
}

    Tabelle: Images [DB_image]
    result.layouts.image.link Link zu einem Bild, das das Layout für dieses reservierbare Element darstellt.

    Datentyp: Zeichenfolge

    Tabelle: Images [DB_image]
    Ergebnis.Layouts.Image.sys_ID SYS_ID des zugeordneten Bilddatensatzes.

    Datentyp: Zeichenfolge
    Ergebnis.Layouts.is_default Kennzeichnung, die angibt, ob das zugeordnete Layout der Standard für das reservierbare Element ist.
    Gültige Werte:
    • Wahr: Standard.
    • Falsch: Nicht Standard.

    Datentyp: Boolescher Wert
    Ergebnis.Layouts.max_Capacity Maximale Anzahl von Personen, die das Layout, das dem reservierbaren Element zugeordnet ist, aufnehmen kann.

    Datentyp: Zahl
    result.layouts.name Name des Standortlayouts.

    Datentyp: Zeichenfolge
    Ergebnis.Layouts.Preparation_duration Zeit, die für die Vorbereitung des zugehörigen Standortlayouts benötigt wird.

    Datentyp: Zahl

    Einheit: Millisekunden
    Ergebnis.Layouts.short_description Kurze Beschreibung des Standortlayouts.

    Datentyp: Zeichenfolge
    Ergebnis.Layouts.sys_ID SYS_ID des Standortlayouts.

    Datentyp: Zeichenfolge

    Tabelle: Layout [sn_wsd_rsv_layout]
    Result.location_type Details zum Typ des Standorts des reservierbaren Elements, z. B. Arbeitsplatz/Schreibtisch, Café oder Fitnessstudio.

    Datentyp: Objekt

    "location_type": {
  "display_value": "String",
  "sys_id": "String"
}

    Tabelle: Bereichstyp [sn_wsd_core_space_type]
    Ergebnis.Location_type.Display_value Anzeigewert des Standorttyps.

    Datentyp: Zeichenfolge
    Ergebnis.Standort_Typ.sys_ID SYS_ID des zugeordneten Datensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Bereichstyp [sn_wsd_core_space_type]
    Ergebnis.MeetingBereitsteller Details zu den Anbietern virtueller Besprechungen, die dem reservierbaren Element zugeordnet sind.

    Datentyp: Array von Objekten

    "meetingProviders": [
  {
    "display_value": "String",
    "value": "String"
  }
]

    Tabelle: Anbieter virtueller Besprechungen [sn_wsd_rsv_virtual_meeting_provider]
    Ergebnis.MeetingProviders.Display_value Anzeigewert des Namens des virtuellen Providers.

    Datentyp: Zeichenfolge
    Ergebnis.MeetingBereitsteller.Wert Ist-Wert für den Namen des virtuellen Providers im Datensatz.

    Datentyp: Zeichenfolge
    Ergebnis.ModuleType Reservierbares Modul, das dem reservierbaren Element zugeordnet ist, z. B. Schreibtische oder Besprechungsraum.

    Datentyp: Zeichenfolge
    result.name Name des reservierbaren Elements.

    Datentyp: Zeichenfolge
    Ergebnis.Nummer Eindeutiger Bezeichner des reservierbaren Elements. Dieser Wert ist visuell lesbarer als die sys_ID.

    Datentyp: Zeichenfolge
    Ergebnis.Reihenfolge Auftragsnummer für reservierbares Element.

    Datentyp: Zahl
    Ergebnis.require_Approval Kennzeichnung, die angibt, ob die Reservierung des reservierbaren Elements eine Genehmigung erfordert.
    Mögliche Werte:
    • Wahr: Genehmigung erforderlich.
    • Falsch: Genehmigung ist nicht erforderlich.

    Datentyp: Boolescher Wert
    Ergebnis.erfordert_Check_in Kennzeichnung, die angibt, ob für das reservierbare Element der Anwender das Einchecken erfordert.
    Gültige Werte:
    • Wahr: Einchecken erforderlich.
    • Falsch: Einchecken ist nicht erforderlich.

    Datentyp: Boolescher Wert
    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: Boolescher Wert
    Ergebnis.reservierbar_Quantität Maximale Anzahl, mit der das zugeordnete reservierbare Element für dieselbe Zeit reserviert werden kann. Dieser Wert wird verwendet, wenn einem Bereich Arbeitsbereiche zugewiesen werden.

    Datentyp: Ganzzahl
    Ergebnis.Site Details zum Standort, an dem sich das reservierbare Element befindet.

    Datentyp: Objekt

    "site": {
  "display_value": "String",
  "sys_id": "String"
}

    Tabelle: Site [sn_wsd_core_site]
    Ergebnis.Site.Display_value Anzeigewert der Website.

    Datentyp: Zeichenfolge
    Ergebnis.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

    "standard_services": [
  {
    "font_awesome_icon": "String",
    "name": "String",
    "short_description": "String",
    "sys_id": "String"
  }
]
    result.standard_services.font_awesome_icon Name des Miniaturansichtssymbols, das dem Standardservice zugeordnet ist.

    Datentyp: Zeichenfolge
    result.standard_services.name Name des Standardservice.

    Datentyp: Zeichenfolge
    Ergebnis.Standard_Services.short_description Kurze Beschreibung des Standardservice.

    Datentyp: Zeichenfolge
    Ergebnis.Standard_Services.sys_ID SYS_ID des Standardservicedatensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Standardservice [sn_wsd_rsv_standard_service]
    Ergebnis.Site.sys_ID SYS_ID des zugeordneten Site-Datensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Site [sn_wsd_core_site]
    Ergebnis.tableName Name der Tabelle, in der sich der reservierbare Datensatz befindet.

    Datentyp: Zeichenfolge
    Ergebnis.Titel Titel des reservierbaren Elements.

    Datentyp: Zeichenfolge
    Ergebnis.Typ Typ eines reservierbaren Elements, z. B. Standort.

    Datentyp: Zeichenfolge

    Curl-Anforderung

    Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird, um Details zu den angegebenen reservierbaren Elementen zurückzugeben.

    curl "http://instance.servicenow.com/api/sn_wsd_rsv/v2/reservable/list_reservables" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"space_sys_ids\":\"3ed3139977220110b3d7be377b5a99d1\",\"reservable_module_sys_id\":\"c31241cedb7650106c731dcd13961917\",\"include_flexible_services\":true,\"include_standard_services\":true,\"include_reservable_purposes\":true,\"include_layouts\":false}" \
--user 'username:'password'

    Antworttext. Dieses Beispiel gibt Details zu allen reservierbaren Elementen zurück, die im Anforderungstext aufgeführt sind.

    {
  "result": [
    {
      "sys_id": "3ed3139977220110b3d7be377b5a99d1",
      "external_id": "447b9dfb475a011064062782846d4382",
      "wsd_email": null,
      "name": "A263",
      "title": "A263",
      "description": null,
      "image": null,
      "number": "ROOM0000181",
      "site": {
        "sys_id": "b35f47ffdba05010f342a0da4b961998",
        "display_value": "Italy"
      },
      "campus": {
        "sys_id": "87831b1977220110b3d7be377b5a9946",
        "display_value": ""
      },
      "building": {
        "sys_id": "dea39b1977220110b3d7be377b5a9955",
        "display_value": "",
        "timezone": {
          "value": "",
          "displayValue": ""
        }
      },
      "floor": {
        "sys_id": "68d31f5977220110b3d7be377b5a991b",
        "display_value": ""
      },
      "area": null,
      "capacity": "17",
      "reservable_quantity": "1",
      "location_type": {
        "sys_id": "20713b83eb512010b89bfdfc9c522899",
        "display_value": "Room"
      },
      "order": null,
      "requires_check_in": null,
      "is_reservable": "1",
      "type": "location",
      "moduleType": "Meeting rooms",
      "meetingProviders": [],
      "require_subject": true,
      "allow_invitees": false,
      "display_number_of_attendees": false,
      "display_on_behalf_of": true,
      "display_sensitivity": true,
      "enable_group_reservations": false,
      "allow_reservation_message": false,
      "warn_employee_for_duplicate_reservation": false,
      "enable_reservation_privacy": false,
      "employee_override_privacy": false,
      "tableName": "sn_wsd_core_room",
      "require_approval": false,
      "flexible_services": [
        {
          "allow_only_single_service_item_selection": true,
          "category": "50723fbf07100110c9b36b6e0ad300b4",
          "label": "Space arrangement",
          "description": "This is a service to request a different space configuration as part of a reservation.",
          "sub_category": "chair_layout",
          "title": {
            "edit": "Update Space arrangement for A263",
            "add": "Add Space arrangement for A263"
          },
          "sub_title": "Add a space arrangement item to get started",
          "text": "Select space arrangement item",
          "additional_text": "Select another space arrangement item",
          "currency_code": "GBP",
          "flexible_service": [
            {
              "sub_category": "chair_layout",
              "label": "Chair layout",
              "flexible_service": [
                {
                  "sys_id": "e2ecf7b307500110c9b36b6e0ad30033",
                  "name": "Classroom Style",
                  "short_description": "Rows of tables arranged with all participants facing towards the front of the room",
                  "category": "50723fbf07100110c9b36b6e0ad300b4",
                  "category_label": "Space arrangement",
                  "sub_category": "chair_layout",
                  "sub_category_label": "Chair layout",
                  "image": "08d6ff68d5122110fa9b1500c1d696c5.iix",
                  "quantity_enabled": false,
                  "quantity_required": false,
                  "capacity_enabled": true,
                  "max_capacity": "",
                  "preparation_duration": "1970-01-01 00:15:00",
                  "cleanup_duration": "1970-01-01 00:15:00",
                  "price_per_unit": {
                    "value": 0,
                    "code": "GBP"
                  },
                  "title": {
                    "edit": "Update Space arrangement for A263",
                    "add": "Add Space arrangement for A263"
                  },
                  "sub_title": "Add a space arrangement item to get started",
                  "text": "Select space arrangement item",
                  "additional_text": "Select another space arrangement item"
                },
                {
                  "sys_id": "1cf33fff07100110c9b36b6e0ad30077",
                  "name": "Banquet Rounds",
                  "short_description": "Round tables arranged throughout the room. Participants are seated around the entire perimeter of each table",
                  "category": "50723fbf07100110c9b36b6e0ad300b4",
                  "category_label": "Space arrangement",
                  "sub_category": "chair_layout",
                  "sub_category_label": "Chair layout",
                  "image": "cdc67720d5522110fa9b1500c1d69636.iix",
                  "quantity_enabled": false,
                  "quantity_required": false,
                  "capacity_enabled": true,
                  "max_capacity": "",
                  "preparation_duration": "1970-01-01 00:15:00",
                  "cleanup_duration": "1970-01-01 00:15:00",
                  "price_per_unit": {
                    "value": 0,
                    "code": "GBP"
                  },
                  "title": {
                    "edit": "Update Space arrangement for A263",
                    "add": "Add Space arrangement for A263"
                  },
                  "sub_title": "Add a space arrangement item to get started",
                  "text": "Select space arrangement item",
                  "additional_text": "Select another space arrangement item"
                },
                {
                  "sys_id": "21e2c08407600110c9b36b6e0ad3007c",
                  "name": "Theater Style",
                  "short_description": "Rows of chairs (no tables) arranged with all participants facing towards the front of the room",
                  "category": "50723fbf07100110c9b36b6e0ad300b4",
                  "category_label": "Space arrangement",
                  "sub_category": "chair_layout",
                  "sub_category_label": "Chair layout",
                  "image": "f3d67fa4d5122110fa9b1500c1d6968b.iix",
                  "quantity_enabled": false,
                  "quantity_required": false,
                  "capacity_enabled": true,
                  "max_capacity": "",
                  "preparation_duration": "1970-01-01 00:15:00",
                  "cleanup_duration": "1970-01-01 00:15:00",
                  "price_per_unit": {
                    "value": 0,
                    "code": "GBP"
                  },
                  "title": {
                    "edit": "Update Space arrangement for A263",
                    "add": "Add Space arrangement for A263"
                  },
                  "sub_title": "Add a space arrangement item to get started",
                  "text": "Select space arrangement item",
                  "additional_text": "Select another space arrangement item"
                }
              ]
            }
          ]
        },
        {
          "allow_only_single_service_item_selection": false,
          "category": "c9ab1c89c3500110547e3810a840dd41",
          "label": "Catering",
          "description": "This is a service to request catering as part of a reservation.",
          "sub_category": "drinks",
          "title": {
            "edit": "Update Catering for A263",
            "add": "Add Catering for A263"
          },
          "sub_title": "Add a catering item to get started",
          "text": "Select catering item",
          "additional_text": "Select another catering item",
          "currency_code": "GBP",
          "flexible_service": [
            {
              "sub_category": "drinks",
              "label": "Drinks",
              "flexible_service": [
                {
                  "sys_id": "48d72985c3900110547e3810a840dd7d",
                  "name": "Champagne",
                  "short_description": "",
                  "category": "c9ab1c89c3500110547e3810a840dd41",
                  "category_label": "Catering",
                  "sub_category": "drinks",
                  "sub_category_label": "Drinks",
                  "image": "",
                  "quantity_enabled": true,
                  "quantity_required": false,
                  "capacity_enabled": false,
                  "max_capacity": "",
                  "preparation_duration": 0,
                  "cleanup_duration": 0,
                  "price_per_unit": {
                    "value": 0,
                    "code": "GBP"
                  },
                  "title": {
                    "edit": "Update Catering for A263",
                    "add": "Add Catering for A263"
                  },
                  "sub_title": "Add a catering item to get started",
                  "text": "Select catering item",
                  "additional_text": "Select another catering item"
                }
              ]
            }
          ]
        }
      ],
      "standard_services": [],
      "reservable_purposes": []
    }
  ]
}