WSD Reservierbare V2-API

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 15 Minuten Lesedauer

    • Die Workplace Service Delivery (WSD) Reservable V2- API ruft Details eines reservierbaren Elements, einer Entität, die reserviert werden kann, z. B. einen Arbeitsplatzstandort, aus einer ServiceNow -Instanz ab.

    Die WSD Reservable V2- API ist eine neue Version von WSD Reservierbare API. Die WSD Reservable V2- API ruft Details aller reservierbaren Plätze im WSD-Portal ab, die Sie bei der Reservierung auswählen. Die ursprüngliche Version der WSD Reservable-API verwendete einen GET-Aufruf, beschränkte jedoch den Pfadparameter sys_ID auf 35 Zeichen. Die neue API-Version WSD Reservable V2 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 im Namespace sn_wsd_rsv ausgeführt. Für den Zugriff auf diese API muss das Plugin „Workplace Reservation Management“ (sn_wsd_rsv) aktiviert sein.

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

    WSD Reservable 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 WSD Reservable-API verwendet.

    Datentyp: Zeichenfolge
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 3. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    space_sys_ids Erforderlich. Kommagetrennte sys_ids der ausgewählten Flächen.

    Datentyp: Zeichenfolge

    Standard: Leerer Wert

    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
    include_flexible_services Kennzeichnung, die angibt, ob die flexiblen Services, die dem reservierbaren 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 Flexible Services erstellen.

    Gültige Werte:
    • true: Gibt die Informationen zum flexiblen Service zurück.
    • false: Die Informationen zum flexiblen Service werden nicht zurückgegeben.

    Datentyp: Boolesch

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

    Ein Standardservice beschreibt grundlegende Vorkehrungen, die bei der Reservierung für ein reservierbares Arbeitsplatzelement verfügbar sind, 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:
    • true: Standardserviceinformationen zurückgeben.
    • false: Standardserviceinformationen nicht zurückgeben.

    Datentyp: Boolesch

    Standardwert: false
    include_reservable_zwecke Optional. Kennzeichnung, die angibt, ob der dem reservierbaren Element zugeordnete Zweck zurückgegeben werden soll.
    Gültige Werte:
    • true: Gibt den Zweck des reservierbaren Elements zurück.
    • false: Zweck des reservierbaren Elements nicht zurückgeben.

    Datentyp: Boolesch

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

    Zu den Informationen zum Standortlayout gehören Dinge 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:
    • true: Gibt die Informationen zum Standortlayout zurück.
    • false: Gibt die Informationen zum Standortlayout nicht zurück.

    Datentyp: Boolesch

    Standardwert: false

    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
    Content-Type 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 nicht gefunden.

    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:
    • true: Erlaubt Mitarbeitern, eingeladene Personen zur Reservierung hinzuzufügen.
    • false: Mitarbeiter dürfen 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"
}
    result.area.display_value 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 Gebäudetabelle [sn_wsd_core_building].

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

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

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

    Datentyp: Zeichenfolge
    result.building.timezone.value Interner Wert der Zeitzone, in der sich das zugeordnete Gebäude befindet.

    Datentyp: Zeichenfolge
    result.campus Campus, auf 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
    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 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.email E-Mail-Adresse, die dem reservierbaren Element zugeordnet ist.

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

    Weitere Informationen zu diesen Datenschutzeinstellungen finden Sie unter Standort-Datenschutzeinstellungen und Auswirkungen.

    Gültige Werte:
    • true: Benutzer können die Datenschutzeinstellung für das zugeordnete reservierbare Element überschreiben.
    • false: Benutzer können die Datenschutzeinstellung für das zugeordnete reservierbare Element nicht überschreiben.
    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_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:
    • true: Reservierungen sind standardmäßig privat.
    • false: 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 ist 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 Benutzer aufzufordern, zusätzliche flexible Services auszuwählen.

    Datentyp: Zeichenfolge
    result.flexible_services.allow_only_single_​service_item_selection Kennzeichnung, die angibt, ob Benutzer 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 einzelne Auswahl 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 zur Berechnung des Währungsbetrags bei der Bestellung 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, der verwendet wird, um einen Benutzer 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 diese Option auf „true“ festgelegt ist, ist quantity_enabled immer „false“.
    Gültige Werte:
    • true: Kapazität sollte angezeigt werden.
    • false: Kapazität sollte 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 Zeitdauer, 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 Zeitdauer, die benötigt wird, um den Service zum reservierbaren 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 Code-Parameter 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 „true“ festgelegt ist, ist capacity_enabled immer „false“.
    Gültige Werte:
    • true: Menge sollte angezeigt werden.
    • false: Menge sollte 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:
    • true: 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 Unterkategoriename des flexiblen Service, z. B. „stuhl_layout“.

    Datentyp: Zeichenfolge
    result.flexible_services.flexible_service.​flexible_service.sub_category_label Unterkategoriebezeichnung 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 Benutzer aufzufordern, 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 Benutzeroberflä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 Benutzeroberfläche verwendet wird.

    Datentyp: Zeichenfolge
    result.flexible_services.flexible_service.​flexible_service.title.edit Titel, der beim Bearbeiten eines untergeordneten flexiblen Service in der Benutzeroberfläche verwendet wird.

    Datentyp: Zeichenfolge
    result.flexible_services.flexible_service.label Bezeichnung für flexiblen Service.

    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
    result.flexible_services.flexible_service.text Text, der verwendet wird, um einen Benutzer aufzufordern, übergeordnete flexible Services 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 Benutzeroberflä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 Benutzeroberfläche verwendet wird.

    Datentyp: Zeichenfolge
    result.flexible_services.flexible_service.title.​Bearbeiten Titel, der beim Bearbeiten eines übergeordneten flexiblen Service in der Benutzeroberfläche verwendet wird.

    Datentyp: Zeichenfolge
    result.stockwerk Details zum Stockwerk, in dem sich das reservierbare Element befindet

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

    "floor": {
  "display_value": "String",
  "sys_id": "String"
}
    result.level.display_value Zeigen Sie die Nummer des Stockwerks an, in dem sich das reservierbare Element befindet, z. B. 12.

    Datentyp: Zeichenfolge
    result.stockwerk.sys_id Sys_id des zugeordneten Datensatzes in der Stockwerktabelle.

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

    Befindet sich in der Tabelle „Bilder“ [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:
    • true: Flexibler Service kann reserviert werden.
    • false: Flexibler Service kann nicht reserviert werden.

    Datentyp: Boolesch
    results.layouts Wird nur ausgefüllt, wenn der Parameter include_layouts auf „true“ 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"
  }
]
    result.layouts.capacity Anzahl der Personen, die an der Besprechung teilnehmen

    Datentyp: Zahl
    result.layouts.cleanup_duration Zeitdauer, die zum Bereinigen des reservierbaren Elements für dieses Layout benötigt wird.

    Datentyp: Zahl

    Einheit: Millisekunden
    result.layouts.image Details zu einem Bild, das das Layout für das zugeordnete reservierbare Element darstellt.

    Befindet sich in der Tabelle „Bilder“ [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 „Bilder“ [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 mit dem reservierbaren Element verknüpfte 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 Layouttabelle [sn_wsd_rsv_layout].

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

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

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

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

    Diese Informationen befinden sich in der Tabelle „Anbieter virtueller 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 Tatsächlicher 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
    result.number Eindeutiger Bezeichner des reservierbaren Elements Dieser Wert ist besser lesbar als die sys_id.

    Datentyp: Zeichenfolge
    result.order Reihenfolgennummer für das reservierbare Element.

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

    Datentyp: Boolesch
    result.requires_check_in Kennzeichnung, die angibt, ob der Benutzer 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 Benutzer bei der Reservierung einen Betreff eingeben muss.
    Gültige Werte:
    • true: Betreff erforderlich.
    • false: Betreff ist nicht erforderlich.

    Datentyp: Boolesch
    result.reservable_quantity Maximale Anzahl, wie oft das zugeordnete reservierbare Element für dieselbe Zeit reserviert werden kann. Dieser Wert wird verwendet, wenn aneinander angrenzende Bereiche einem Bereich zugewiesen werden.

    Datentyp: Ganzzahl
    result.site Details zum Standort, an 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 „true“ festgelegt ist.
    Zugehörige Standardservices, z. B. Flipchart, Bildschirm, Whiteboard und Marker.

    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 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
    result.title 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 reservierbaren Elementen zurückgegeben, 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": []
    }
  ]
}