WSD-Multi-Reservierungs-API
Die Workplace Service Delivery(WSD) Mehrfachreservierung Die API stellt Endpunkte für die Verwaltung von Reservierungen an mehreren Arbeitsplatzstandorten bereit.
Um auf diese API zuzugreifen, muss der Anrufer über die Rolle sn_wsd_Core.Workplace_user verfügen, und die Plugins „Arbeitsplatzsicherheitsmanagement“ (sn_wsd_Core) und „Arbeitsplatzreservierungsmanagement“ (sn_wsd_rsv) müssen aktiviert sein.
Diese API wird in ausgeführt sn_wsd_rsv Namespace.
Für zusätzliche Informationen zu Workplace Reservation Management, Siehe Management Von Arbeitsplatzreservierungen .
WSD-Mehrfachreservierung: PATCH /api/sn_wsd_rsv/Multi_reservation/Cancel/{sys_ID}
Bricht eine angegebene Mehrfachreservierung ab.
URL-Format
Versionierte URL: /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
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. 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 Mehrfachreservierung, die abgebrochen werden soll. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzreservierung [sn_wsd_rsv_reservation] |
| Name | Beschreibung |
|---|---|
| Keine |
| 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 .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Anforderungstexts. Unterstützte Typen: application/json, application/xmlOder, text/xml. Standard: application/json |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| 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 REST API-HTTP-Antwortcodes .
| 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 |
| Ergebnis.Fehler | Nachricht, die den zugehörigen Fehler beschreibt. Datentyp: Zeichenfolge |
| Ergebnis.übergeordnetes Element | 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:
Datentyp: Boolesch |
| Ergebnis.Erfolgsreservierungen | Details zur erfolgreichen Stornierung der Mehrfachreservierung. Datentyp: Array von Objekten |
| result.successfulReservations.msg | Abbruchnachricht. Datentyp: Zeichenfolge |
| Ergebnis.Erfolgsreservierungen.Erfolg | Kennzeichnung, die angibt, ob die Reservierung erfolgreich storniert wurde. Mögliche Werte:
Datentyp: Boolesch |
| Ergebnis.SuccessfulReservierungen.sys_ID | SYS_ID der stornierten Reservierung. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzreservierung [sn_wsd_rsv_reservation] |
| Ergebnis.nicht erfolgreiche Reservierungen | Details zur nicht erfolgreichen Stornierung der Mehrfachreservierung. Datentyp: Array von Objekten |
| result.unSuccessfulReservations.msg | Abbruchnachricht. Datentyp: Zeichenfolge |
| Ergebnis.nicht erfolgreiche Reservierungen.Erfolg | Kennzeichnung, die angibt, ob die Reservierung erfolgreich storniert wurde. Mögliche Werte:
Datentyp: Boolesch |
| Ergebnis.unSuccessfulReserations.sys_ID | SYS_ID der Reservierung, die nicht storniert wurde. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzreservierung [sn_wsd_rsv_reservation] |
cURL-Anforderung
Das folgende Codebeispiel zeigt, wie mehrere Reservierungen storniert werden.
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.
- Aktualisieren Sie den Inhalt des Datensatzes mit mehreren Reservierungen, z. B. Betreff, Datum oder Uhrzeit.
- Konvertieren Sie die Mehrfachreservierung basierend auf dem übergeordneten Element in eine einzelne Reservierung (Reservierung für einen einzelnen Arbeitsplatzstandort).
- Konvertieren Sie eine einzelne Reservierung (Reservierung für einen einzelnen Arbeitsplatzstandort) in eine Mehrfachreservierung.
- Fügen Sie einer vorhandenen Mehrfachreservierung einen Arbeitsplatzstandort hinzu oder entfernen Sie ihn.
URL-Format
Versionierte URL: /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
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. 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.
Informationen zum Abrufen der Details einer Reservierung mit mehreren übergeordneten Elementen aus dem untergeordneten Datensatz finden Sie unter sys_ID im Feld Source_reservation des untergeordneten Datensatzes. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Ende | Erforderlich, wenn shiftParameter wurde nicht übergeben. 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. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
| reservierbare Elemente | Liste der Details zu den reservierbaren Elementen, die der Reservierung zugeordnet sind. Datentyp: Array von Objekten |
| Reservierbar.is_privat | Kennzeichnung, die angibt, ob die Reservierung privat ist. Wenn privat, wird die Reservierung niemandem außer dem Besitzer angezeigt. Weitere Informationen zu diesen Datenschutzeinstellungen finden Sie unter Datenschutzeinstellungen für Standort und Auswirkung . Gültige Werte:
Datentyp: Boolesch Standard: Wert, der in den Systemeigenschaften für Datenschutz festgelegt ist. |
| Reservierbare Elemente.sys_ID | SYS_ID des Standorts, an dem die Reservierungen vorgenommen werden sollen. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzstandort [sn_wsd_Core_Workplace_location] |
| Reservierbares_Modul | Erforderlich. SYS_ID des reservierbaren Moduls, das der Reservierung zugeordnet werden soll. A Reservierbares Modul Definiert die für eine Reservierung erforderlichen Arbeitsplatzelemente. Datentyp: Zeichenfolge Tabelle: Reservierbares Modul [sn_wsd_rsv_reservable_Module] |
| Schicht | SYS_ID der Schicht, die der Reservierung zugeordnet werden soll. Wenn dieser Parameter übergeben wird, wird endParameter ist nicht erforderlich. Weitere Informationen zu schichtbasierten Reservierungen finden Sie unter Aktivieren Sie die schichtbasierte Reservierung . Datentyp: Zeichenfolge Tabelle: Schicht [sn_wsd_Core_Shift] |
| Start | Erforderlich. Angeforderte Startzeit der Reservierung. Datentyp: Zeichenfolge Format: UTC oder Ortszeit (jjjj-mm-tt hh:mm:ss) |
| subject | Betreff der Besprechung, die 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 .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Anforderungstexts. Unterstützte Typen: application/json, application/xmlOder, text/xml. Standard: application/json |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| 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 REST API-HTTP-Antwortcodes .
| 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 | Gibt Ergebnisse aus der Erstellung oder Aktualisierung mehrerer Reservierungen zurück. Datentyp: Objekt |
| Ergebnis.übergeordnetes Element | 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:
Datentyp: Boolesch |
| Ergebnis.Erfolgsreservierungen | Liste der Reservierungen, die erfolgreich erstellt wurden. Datentyp: Array von Objekten |
| result.successfulReservations.cancelled | Kennzeichnung, die angibt, ob die Reservierung erfolgreich storniert wurde. Mögliche Werte:
Datentyp: Boolesch |
| Ergebnis.Erfolgsreservierungen.Fehler | Fehlermeldung, wenn beim Erstellen der Reservierung ein Problem aufgetreten ist. Datentyp: Zeichenfolge |
| result.SuccessfulReservations.insert | Kennzeichnung, die angibt, ob die Reservierung erfolgreich eingefügt wurde. Z. B. wenn eine Reservierung hinzugefügt wird. Mögliche Werte:
Datentyp: Boolesch |
| Ergebnis.Erfolgsreservierungen.reservierbar | SYS_ID des Arbeitsplatzes, für den die Reservierung vorgenommen wurde. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzstandort [sn_wsd_Core_Workplace_location] |
| Ergebnis.Erfolgsreservierungen.Erfolg | Kennzeichnung, die angibt, ob der zugeordnete Vorgang erfolgreich war. Mögliche Werte:
Datentyp: Boolesch |
| Ergebnis.SuccessfulReservierungen.sys_ID | SYS_ID der erstellten Reservierung. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzreservierung [sn_wsd_rsv_reservation] |
| Ergebnis.Erfolgsreservierungen.Update | Kennzeichnung, die angibt, ob die Reservierung erfolgreich aktualisiert wurde. Mögliche Werte:
Datentyp: Boolesch |
| Ergebnis.nicht erfolgreiche Reservierungen | Liste der nicht erfolgreichen Reservierungen. Datentyp: Array von Objekten |
| result.unSuccessfulReservations.cancelled | Kennzeichnung, die angibt, ob die Reservierung erfolgreich storniert wurde. Mögliche Werte:
Datentyp: Boolesch |
| Ergebnis.unSuccessfulReservierungen.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:
Datentyp: Boolesch |
| Ergebnis.nicht erfolgreiche Reservierungen.reservierbar | SYS_ID des Arbeitsplatzes, für den die Reservierung vorgenommen werden wollte. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzstandort [sn_wsd_Core_Workplace_location] |
| Ergebnis.nicht erfolgreiche Reservierungen.Erfolg | Kennzeichnung, die angibt, ob die Reservierung erfolgreich erstellt wurde. Mögliche Werte:
Datentyp: Boolesch |
| Ergebnis.unSuccessfulReserations.sys_ID | SYS_ID der nicht erfolgreichen Reservierung. Immer null. Datentyp: Zeichenfolge |
| Ergebnis.unSuccessfulReservierungen.Update | Kennzeichnung, die angibt, ob die Reservierung erfolgreich aktualisiert wurde. Mögliche Werte:
Datentyp: Boolesch |
cURL-Anforderung
Das folgende Codebeispiel zeigt, wie der Inhalt einer vorhandenen Mehrfachreservierung geändert 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\"
},
{
\"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 einzelne Reservierung 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 einzelne Reservierung 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 – NACH /api/sn_wsd_rsv/Multi_reservation/add
Erstellt Arbeitsplatzreservierungen für die gleiche Zeit an verschiedenen Arbeitsplatzstandorten.
URL-Format
Versionierte URL: /api/sn_wsd_rsv/{api_Version}/Multi_reservation/add
Standard-URL: /api/sn_wsd_rsv/Multi_reservation/add
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Ende | Erforderlich, wenn shiftParameter wurde nicht übergeben. 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. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
| reservierbare Elemente | Liste der Details zu den reservierbaren Elementen, die der Reservierung zugeordnet sind. Datentyp: Array von Objekten |
| Reservierbar.is_privat | Kennzeichnung, die angibt, ob die Reservierung privat ist. Wenn privat, wird die Reservierung niemandem außer dem Besitzer angezeigt. Weitere Informationen zu diesen Datenschutzeinstellungen finden Sie unter Datenschutzeinstellungen für Standort und Auswirkung . Gültige Werte:
Datentyp: Boolesch Standard: Wert, der in den Systemeigenschaften für Datenschutz festgelegt ist. |
| Reservierbare Elemente.sys_ID | SYS_ID des Standorts, an dem die Reservierungen vorgenommen werden sollen. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzstandort [sn_wsd_Core_Workplace_location] |
| Reservierbares_Modul | Erforderlich. SYS_ID des reservierbaren Moduls, das der Reservierung zugeordnet werden soll. A Reservierbares Modul Definiert die für eine Reservierung erforderlichen Arbeitsplatzelemente. Datentyp: Zeichenfolge Tabelle: Reservierbares Modul [sn_wsd_rsv_reservable_Module] |
| Schicht | SYS_ID der Schicht, die der Reservierung zugeordnet werden soll. Wenn dieser Parameter übergeben wird, wird endParameter ist nicht erforderlich. Weitere Informationen zu schichtbasierten Reservierungen finden Sie unter Aktivieren Sie die schichtbasierte Reservierung . Datentyp: Zeichenfolge Tabelle: Schicht [sn_wsd_Core_Shift] |
| Start | Erforderlich. Angeforderte Startzeit der Reservierung. Datentyp: Zeichenfolge Format: UTC oder Ortszeit (jjjj-mm-tt hh:mm:ss) |
| subject | Erforderlich. Betreff der Besprechung, die 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 .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Anforderungstexts. Unterstützte Typen: application/json, application/xmlOder, text/xml. Standard: application/json |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| 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 REST API-HTTP-Antwortcodes .
| 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 | Gibt Ergebnisse aus der Erstellung oder Aktualisierung mehrerer Reservierungen zurück. Datentyp: Objekt |
| Ergebnis.übergeordnetes Element | 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:
Datentyp: Boolesch |
| Ergebnis.Erfolgsreservierungen | Liste der Reservierungen, die erfolgreich erstellt wurden. Datentyp: Array von Objekten |
| Ergebnis.Erfolgsreservierungen.Fehler | Fehlermeldung, wenn beim Erstellen der Reservierung ein Problem aufgetreten ist. Datentyp: Zeichenfolge |
| result.successfulReservations.inserted | Kennzeichnung, die angibt, ob die Reservierung erfolgreich eingefügt wurde. Z. B. wenn eine Reservierung hinzugefügt wird. Mögliche Werte:
Datentyp: Boolesch |
| Ergebnis.Erfolgsreservierungen.reservierbar | SYS_ID des Arbeitsplatzes, für den die Reservierung vorgenommen wurde. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzstandort [sn_wsd_Core_Workplace_location] |
| Ergebnis.Erfolgsreservierungen.Erfolg | Kennzeichnung, die angibt, ob die Reservierung erfolgreich erstellt wurde. Mögliche Werte:
Datentyp: Boolesch |
| Ergebnis.SuccessfulReservierungen.sys_ID | SYS_ID der erstellten Reservierung. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzreservierung [sn_wsd_rsv_reservation] |
| Ergebnis.nicht erfolgreiche Reservierungen | Liste der Reservierungen, die nicht erfolgreich waren. Datentyp: Array von Objekten |
| Ergebnis.unSuccessfulReservierungen.Fehler | Fehlermeldung, wenn beim Erstellen der Reservierung ein Problem aufgetreten ist. Datentyp: Zeichenfolge |
| result.unSuccessfulReservations.inserted | Kennzeichnung, die angibt, ob die Reservierung erfolgreich eingefügt wurde. Mögliche Werte:
Datentyp: Boolesch |
| Ergebnis.nicht erfolgreiche Reservierungen.reservierbar | SYS_ID des Arbeitsplatzes, für den die Reservierung vorgenommen werden wollte. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzstandort [sn_wsd_Core_Workplace_location] |
| Ergebnis.nicht erfolgreiche Reservierungen.Erfolg | Kennzeichnung, die angibt, ob die Reservierung erfolgreich erstellt wurde. Mögliche Werte:
Datentyp: Boolesch |
| Ergebnis.unSuccessfulReserations.sys_ID | SYS_ID der nicht erfolgreichen Reservierung. Immer null. Datentyp: Zeichenfolge |
cURL-Anforderung
Dieses Codebeispiel zeigt, wie zwei verschiedene Arbeitsplätze für dieselbe Reservierung reserviert werden.
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": []
}
}