WSD Reservierbare V2-API

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 15 Minuten Lesedauer

    • Die Workplace Service Delivery (WSD) Reservable V2- API bietet Endpunkte zum Abrufen von Details eines reservierbaren Elements, einer Entität, die reserviert werden kann, z. B. ein Arbeitsplatzstandort, aus einer ServiceNow -Instanz.

    Die API WSD Reservable V2 ist eine neue Version von WSD-API „Reservierbar“.. Die API „WSD Reservable V2“ ruft Details aller reservierbaren Plätze im WSD-Portal ab, die Sie bei der Reservierung auswählen. Die ursprüngliche Version der API „WSD Reservable“ verwendete einen GET-Aufruf, beschränkte jedoch den Pfadparameter „sys_ID“ auf 35 Zeichen. Die neue API-Version von WSD Reservable V2 ist ein POST-Aufruf und verwendet alle sys_ids im Anforderungstext, um Zeichenbeschränkungen zu vermeiden.

    Für den Zugriff auf diese API muss der Aufrufer über die Rolle sn_wsd_core.workplace_user verfügen.

    Diese API wird im Namespace sn_wsd_rsv ausgeführt. Für den Zugriff auf diese API muss das Plugin „Management von Arbeitsplatz-Reservierungen“ (sn_wsd_rsv) aktiviert sein.

    Weitere Informationen zu Management von Arbeitsplatz-Reservierungenfinden Sie unter Reservierungsmanagement für Arbeitsplatz.

    WSD Reservierbare V2-API – POST /sn_wsd_rsv/v2/reservable/list_reservables

    Gibt die Details für ein oder mehrere angegebene reservierbare Elemente zurück.

    URL-Format

    Standard-URL: POST api/sn_wsd_rsv/v2/reservable/list_reservables

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfadparameter
    Name Beschreibung
    api_version Erforderlich. Version des Endpunkts, auf den zugegriffen werden soll. Geben Sie v2 an, um diese API zu verwenden. Andernfalls wird bei Verwendung von v1 die Standardversion der API „WSD Reservable“ verwendet.

    Datentyp: Zeichenfolge
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 3. Anforderungstextparameter (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 – Reihen von Tischen, die so angeordnet sind, dass alle Teilnehmer zur Vorderseite des Raums blicken. Weitere Informationen zu flexiblen Services finden Sie unter Flexiblen Service erstellen.

    Gültige Werte:
    • „wahr“: Gibt die Informationen zum flexiblen Service zurück.
    • „falsch“: Die flexiblen Serviceinformationen nicht zurückgeben.

    Datentyp: Boolesch

    Standardwert: false
    „include_standard_​services“. Kennzeichnung, die angibt, ob die Standardserviceinformationen in der Antwort zurückgegeben werden sollen.

    Ein Standardservice beschreibt grundlegende Bestimmungen, die mit einem reservierbaren Arbeitsplatzelement verfügbar sind, wenn die Reservierung vorgenommen wird, z. B. Whiteboards, zusätzliche Monitore und ähnliche Services. Weitere Informationen zu Standardservices finden Sie unter Standardservices. Diese Informationen befinden sich in der Tabelle „Standardservice“ [sn_wsd_rsv_standard_service].

    Gültige Werte:
    • „wahr“: Gibt die Informationen zu Standardservices zurück.
    • „falsch“: Die Standardserviceinformationen werden nicht zurückgegeben.

    Datentyp: Boolesch

    Standardwert: false
    beinhaltet_reservierbare_Zwecke Optional. Kennzeichnung, die angibt, ob der mit dem reservierbaren Element verknüpfte Zweck zurückgegeben werden soll.
    Gültige Werte:
    • wahr: Gibt den Zweck des reservierbaren Elements zurück.
    • „falsch“: Gibt den Zweck des reservierbaren Elements nicht zurück.

    Datentyp: Boolesch

    Standardwert: false
    „include_layouts“ Kennzeichnung, die angibt, ob die Standortlayoutinformationen in der Antwort zurückgegeben werden sollen.

    Zu den Standortlayoutinformationen gehören Informationen wie Kapazität, maximale Kapazität, Vorbereitung und Bereinigungsdauer. Diese Informationen befinden sich in der Tabelle „Standortlayout“ [sn_wsd_rsv_m2m_location_layout].

    Gültige Werte:
    • „wahr“: Gibt die Informationen zum Standortlayout zurück.
    • „falsch“: Die Standortlayoutinformationen werden nicht zurückgegeben.

    Datentyp: Boolesch

    Standardwert: false
    reservable_module_sys_id Erforderlich. Sys_id des reservierbaren Moduls, z. B. Schreibtisch, Besprechungsraum usw.

    Ein reservierbares Modul gruppiert ähnliche Arten von Arbeitsplatzelementen. Diese sys_id befindet sich in der Tabelle „Reservierbares Modul“ [sn_wsd_rsv_reservable_module].

    Weitere Informationen zu reservierbaren Modulen finden Sie unter Reservierbare Module konfigurieren.

    Datentyp: Zeichenfolge

    Standard: Leerer Wert
    „reservierung_start_zeit“ Reservierungsstartzeit, um die Vorlaufzeit zusätzlicher Services zu validieren.

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

    Datentyp: Zeichenfolge
    Platz_Sys_IDs Erforderlich. Kommagetrennte sys_ids der ausgewählten Plätze.

    Datentyp: Zeichenfolge

    Standard: Leerer Wert

    Header

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

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

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

    Suchen Sie nach der Tabelle „WSD Core Spaces“ [sn_wsd_core_spaces], und vergewissern Sie sich, dass der Platzdatensatz vorhanden ist.
    500Fehler aufgetreten! Reservierbare Elemente können nicht abgerufen werden.

    Dies ist ein Serverfehler. Wenden Sie sich an den Systemadministrator.

    Parameter des Antwort-Haupttexts

    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"
    }
  ]
}
    result.allow_invitees 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 können der Reservierung keine eingeladenen Personen hinzufügen.

    Datentyp: Boolesch
    result.area Bereich, in dem sich das reservierbare Element befindet.

    Diese Informationen befinden sich in der Tabelle „Bereich“ [sn_wsd_core_area].

    "area": {
   "display_value": "String",
   "sys_id": "String"
}
    Ergebnis.Bereich.Anzeigewert Anzeigewert für den Bereich.

    Datentyp: Zeichenfolge
    result.area.sys_id Sys_id des zugeordneten Bereichsdatensatzes.

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

    Diese Informationen befinden sich in der Tabelle „Gebäude“ [sn_wsd_core_building].

    "building": {
  "display_value": "String",
  "sys_id": "String",
  "timezone": {Object}
}
    Ergebnis.Gebäude.Anzeigewert Anzeigewert für das Gebäude.

    Datentyp: Zeichenfolge
    result.building.sys_id Sys_id des zugeordneten Gebäudedatensatzes.

    Datentyp: Zeichenfolge
    Ergebnis.Gebäude.Zeitzone Details der Zeitzone für das Gebäude.
    "timezone": {
  "displayValue": "String",
  "value": "String"
}
    Ergebnis.Gebäude.Zeitzone.Anzeigewert Anzeigewert der Zeitzone, in der sich das zugeordnete Gebäude befindet.

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

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

    Diese Informationen befinden sich in der Tabelle „Campus“ [sn_wsd_core_campus].

    "campus": {
  "display_value": "String",
  "sys_id": "String"
}
    result.campus.display_value Anzeigewert für den Campus.

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

    Datentyp: Zeichenfolge
    Ergebnis.Kapazität 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: Benutzer können die Anzahl der Teilnehmer angeben.
    • „false“: Anwender 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 Namen von unterstützt.
    • „false“: „Im Namen von“ wird nicht unterstützt.

    Datentyp: Boolesch
    result.display_sensitivity Kennzeichnung, die angibt, ob Anwender die Vertraulichkeit der Reservierung festlegen können, z. B. normal oder privat.
    Gültige Werte:
    • true: Empfindlichkeit kann festgelegt werden.
    • „falsch“: Empfindlichkeit kann nicht festgelegt werden. Der Standardwert ist „normal“.

    Datentyp: Boolesch
    result.email E-Mail-Adresse, die dem reservierbaren Element zugeordnet ist.

    Datentyp: Zeichenfolge
    result.employee_override_privacy Kennzeichnung, die angibt, ob Anwender die Datenschutzeinstellung für das zugeordnete reservierbare Element überschreiben können.

    Weitere Informationen zu diesen Datenschutzeinstellungen finden Sie unter Datenschutzeinstellungen für den Standort und ihre Auswirkungen.

    Gültige Werte:
    • wahr: Anwender können die Datenschutzeinstellung für das zugeordnete reservierbare Element überschreiben.
    • „falsch“: Anwender können die Datenschutzeinstellung für das zugeordnete reservierbare Element nicht überschreiben.
    result.enable_group_reservations 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
    result.enable_reservation_privacy

    Kennzeichnung, die die Standardeinstellung für den Reservierungsdatenschutz 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: Boolesch
    result.external_id Externe ID des reservierbaren Elements.

    Datentyp: Zeichenfolge
    result.flexible_services Wird nur ausgefüllt, wenn der Parameter include_flexible_services auf „true“ festgelegt und das Plugin „Workplace Case Management“ installiert ist. Beschreibung der flexiblen Services, die den reservierbaren Elementen zugeordnet sind. Es kann einen übergeordneten flexiblen Service und mehrere untergeordnete flexible Services geben.

    Diese Informationen befinden sich in der Tabelle [sn_wsd_case_workplace_service_item].

    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}
  }
]
    result.flexible_services.additional_text Text, um den Anwender zur Auswahl zusätzlicher flexibler Services aufzufordern.

    Datentyp: Zeichenfolge
    result.flexible_services.allow_only_single_service_item_selection Kennzeichnung, die angibt, ob Anwender nur ein Service-Element aus der Gruppe der flexiblen Services innerhalb einer Reservierung auswählen können.
    Gültige Werte:
    • true: Es kann nur eine Einzelauswahl getroffen werden.
    • false: Mehrfachauswahl möglich.

    Datentyp: Boolesch
    result.flexible_services.category Kategorie der flexiblen Services.

    Datentyp: Zeichenfolge
    result.flexible_services.currency_code Währungscode, der zum Berechnen des Währungsbetrags beim Bestellen flexibler Services verwendet wird.

    Datentyp: Zeichenfolge
    result.flexible_services.flexible_service Flexible Services, die einem übergeordneten flexiblen Service entsprechen. Diese Informationen befinden sich in der Tabelle [sn_wsd_case_workplace_service_item].

    Datentyp: Array von Objekten

    "flexible_service": [
  {
    "flexible_service": [Array],
    "label": "String",
    "sub_category": "String"
 }
]
    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.additional_text Text, mit dem ein Anwender aufgefordert wird, 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 diese Option auf „wahr“ festgelegt ist, ist quantity_enabled immer „falsch“.
    Gültige Werte:
    • „wahr“: „Kapazität“ sollte angezeigt werden.
    • „falsch“: Kapazität darf nicht angezeigt werden.

    Datentyp: Boolesch
    result.flexible_services.flexible_service.​flexible_service.category Die 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 dem reservierbaren Element hinzugefügten Service benötigt wird.

    Datentyp: Zahl

    Einheit: Millisekunden
    result.flexible_services.flexible_service.​flexible_service.image Link zum Bild 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.Preis_pro_Einheit 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 Bei der Berechnung der Kosten zu verwendender Währungscode, 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 diese Option auf „wahr“ festgelegt ist, ist capacity_enabled immer „falsch“.
    Gültige Werte:
    • „wahr“: „Menge“ sollte angezeigt werden.
    • „falsch“: Menge darf nicht angezeigt werden.

    Datentyp: Boolesch
    result.flexible_services.flexible_service.​flexible_service.quantity_required Kennzeichnung, die angibt, ob die Menge erforderlich ist.
    Gültige Werte:
    • wahr: Menge ist erforderlich.
    • „false“: Menge ist nicht erforderlich.

    Datentyp: Boolesch

    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 Name der Unterkategorie des flexiblen Services, z. B. „%C3%A4%B6%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%_%%%%%%%%%%%%%%%%%%%%%%%%%%%%%].

    Datentyp: Zeichenfolge
    result.flexible_services.flexible_service.​flexible_service.sub_category_label Bezeichnung der Unterkategorie des flexiblen Service, z. B. Anordnung der Stühle.

    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, mit dem ein Anwender aufgefordert wird, flexible Services auszuwählen.

    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 Name des Untertitels des übergeordneten flexiblen Service.

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

    Befindet sich in der Tabelle „Stockwerk“ [sn_wsd_core_stockwerk].

    "floor": {
  "display_value": "String",
  "sys_id": "String"
}
    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 in der Stockwerkstabelle.

    Datentyp: Zeichenfolge
    result.image Details zu einem Bild, das das zugeordnete reservierbare Element darstellt.

    Befindet sich in der Tabelle „Images“ [db_image].

    "image": {
  "link": "String",
  "sys_id": "String"
}
    result.image.link Link zu einem Bild, das das reservierbare Element darstellt.

    Datentyp: Zeichenfolge
    result.image.sys_id Sys_id des zugeordneten Image-Datensatzes.

    Datentyp: Zeichenfolge
    result.is_reservable 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: Boolesch
    ergebnisse.layouts Wird nur ausgefüllt, wenn der Parameter include_layouts auf „wahr“ festgelegt ist.

    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"
  }
]
    Ergebnis.Layouts.Kapazität Anzahl der Personen, die an der Besprechung teilnehmen

    Datentyp: Zahl
    result.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 zugeordnete reservierbare Element darstellt.

    Befindet sich in der Tabelle „Images“ [db_image].

    "image": {
  "link": "String",
  "sys_id": "String"
}
    result.layouts.image.link Link zu einem Bild, das das Layout für dieses reservierbare Element darstellt. Befindet sich in der Tabelle „Images“ [db_image].

    Datentyp: Zeichenfolge
    result.layouts.image.sys_id Sys_id des zugeordneten Image-Datensatzes.

    Datentyp: Zeichenfolge
    result.layouts.is_default Kennzeichnung, die angibt, ob das zugeordnete Layout der Standard für das reservierbare Element ist.
    Gültige Werte:
    • true: Standard.
    • false: Nicht Standard.

    Datentyp: Boolesch
    result.layouts.max_capacity Maximale Anzahl von Personen, die das dem reservierbaren Element zugeordnete Layout aufnehmen kann.

    Datentyp: Zahl
    result.layouts.name Name des Standortlayouts

    Datentyp: Zeichenfolge
    result.layouts.preparation_duration Zeit, die zur Vorbereitung des zugehörigen Standortlayouts benötigt wird.

    Datentyp: Zahl

    Einheit: Millisekunden
    result.layouts.short_description Kurze Beschreibung des Standortlayouts.

    Datentyp: Zeichenfolge
    result.layouts.sys_id Sys_id des Standortlayouts.

    Befindet sich in der Tabelle „Layout“ [sn_wsd_rsv_layout].

    Datentyp: Zeichenfolge
    result.location_type Details zum Standorttyp des reservierbaren Elements, z. B. Arbeitsplatz/Schreibtisch, Café oder Studio.

    Befindet sich in der Tabelle „Platztyp“ [sn_wsd_core_space_type].

    "location_type": {
  "display_value": "String",
  "sys_id": "String"
}
    result.location_type.display_value Anzeigewert des Ortstyps.

    Datentyp: Zeichenfolge
    result.location_type.sys_id Sys_id des zugeordneten Datensatzes in der Tabelle „Platztyp“ [sn_wsd_core_space_type].

    Datentyp: Zeichenfolge
    result.meetingProviders Details zu den Anbietern virtueller Besprechungen, die dem reservierbaren Element zugeordnet sind.

    Diese Informationen befinden sich in der Tabelle „Anbieter für virtuelle Besprechungen“ [sn_wsd_rsv_virtual_meeting_provider].

    "meetingProviders": [
  {
    "display_value": "String",
    "value": "String"
  }
]
    result.meetingProviders.display_value Anzeigewert des Namens des virtuellen Anbieters.

    Datentyp: Zeichenfolge
    result.meetingProviders.value Ist-Wert für den Namen des virtuellen Anbieters im Datensatz.

    Datentyp: Zeichenfolge
    result.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 besser lesbar als die sys_id.

    Datentyp: Zeichenfolge
    Ergebnis.Reihenfolge Auftragsnummer für das reservierbare Element.

    Datentyp: Zahl
    result.require_approval Kennzeichnung, die angibt, ob für das Reservieren des reservierbaren Elements eine Genehmigung erforderlich ist.
    Mögliche Werte:
    • true: Genehmigung erforderlich.
    • „false“: Eine Genehmigung ist nicht erforderlich.

    Datentyp: Boolesch
    result.requires_check_in Kennzeichnung, die angibt, ob der Anwender für das reservierbare Element einchecken muss.
    Gültige Werte:
    • true: Check-in erforderlich.
    • „false“: Einchecken ist nicht erforderlich.

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

    Datentyp: Boolesch
    Ergebnis.reservierbare_Menge Maximale Anzahl, wie oft das zugeordnete reservierbare Element für dieselbe Zeit reserviert werden kann. Dieser Wert wird verwendet, wenn Arbeitsbereichsbereiche einem Bereich zugewiesen werden.

    Datentyp: Ganzzahl
    result.site Details zum Standort, auf dem sich das reservierbare Element befindet.

    Befindet sich in der Tabelle „Site“ [sn_wsd_core_site].

    "site": {
  "display_value": "String",
  "sys_id": "String"
}
    result.site.display_value Anzeigewert der Site.

    Datentyp: Zeichenfolge
    result.standard_services Wird nur ausgefüllt, wenn der Parameter include_standard_services auf „wahr“ festgelegt ist.
    Zugehörige Standardservices, z. B. Flipchart, Bildschirmprojektor sowie Whiteboard und Marker.

    Datentyp: Array von Objekten

    "standard_services": [
  {
    "font_awesome_icon": "String",
    "name": "String",
    "short_description": "String",
    "sys_id": "String"
  }
]
    Ergebnis.Standard_Services.Schriftart_aweso_Symbol Name des Miniatursymbols, das dem Standardservice zugeordnet ist.

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

    Datentyp: Zeichenfolge
    result.standard_services.short_description Kurze Beschreibung des Standardservice.

    Datentyp: Zeichenfolge
    result.standard_services.sys_id Sys_id des Standardservicedatensatzes. Befindet sich in der Tabelle „Standardservice“ [sn_wsd_rsv_standard_service].

    Datentyp: Zeichenfolge
    result.site.sys_id Sys_id des zugeordneten Site-Datensatzes in der Site-Tabelle [sn_wsd_core_site].

    Datentyp: Zeichenfolge
    result.tableName Name der Tabelle, in der sich der reservierbare Datensatz befindet.

    Datentyp: Zeichenfolge
    Ergebnis.Titel Titel des reservierbaren Elements.

    Datentyp: Zeichenfolge
    result.type 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. In diesem Beispiel werden Details zu allen im Anforderungstext aufgeführten reservierbaren Elementen zurückgegeben.

    {
  "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": []
    }
  ]
}