WSD-Mehrfachreservierungs-API

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

    • Die Mehrfachreservierungs- API Workplace Service Delivery (WSD) bietet Endpunkte für die Verwaltung von Reservierungen mit mehreren Arbeitsplatzstandorten.

    Um auf diese API zuzugreifen, muss der Anrufer über die Rolle „sn_wsd_core.workplace_user“ verfügen, und die Plugins „Workplace Safety Management“ (sn_wsd_core) und „Workplace Reservation Management“ (sn_wsd_rsv) müssen aktiviert sein.

    Diese API wird im Namespace sn_wsd_rsv ausgeführt.

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

    WSD-Mehrfachreservierung – PATCH /api/sn_wsd_rsv/multi_reservation/cancel/{sys_id}

    Storniert eine angegebene Mehrfachreservierung.

    URL-Format

    URL mit Versionsnummer: /api/sn_wsd_rsv/{api_version}/multi_reservation/cancel/{sys_id}

    Standard-URL: /api/sn_wsd_rsv/multi_reservation/cancel/{sys_id}

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    sys_id Sys_id der zu stornierenden Mehrfachreservierung. Befindet sich in der Tabelle „Arbeitsplatzreservierung“ [sn_wsd_rsv_reservation].

    Datentyp: Zeichenfolge
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 3. Anforderungstextparameter
    Name Beschreibung
    cancel_notes Grund für die Stornierung der Reservierung.

    Datentyp: Zeichenfolge

    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 Anforderungstexts. Unterstützte Typen: application/json, application/xml oder, text/xml

    Standard: application/json
    Content-Type Datenformat des Anforderungstexts. 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.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts

    Name Beschreibung
    Ergebnis Details der Ergebnisse der Abbruchanforderung.

    Datentyp: Objekt

    "result": {
  "error": "String",
  "parent": "String",
  "success": Boolean,
  "successfulReservations": [Array],
  "unSuccessfulReservations": [Array]
}
    result.error Meldung, die den zugeordneten Fehler beschreibt.

    Datentyp: Zeichenfolge
    result.parent Sys_id der übergeordneten Reservierung. Einem übergeordneten Element können eine oder mehrere untergeordnete Reservierungen zugeordnet sein.

    Datentyp: Zeichenfolge
    Ergebnis.Erfolg Kennzeichnung, die angibt, ob die Reservierung erfolgreich storniert wurde.
    Mögliche Werte:
    • true: Erfolgreich abgebrochen.
    • „falsch“: Reservierung wurde nicht storniert.

    Datentyp: Boolesch
    result.successfulReservations Details zur erfolgreichen Stornierung der Mehrfachreservierung.

    Datentyp: Array von Objekten

    "successfulReservations": [
  {
    "msg": "String",
    "success": Boolean,
    "sys_id": "String"
  }
]
    result.successfulReservations.msg Abbruchnachricht.

    Datentyp: Zeichenfolge
    Ergebnis.ErfolgreicheReservierungen.Erfolg Kennzeichnung, die angibt, obeter die Reservierung erfolgreich storniert wurde.
    Mögliche Werte:
    • true: Erfolgreich abgebrochen.
    • „falsch“: Vorgang fehlgeschlagen.

    Datentyp: Boolesch
    result.successfulReservations.sys_id Sys_id der Reservierung, die storniert wurde. Befindet sich in der Tabelle „Arbeitsplatzreservierung“ [sn_wsd_rsv_reservation].

    Datentyp: Zeichenfolge
    result.unSuccessfulReservations Details zur nicht erfolgreichen Stornierung der Mehrfachreservierung.

    Datentyp: Array von Objekten

    "unSuccessfulReservations": [
  {
    "msg": "String",
    "success": Boolean,
    "sys_id": "String"
  }
]
    result.unSuccessfulReservations.msg Abbruchnachricht.

    Datentyp: Zeichenfolge
    Ergebnis.nichtErfolgreicheReservierungen.Erfolg Kennzeichnung, die angibt, ob die Reservierung erfolgreich storniert wurde.
    Mögliche Werte:
    • true: Erfolgreich abgebrochen.
    • „falsch“: Vorgang fehlgeschlagen.

    Datentyp: Boolesch
    result.unSuccessfulReservations.sys_id Sys_id der Reservierung, die nicht storniert wurde. Befindet sich in der Tabelle „Arbeitsplatzreservierung“ [sn_wsd_rsv_reservation].

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie Sie eine Mehrfachreservierung stornieren.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/multi_reservation/cancel/1b1fdf5987ab01506342b846dabb35ec" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"cancel_notes\":\"Meeting no longer needed.\"}" \ 
--user "username":"password’"

    Ergebnisse zurückgeben:

    {
  "result": {
    "success": true,
    "successfulReservations": [
      {
        "success": true,
        "msg": "Cancelled successfully.",
        "sys_id": "5b1f9f1d87ab01506342b846dabb35a4"
      },
      {
        "success": true,
        "msg": "Cancelled successfully.",
        "sys_id": "931f9f1d87ab01506342b846dabb35a0"
      }
    ],
    "unSuccessfulReservations": [],
    "error": null,
    "parent": "1b1fdf5987ab01506342b846dabb35ec"
  }
}

    WSD-Mehrfachreservierung – PATCH /api/sn_wsd_rsv/multi_reservation/update/{sys_id}

    Aktualisiert die Reservierungen, die einer Mehrfachreservierung zugeordnet sind, wenn dieselbe Reservierung (Besprechung) mehrere Arbeitsplatzstandorte hat.

    Dieser Endpunkt kann vier verschiedene Update-Szenarien verarbeiten:
    1. Aktualisieren Sie den Inhalt des Mehrfachreservierungsdatensatzes, z. B. Betreff, Datum oder Uhrzeit.
    2. Konvertieren Sie die Mehrfachreservierung basierend auf dem übergeordneten Element in eine Einzelreservierung (Reservierung für einen einzelnen Arbeitsplatzstandort).
    3. Wandeln Sie eine Einzelreservierung (Reservierung für einen einzelnen Arbeitsplatzstandort) in eine Mehrfachreservierung um.
    4. Fügen Sie einer vorhandenen Mehrfachreservierung einen Arbeitsplatzstandort hinzu, oder entfernen Sie ihn.

    URL-Format

    URL mit Versionsnummer: /api/sn_wsd_rsv/{api_version}/multi_reservation/update/{sys_id}

    Standard-URL: /api/sn_wsd_rsv/multi_reservation/update/{sys_id}

    Unterstützte Anforderungsparameter

    Tabelle : 7. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    sys_id Sys_id der zu aktualisierenden Reservierung.
    • Einzelreservierung zu Mehrfachreservierung: Sys_id der Einzelreservierung. Befindet sich in der Tabelle „Arbeitsplatzreservierung“ [sn_wsd_rsv_reservation].
    • Inhalt der Mehrfachreservierung aktualisieren: Sys_id des übergeordneten Reservierungsdatensatzes. Befindet sich in der Tabelle „Arbeitsplatzreservierung“ [sn_wsd_rsv_reservation].

    Um die Details einer mehrfach übergeordneten Reservierung aus dem untergeordneten Datensatz abzurufen, beziehen Sie sich auf die sys_id im Feld „source_reservation“ des untergeordneten Datensatzes.

    Datentyp: Zeichenfolge
    Tabelle : 8. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 9. Anforderungstextparameter
    Name Beschreibung
    end Erforderlich, wenn der Parameter shift nicht übergeben wird. Angeforderte Endzeit der Reservierung.

    Datentyp: Zeichenfolge

    Format: UTC oder Ortszeit (JJJJ-MM-TT hh:mm:ss)
    requested_for Sys_id oder E-Mail-Adresse des Anwenders, für den die Reservierung vorgenommen wird. Befindet sich in der Tabelle „Benutzer“ [sys_user].

    Datentyp: Zeichenfolge
    reservierbare Elemente Liste mit Details zu den reservierbaren Elementen, die der Reservierung zugeordnet sind.

    Datentyp: Array von Objekten

    "reservables": [
  {
    "is_private": Boolean,
    "sys_id": "String"
  }
]
    reservables.is_private Kennzeichnung, die angibt, ob die Reservierung privat ist. Bei einer privaten Reservierung ist die Reservierung nur für den Besitzer sichtbar.

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

    Gültige Werte:
    • „wahr“: Reservierung ist privat.
    • false: Reservierung ist nicht privat.

    Datentyp: Boolesch

    Standard: Wert, der für Datenschutz in den Systemeigenschaften festgelegt ist.
    reservables.sys_id Sys_id des Standorts, an dem die Reservierungen vorgenommen werden sollen. Zu finden in der Tabelle „Arbeitsplatzstandort“ [sn_wsd_core_workplace_location].

    Datentyp: Zeichenfolge
    reservable_module Erforderlich. Sys_id des reservierbaren Moduls, das der Reservierung zugeordnet werden soll. Ein reservierbares Modul definiert die Arbeitsplatzelemente, die für eine Reservierung erforderlich sind. Befindet sich in der Tabelle „Reservierbares Modul“ [sn_wsd_rsv_reservable_module].

    Datentyp: Zeichenfolge
    Schicht
    Sys_id der Schicht, die der Reservierung zugeordnet werden soll. Befindet sich in der Tabelle „Schicht“ [sn_wsd_core_shift]. Wenn dieser Parameter übergeben wird, ist der Parameter end nicht erforderlich.

    Weitere Informationen zu schichtbasierten Reservierungen finden Sie unter Schichtbasierte Reservierung aktivieren.

    Datentyp: Zeichenfolge
    start Erforderlich. Angeforderte Startzeit der Reservierung.

    Datentyp: Zeichenfolge

    Format: UTC oder Ortszeit (JJJJ-MM-TT hh:mm:ss)
    Betreff
    Betreff des Meetings, das der Reservierung zugeordnet ist.

    Datentyp: Zeichenfolge

    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 : 10. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Anforderungstexts. Unterstützte Typen: application/json, application/xml oder, text/xml

    Standard: application/json
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 11. 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 : 12. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts

    Name Beschreibung
    Ergebnis Geben Sie Ergebnisse aus der Mehrfachreservierungserstellung oder -aktualisierung zurück.

    Datentyp: Objekt

    "result": {
  "parent": "String",
  "success": Boolean,
  "successfulReservations": Array,
  "unSuccessfulReservations": Array
}
    result.parent Sys_id der übergeordneten Reservierung. Einem übergeordneten Element können eine oder mehrere untergeordnete Reservierungen zugeordnet sein.

    Datentyp: Zeichenfolge
    Ergebnis.Erfolg Kennzeichnung, die angibt, ob die Reservierung erfolgreich erstellt wurde.
    Mögliche Werte:
    • true: erfolgreich erstellt.
    • „falsch“: Vorgang fehlgeschlagen.

    Datentyp: Boolesch
    result.successfulReservations Liste der Reservierungen, die erfolgreich erstellt wurden.

    Datentyp: Array

    "successfulReservations": [
  {
    "cancelled": Boolean,
    "error": "String",
    "reservable": "String"
    "success": Boolean,
    "sys_id": "String",
    "updated": Boolean
  }
]
    Ergebnis.ErfolgreicheReservierungen.Abgebrochen Kennzeichnung, die angibt, ob die Reservierung erfolgreich storniert wurde.
    Mögliche Werte:
    • true: Erfolgreich abgebrochen.
    • false: Nicht abgebrochen.

    Datentyp: Boolesch
    Ergebnis.ErfolgreicheReservierungen.Fehler Fehlermeldung, wenn beim Erstellen der Reservierung ein Problem aufgetreten ist.

    Datentyp: Zeichenfolge
    Ergebnis.ErfolgreicheReservierungen.einfügen Kennzeichnung, die angibt, ob die Reservierung erfolgreich eingefügt wurde. Zum Beispiel, wenn eine Reservierung hinzugefügt wird.
    Mögliche Werte:
    • true: Erfolgreich eingefügt.
    • „falsch“: Vorgang fehlgeschlagen.

    Datentyp: Boolesch
    result.successfulReservations.reservable Sys_id des Arbeitsplatzes, für den die Reservierung vorgenommen wurde. Zu finden in der Tabelle „Arbeitsplatzstandort“ [sn_wsd_core_workplace_location].

    Datentyp: Zeichenfolge
    Ergebnis.ErfolgreicheReservierungen.Erfolg Kennzeichnung, die angibt, ob der zugeordnete Vorgang erfolgreich war.
    Mögliche Werte:
    • wahr: Vorgang war erfolgreich.
    • „falsch“: Vorgang fehlgeschlagen.

    Datentyp: Boolesch
    result.successfulReservations.sys_id Sys_id der erstellten Reservierung. Befindet sich in der Tabelle „Arbeitsplatzreservierung“ [sn_wsd_rsv_reservation].

    Datentyp: Zeichenfolge
    result.successfulReservations.update Kennzeichnung, die angibt, ob die Reservierung erfolgreich aktualisiert wurde.
    Mögliche Werte:
    • true: erfolgreich aktualisiert.
    • „false“: Nicht aktualisiert.

    Datentyp: Boolesch
    result.unSuccessfulReservations Liste der Reservierungen, die nicht erfolgreich waren.

    Datentyp: Array

    "unSuccessfulReservations": [
  {
    "cancelled": Boolean,
    "error": "String",
    "insert": Boolean
    "reservable": "String"
    "success": Boolean,
    "sys_id": "String",
    "updated": Boolean
  }
]
    Ergebnis.nichtErfolgreicheReservierungen.abgebrochen Kennzeichnung, die angibt, ob die Reservierung erfolgreich storniert wurde.
    Mögliche Werte:
    • true: Erfolgreich abgebrochen.
    • false: Nicht abgebrochen.

    Datentyp: Boolesch
    Ergebnis.unErfolgreicheReservierungen.Fehler Fehlermeldung, wenn beim Erstellen der Reservierung ein Problem aufgetreten ist.

    Datentyp: Zeichenfolge
    result.unSuccessfulReservations.insert Kennzeichnung, die angibt, ob die Reservierung erfolgreich eingefügt wurde.
    Mögliche Werte:
    • true: Erfolgreich eingefügt.
    • „falsch“: Vorgang fehlgeschlagen.

    Datentyp: Boolesch
    Ergebnis.unErfolgreicheReservierungen.reservierbar Sys_id des Arbeitsplatzes, für den die Reservierung vorgenommen werden soll. Zu finden in der Tabelle „Arbeitsplatzstandort“ [sn_wsd_core_workplace_location].

    Datentyp: Zeichenfolge
    Ergebnis.nichtErfolgreicheReservierungen.Erfolg Kennzeichnung, die angibt, ob die Reservierung erfolgreich erstellt wurde.
    Mögliche Werte:
    • true: erfolgreich erstellt.
    • „falsch“: Vorgang fehlgeschlagen.

    Datentyp: Boolesch
    result.unSuccessfulReservations.sys_id Sys_id der nicht erfolgreichen Reservierung.

    Immer null.

    Datentyp: Zeichenfolge
    result.unSuccessfulReservations.update Kennzeichnung, die angibt, ob die Reservierung erfolgreich aktualisiert wurde.
    Mögliche Werte:
    • true: erfolgreich aktualisiert.
    • „false“: Nicht aktualisiert.

    Datentyp: Boolesch

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie Sie den Inhalt einer vorhandenen Mehrfachreservierung ändern.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/multi_reservation/update/02000d4edb7650106c731dcd13961914" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"reservables\":[
        { 
            \"sys_id\":\"fe1f744edb7650106c731dcd139619ca\" 
        }, 
        {
            \"sys_id\":\"02000d4edb7650106c731dcd13961914\"
        }
    ],
    \"reservable_module\":\"c31241cedb7650106c731dcd13961917\",
    \"subject\":\"Test 1\",
    \"start\":\"2022-05-27 13:00:00\",
    \"end\":\"2022-05-27 14:00:00\",
    \"requested_for\": \"workplace_user@example.com\"
}" \
--user 'username':'password'

    Ergebnisse zurückgeben:

    {
  "result": {
    "parent": "98ccb4348723cd106342b846dabb359a",
    "success": true,
    "successfulReservations": [
      {
        "success": true,
        "updated": true,
        "cancelled": false,
        "sys_id": "6cccb4348723cd106342b846dabb359d",
        "error": null,
        "reservable": "5eafb44edb7650106c731dcd13961943"
      },
      {
        "success": true,
        "updated": true,
        "cancelled": false,
        "sys_id": "74af283c87ef8d106342b846dabb3592",
        "error": null,
        "reservable": "fe1f744edb7650106c731dcd139619ca"
      }
    ],
    "unSuccessfulReservations": []
  }
}

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie Sie einer vorhandenen Mehrfachreservierung einen Arbeitsplatzstandort hinzufügen.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/multi_reservation/update/02000d4edb7650106c731dcd13961914" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   \"reservables\":[
       { 
           \"sys_id\":\"fe1f744edb7650106c731dcd139619ca\",
           \"is_private\": false 
       }, 
       {
           \"sys_id\":\"5eafb44edb7650106c731dcd13961943\",
           \"is_private\": false
       },
    {
           \"sys_id\":\"c4308d4edb7650106c731dcd1396194c\",
           \"is_private\": false
       }
   ],
   \"reservable_module\":\"c31241cedb7650106c731dcd13961917\",
   \"subject\":\"Test 1\",
   \"start\":\"2022-05-27 13:00:00\",
   \"end\":\"2022-05-27 14:00:00\",
   \"requested_for\": \"workplace_user@example.com\"
}" \
--user 'username':'password'

    Ergebnisse zurückgeben:

    {
  "result": {
    "parent": "98ccb4348723cd106342b846dabb359a",
    "success": true,
    "successfulReservations": [
      {
        "success": true,
        "updated": true,
        "cancelled": false,
        "sys_id": "6cccb4348723cd106342b846dabb359d",
        "error": null,
        "reservable": "5eafb44edb7650106c731dcd13961943"
      },
      {
        "success": true,
        "updated": true,
        "cancelled": false,
        "sys_id": "74af283c87ef8d106342b846dabb3592",
        "error": null,
        "reservable": "fe1f744edb7650106c731dcd139619ca"
      },
      {
        "success": true,
        "inserted": true,
        "sys_id": "9e6d78748723cd106342b846dabb35a5",
        "error": null,
        "reservable": "c4308d4edb7650106c731dcd1396194c"
      }
    ],
    "unSuccessfulReservations": []
  }
}

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie eine Einzelreservierung in eine Mehrfachreservierung konvertiert wird.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/multi_reservation/update/02000d4edb7650106c731dcd13961914" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   \"reservables\":[
       { 
           \"sys_id\":\"fe1f744edb7650106c731dcd139619ca\",
           \"is_private\": false
       }, 
       {
           \"sys_id\":\"5eafb44edb7650106c731dcd13961943\",
           \"is_private\": false
       }
   ],
   \"reservable_module\":\"c31241cedb7650106c731dcd13961917\",
   \"subject\":\"Test 1\",
   \"start\":\"2022-05-27 13:00:00\",
   \"end\":\"2022-05-27 14:00:00\",
   \"requested_for\": \"workplace_user@example.com\"
}" \
--user 'username':'password'

    Ergebnisse zurückgeben:

    {
  "result": {
    "success": true,
    "parent": "98ccb4348723cd106342b846dabb359a",
    "successfulReservations": [
      {
        "success": true,
        "inserted": true,
        "sys_id": "6cccb4348723cd106342b846dabb359d",
        "error": null,
        "reservable": "5eafb44edb7650106c731dcd13961943"
      },
      {
        "success": true,
        "insert": false,
        "update": true,
        "cancel": false,
        "sys_id": "74af283c87ef8d106342b846dabb3592",
        "reservable": "fe1f744edb7650106c731dcd139619ca"
      }
    ],
    "unSuccessfulReservations": [],
    "error": null
  }
}

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie eine Mehrfachreservierung in eine Einzelreservierung konvertiert wird.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/multi_reservation/update/02000d4edb7650106c731dcd13961914" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   \"reservables\":[
       { 
           \"sys_id\":\"fe1f744edb7650106c731dcd139619ca\",
           \"is_private\": false
       }
   ],
   \"reservable_module\":\"c31241cedb7650106c731dcd13961917\",
   \"subject\":\"Test 1\",
   \"start\":\"2022-05-27 13:00:00\",
   \"end\":\"2022-05-27 14:00:00\",
   \"requested_for\": \"workplace_user@example.com\"
}" \
--user 'username':'password'

    Ergebnisse zurückgeben:

    {
  "result": {
    "sys_id": "74af283c87ef8d106342b846dabb3592",
    "success": true,
    "successfulReservations": [
      {
        "success": true,
        "insert": false,
        "update": true,
        "cancel": false,
        "sys_id": "74af283c87ef8d106342b846dabb3592",
        "reservable": "fe1f744edb7650106c731dcd139619ca",
        "error": ""
      },
      {
        "success": true,
        "insert": false,
        "update": true,
        "cancel": true,
        "sys_id": "3caf283c87ef8d106342b846dabb3596",
        "reservable": "5eafb44edb7650106c731dcd13961943"
      }
    ],
    "unSuccessfulReservations": [],
    "error": null
  }
}

    WSD-Mehrfachreservierung – POST /api/sn_wsd_rsv/multi_reservation/add

    Erstellt Arbeitsplatzreservierungen für die gleiche Zeit an verschiedenen Arbeitsplatzstandorten.

    URL-Format

    URL mit Versionsnummer: /api/sn_wsd_rsv/{api_version}/multi_reservation/add

    Standard-URL: /api/sn_wsd_rsv/multi_reservation/add

    Unterstützte Anforderungsparameter

    Tabelle : 13. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    Tabelle : 14. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 15. Anforderungstextparameter
    Name Beschreibung
    end Erforderlich, wenn der Parameter shift nicht übergeben wird. Angeforderte Endzeit der Reservierung.

    Datentyp: Zeichenfolge

    Format: UTC oder Ortszeit (JJJJ-MM-TT hh:mm:ss)
    requested_for Sys_id oder E-Mail-Adresse des Anwenders, für den die Reservierung vorgenommen wird. Befindet sich in der Tabelle „Benutzer“ [sys_user].

    Datentyp: Zeichenfolge
    reservierbare Elemente Liste mit Details zu den reservierbaren Elementen, die der Reservierung zugeordnet sind.

    Datentyp: Array von Objekten

    "reservables": [
  {
    "is_private": Boolean,
    "sys_id": "String"
  }
]
    reservables.is_private Kennzeichnung, die angibt, ob die Reservierung privat ist. Bei einer privaten Reservierung ist die Reservierung nur für den Besitzer sichtbar.

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

    Gültige Werte:
    • „wahr“: Reservierung ist privat.
    • false: Reservierung ist nicht privat.

    Datentyp: Boolesch

    Standard: Wert, der für Datenschutz in den Systemeigenschaften festgelegt ist.
    reservables.sys_id Sys_id des Standorts, an dem die Reservierungen vorgenommen werden sollen. Zu finden in der Tabelle „Arbeitsplatzstandort“ [sn_wsd_core_workplace_location].

    Datentyp: Zeichenfolge
    reservable_module Erforderlich. Sys_id des reservierbaren Moduls, das der Reservierung zugeordnet werden soll. Ein reservierbares Modul definiert die Arbeitsplatzelemente, die für eine Reservierung erforderlich sind. Befindet sich in der Tabelle „Reservierbares Modul“ [sn_wsd_rsv_reservable_module].

    Datentyp: Zeichenfolge
    Schicht
    Sys_id der Schicht, die der Reservierung zugeordnet werden soll. Befindet sich in der Tabelle „Schicht“ [sn_wsd_core_shift]. Wenn dieser Parameter übergeben wird, ist der Parameter end nicht erforderlich.

    Weitere Informationen zu schichtbasierten Reservierungen finden Sie unter Schichtbasierte Reservierung aktivieren.

    Datentyp: Zeichenfolge
    start Erforderlich. Angeforderte Startzeit der Reservierung.

    Datentyp: Zeichenfolge

    Format: UTC oder Ortszeit (JJJJ-MM-TT hh:mm:ss)
    Betreff Erforderlich.
    Betreff des Meetings, das der Reservierung zugeordnet ist.

    Datentyp: Zeichenfolge

    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 : 16. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Anforderungstexts. Unterstützte Typen: application/json, application/xml oder, text/xml

    Standard: application/json
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 17. 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 : 18. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts

    Name Beschreibung
    Ergebnis Geben Sie Ergebnisse aus der Mehrfachreservierungserstellung oder -aktualisierung zurück.

    Datentyp: Objekt

    "result": {
  "parent": "String",
  "success": Boolean,
  "successfulReservations": Array,
  "unSuccessfulReservations": Array
}
    result.parent Sys_id der übergeordneten Reservierung. Einem übergeordneten Element können eine oder mehrere untergeordnete Reservierungen zugeordnet sein.

    Datentyp: Zeichenfolge
    Ergebnis.Erfolg Kennzeichnung, die angibt, ob die Reservierung erfolgreich erstellt wurde.
    Mögliche Werte:
    • true: erfolgreich erstellt.
    • „falsch“: Vorgang fehlgeschlagen.

    Datentyp: Boolesch
    result.successfulReservations Liste der Reservierungen, die erfolgreich erstellt wurden.

    Datentyp: Array

    "successfulReservations": [
  {
    "error": "String",
    "inserted": Boolean,
    "reservable": "String"
    "success": Boolean,
    "sys_id": "String"
  }
]
    Ergebnis.ErfolgreicheReservierungen.Fehler Fehlermeldung, wenn beim Erstellen der Reservierung ein Problem aufgetreten ist.

    Datentyp: Zeichenfolge
    Ergebnis.ErfolgreicheReservierungen.Eingefügt Kennzeichnung, die angibt, ob die Reservierung erfolgreich eingefügt wurde. Zum Beispiel, wenn eine Reservierung hinzugefügt wird.
    Mögliche Werte:
    • true: Erfolgreich eingefügt.
    • „falsch“: Vorgang fehlgeschlagen.

    Datentyp: Boolesch
    result.successfulReservations.reservable Sys_id des Arbeitsplatzes, für den die Reservierung vorgenommen wurde. Zu finden in der Tabelle „Arbeitsplatzstandort“ [sn_wsd_core_workplace_location].

    Datentyp: Zeichenfolge
    Ergebnis.ErfolgreicheReservierungen.Erfolg Kennzeichnung, die angibt, ob die Reservierung erfolgreich erstellt wurde.
    Mögliche Werte:
    • true: erfolgreich erstellt.
    • „falsch“: Vorgang fehlgeschlagen.

    Datentyp: Boolesch
    result.successfulReservations.sys_id Sys_id der erstellten Reservierung. Befindet sich in der Tabelle „Arbeitsplatzreservierung“ [sn_wsd_rsv_reservation].

    Datentyp: Zeichenfolge
    result.unSuccessfulReservations Liste der Reservierungen, die nicht erfolgreich waren.

    Datentyp: Array

    "unSuccessfulReservations": [
  {
    "error": "String",
    "inserted": Boolean,
    "reservable": "String"
    "success": Boolean,
    "sys_id": "String"
  }
]
    Ergebnis.unErfolgreicheReservierungen.Fehler Fehlermeldung, wenn beim Erstellen der Reservierung ein Problem aufgetreten ist.

    Datentyp: Zeichenfolge
    Ergebnis.nichtErfolgreicheReservierungen.eingefügt Kennzeichnung, die angibt, ob die Reservierung erfolgreich eingefügt wurde.
    Mögliche Werte:
    • true: Erfolgreich eingefügt.
    • „falsch“: Vorgang fehlgeschlagen.

    Datentyp: Boolesch
    Ergebnis.unErfolgreicheReservierungen.reservierbar Sys_id des Arbeitsplatzes, für den die Reservierung vorgenommen werden soll. Zu finden in der Tabelle „Arbeitsplatzstandort“ [sn_wsd_core_workplace_location].

    Datentyp: Zeichenfolge
    Ergebnis.nichtErfolgreicheReservierungen.Erfolg Kennzeichnung, die angibt, ob die Reservierung erfolgreich erstellt wurde.
    Mögliche Werte:
    • true: erfolgreich erstellt.
    • „falsch“: Vorgang fehlgeschlagen.

    Datentyp: Boolesch
    result.unSuccessfulReservations.sys_id Sys_id der nicht erfolgreichen Reservierung.

    Immer null.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Dieses Codebeispiel zeigt, wie Sie zwei verschiedene Arbeitsplätze für dieselbe Reservierung reservieren.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/multi_reservation/add" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"reservable_module\": \"c31241cedb7650106c731dcd13961917\",
    \"subject\": \"Test-123\",
    \"reservation_purpose\": \"meeting\",
    \"timezone\": \"US/Pacific\",
    \"requested_for\": \"6816f79cc0a8016401c5a33be04be441\",
    \"reservables\": [
        {
            \"sys_id\": \"fe1f744edb7650106c731dcd139619ca\",
            \"is_private\": false
        },
        {
            \"sys_id\": \"d1208d4edb7650106c731dcd1396194a\",
            \"is_private\": false
        }
    ],
    \"start\": \"2023-01-12T11:30:00Z\",
    \"end\": \"2023-01-12T12:30:00Z\",
    \"reservation_type\": \"space\"
}" \
--user "username":"password"

    Ergebnisse zurückgeben:

    {
  "result": {
    "success": true,
    "parent": "08e8a18687586550cfaa99b73cbb354f",
    "successfulReservations": [
      {
        "success": true,
        "inserted": true,
        "sys_id": "44e8a18687586550cfaa99b73cbb3552",
        "error": null,
        "reservable": "fe1f744edb7650106c731dcd139619ca"
      },
      {
        "success": true,
        "inserted": true,
        "sys_id": "04e8a18687586550cfaa99b73cbb3555",
        "error": null,
        "reservable": "d1208d4edb7650106c731dcd1396194a"
      }
    ],
    "unSuccessfulReservations": []
  }
}