API für zusätzlichen WSD-Service
Mit der Workplace Service Delivery (WSD) Extra Service- API können Sie zusätzliche Services abrufen, z. B. Standortlayouts und Standardservices eines Arbeitsplatzstandorts.
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 Extra Service Request – PATCH /api/sn_wsd_rsv/wsd_extra_service_request/reservation/{sys_id}
Gibt die zusätzlichen Serviceanforderungen zurück, die einer einzelnen Reservierung zugeordnet sind.
URL-Format
Versionierte URL: /api/sn_wsd_rsv/{api_version}/wsd_extra_service_request/reservation/{sys_id}
Standard-URL: /api/sn_wsd_rsv/wsd_extra_service_request/reservation/{sys_id}
Unterstützte Anforderungsparameter
| 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 des Reservierungsdatensatzes, für den die zusätzlichen Serviceanfragedetails zurückgegeben werden sollen. Befindet sich in der Tabelle „Arbeitsplatzreservierung“ [sn_wsd_rsv_reservation]. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
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 Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: 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 HTTP-Antwortcodesder REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. sys_id der Reservierung fehlt, ist ungültig oder nicht vorhanden. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 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 zur angegebenen zusätzlichen Serviceanfrage. Datentyp: Objekt |
| result.reservableId | Sys_id des Arbeitsplatzstandorts, für den die Reservierung erstellt wird. Befindet sich in der Tabelle „Arbeitsplatzstandort“ [sn_wsd_core_workplace_location]. Datentyp: Zeichenfolge |
| result.reservationId | Sys_id der Reservierung, für die die zusätzlichen Serviceanfragedetails zurückgegeben werden sollen. Befindet sich in der Tabelle „Arbeitsplatzreservierung“ [sn_wsd_rsv_reservation]. Datentyp: Zeichenfolge |
| result.serviceCategories | Details zur Servicekategorie der zugeordneten zusätzlichen Services. Datentyp: |
| result.serviceCategories.categoryRespondName | Benutzerfreundlicher Name der Kategorie des Arbeitsplatzservice oder zusätzlichen Service, z. B. Platzanordnung. Datentyp: Zeichenfolge |
| result.serviceCategories.categoryCurrencyCode | Währungscode, der zur Berechnung der Kosten des Arbeitsplatzservice-Elements oder zusätzlichen Service verwendet wird. Datentyp: Zeichenfolge |
| result.serviceCategories.comment | Kommentare zur Servicekategorie. Datentyp: Zeichenfolge |
| result.flexibleServices | Details zu jedem der Arbeitsplatzservice-Elemente oder zusätzlichen Services, die für die Reservierung angefordert wurden. Datentyp: Array von Objekten |
| result.serviceCategories.flexibleServices.capacity | Kapazität, die beim Anfordern des Arbeitsplatzservice-Elements angefordert wurde. Datentyp: Zahl |
| result.serviceCategories.flexibleServices.capacityEnabled | Kennzeichnung, die angibt, ob der Benutzer, der die Reservierung erstellt, die Kapazität des Arbeitsplatzes angeben kann. Gültige Werte:
Datentyp: Boolesch |
| result.serviceCategories.flexibleServices.category | Sys_id der Kategorie des Arbeitsplatzservice oder zusätzlichen Service, der der Reservierung zugeordnet ist. Datentyp: Zeichenfolge |
| result.serviceCategories.flexibleServices.categoryComment | Zusätzliche Kommentare zur Kategorie. Datentyp: Zeichenfolge |
| result.serviceCategories.flexibleServices.categoryPersonalName | Benutzerfreundlicher Name der Kategorie des Arbeitsplatzservice oder zusätzlichen Service, z. B. Platzanordnung. Datentyp: Zeichenfolge |
| result.serviceCategories.flexibleServices.comment | Zusätzliche Kommentare zum Arbeitsplatzservice-Element oder zusätzlichen Service. Datentyp: Zeichenfolge |
| result.serviceCategories.flexibleServices.currencyCode | Währungscode, der zur Berechnung der Kosten des zugehörigen Arbeitsplatzservice-Elements oder zusätzlichen Service verwendet wird. Datentyp: Zeichenfolge |
| result.serviceCategories.flexibleServices.deliveryTime | Lieferzeit des Arbeitsplatzservice-Elements oder zusätzlichen Service. Datentyp: Zeichenfolge Format: UTC - jjjj-mm-ttThh:mm:ssZ, z. B. 2021-02-05T18:00:00Z |
| result.serviceCategories.flexibleServices.flexibleServiceId | Sys_id des zusätzlichen Service- oder Arbeitsplatzservice-Elements. Befindet sich in der Tabelle [sn_wsd_case_workplace_service_item]. Datentyp: Zeichenfolge |
| result.serviceCategories.flexibleServices.flexibleServiceName | Name des zugeordneten zusätzlichen Service- oder Arbeitsplatzservice-Elements. Datentyp: Zeichenfolge |
| result.serviceCategories.flexibleServices.maxCapacity | Maximale Kapazität des Arbeitsplatzes, die angefordert werden kann. Datentyp: Zahl |
| result.serviceCategories.flexibleServices.quantity | Anzahl der angeforderten zusätzlichen Service-Elemente. Datentyp: Zahl |
| result.serviceCategories.flexibleServices.quantityAktiviert | Kennzeichnung, die angibt, ob der Benutzer, der die Reservierung erstellt, die Menge der Service-Artikel angeben kann. Gültige Werte:
Datentyp: Boolesch |
| result.serviceCategories.flexibleServices.requestId | Sys_id des zusätzlichen Service- oder Arbeitsplatzservice-Elements. Befindet sich in der Tabelle [sn_wsd_case_service_item_request]. Datentyp: Zeichenfolge |
| result.serviceCategories.flexibleServices.serviceItemImage | Dateiname des Miniaturbilds des Arbeitsplatzservice-Elements. Datentyp: Zeichenfolge |
| result.serviceCategories.flexibleServices.servicePrice | Kosten des Arbeitsplatzservice-Elements oder zusätzlichen Service. Datentyp: Zeichenfolge |
| result.serviceCategories.flexibleServices.serviceTimes | Details zur Zeit, die für die Vorbereitung und Bereinigung des Arbeitsplatzservice-Elements benötigt wird. Datentyp: Objekt |
| result.serviceCategories.flexibleServices.serviceTimes.endCleanup | Datum und Uhrzeit, zu der die Bereinigung des Arbeitsplatzservice-Elements endet. Datentyp: Zeichenfolge |
| result.serviceCategories.flexibleServices.serviceTimes.endPreparation | Datum und Uhrzeit des Endes der Vorbereitung des Arbeitsplatzservice-Elements. Datentyp: Zeichenfolge |
| result.serviceCategories.flexibleServices.serviceTimes.startCleanup | Datum und Uhrzeit, zu der die Bereinigung des Arbeitsplatzservice-Elements beginnt. Datentyp: Zeichenfolge |
| result.serviceCategories.flexibleServices.serviceTimes.startPreparation | Datum und Uhrzeit, zu der die Vorbereitung des Arbeitsplatzservice-Elements beginnt. Datentyp: Zeichenfolge |
| result.serviceCategories.flexibleServices.state | Details zum aktuellen Status des zugeordneten Arbeitsplatzservice-Elements. Datentyp: Objekt |
| result.serviceCategories.flexibleServices.state.display_value | Anzeigewert für den Status des Arbeitsplatzservice-Elements, z. B. Offen. Datentyp: Zeichenfolge |
| result.serviceCategories.flexibleServices.state.value | Interner Wert für den Status des Arbeitsplatzservice-Elements, z. B. „Offen“. Datentyp: Zeichenfolge |
| result.serviceCategories.flexibleServices.subCategory | Details zur Unterkategorie des zugeordneten Arbeitsplatzservice-Elements. Datentyp: Objekt |
| result.serviceCategories.flexibleServices.subCategory.display_value | Anzeigewert der Unterkategorie für das Arbeitsplatzservice-Element oder den zusätzlichen Service, z. B. Stuhllayout, Getränke oder IT-Support. Datentyp: Zeichenfolge |
| result.serviceCategories.flexibleServices.subCategory.value | Interner Wert der Unterkategorie des Arbeitsplatzservice-Elements oder zusätzlichen Service, z. B. „stuhl_layout“, „drinks“ oder „IT_support“. Datentyp: Zeichenfolge |
| result.serviceCategories.flexibleServices.total_price | Gesamtkosten des Arbeitsplatzservice-Elements oder zusätzlichen Service für die Reservierung. Datentyp: Zahl |
| result.serviceTimes | Details zur Zeit, die für die Vorbereitung und Bereinigung des Arbeitsplatzservice-Elements benötigt wird. Datentyp: Objekt |
| result.serviceTimes.endCleanup | Datum und Uhrzeit, zu der die Bereinigung des Arbeitsplatzservice-Elements endet. Datentyp: Zeichenfolge |
| result.serviceTimes.endPreparation | Datum und Uhrzeit des Endes der Vorbereitung des Arbeitsplatzservice-Elements. Datentyp: Zeichenfolge |
| result.serviceTimes.startCleanup | Datum und Uhrzeit, zu der die Bereinigung des Arbeitsplatzservice-Elements beginnt. Datentyp: Zeichenfolge |
| result.serviceTimes.startPreparation | Datum und Uhrzeit, zu der die Vorbereitung des Arbeitsplatzservice-Elements beginnt. Datentyp: Zeichenfolge |
cURL-Anforderung
Dieses Code-Beispiel zeigt, wie Sie die Details der zusätzlichen Services oder Arbeitsplatzservice-Elemente für eine Reservierung anfordern.
curl "http://instance.servicenow.com/api/sn_wsd_rsv/wsd_extra_service_request/reservation/383e36c1536f01103cf7ddeeff7b1245" \
--request GET \
--header "Accept:application/json" \
--user "username": "password"
Ergebnisse zurückgeben:
{
"result": {
"reservationId": "383e36c1536f01103cf7ddeeff7b1245",
"serviceTimes": {
"startPreparation": "2022-05-17T11:45:00ZZ",
"endPreparation": "2022-05-17T12:00:00ZZ",
"startCleanup": "2022-05-17T13:00:00ZZ",
"endCleanup": "2022-05-17T13:15:00ZZ"
},
"reservableId": "02000d4edb7650106c731dcd13961914",
"serviceCategories": {
"50723fbf07100110c9b36b6e0ad300b4": {
"serviceTimes": {
"startPreparation": "2022-05-17T11:45:00Z",
"endPreparation": "2022-05-17T12:00:00Z",
"startCleanup": "2022-05-17T13:00:00Z",
"endCleanup": "2022-05-17T13:15:00Z"
},
"flexibleServices": [
{
"requestId": "743eb605536f01103cf7ddeeff7b126b",
"category": "50723fbf07100110c9b36b6e0ad300b4",
"categoryComment": "test2",
"subCategory": {
"value": "chair_layout",
"display_value": "Chair layout"
},
"categoryFriendlyName": "Space arrangement",
"servicePrice": 0,
"serviceItemImage": "4c6a0d7107600110c9b36b6e0ad300fc.iix",
"currencyCode": "GBP",
"totalPrice": 0,
"flexibleServiceId": "21e2c08407600110c9b36b6e0ad3007c",
"flexibleServiceName": "Theater Style",
"deliveryTime": "2022-05-17 12:00:00",
"comment": "test1",
"quantity": 1,
"capacity": 1,
"quantityEnabled": false,
"capacityEnabled": true,
"maxCapacity": null,
"state": {
"value": "2",
"display_value": "Work in Progress"
},
"serviceTimes": {
"startPreparation": "2022-05-17T11:45:00Z",
"endPreparation": "2022-05-17T12:00:00Z",
"startCleanup": "2022-05-17T13:00:00Z",
"endCleanup": "2022-05-17T13:15:00Z"
}
}
],
"comment": "test2",
"categoryFriendlyName": "Space arrangement",
"categoryCurrencyCode": "GBP"
}
}
}
}
WSD Extra Service Request – PATCH /api/sn_wsd_rsv/wsd_extra_service_request/submit
Fügt einer angegebenen Einzelreservierung eine neue oder aktualisiert eine vorhandene zusätzliche Serviceanfrage hinzu.
URL-Format
Versionierte URL: /api/sn_wsd_rsv/{api_version}/wsd_extra_service_request/submit
Standard-URL: /api/sn_wsd_rsv/wsd_extra_service_request/submit
Unterstützte Anforderungsparameter
| 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 |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| reservierbare ID | Erforderlich. Sys_id des Arbeitsplatzstandorts, für den die Reservierung erstellt wird. Befindet sich in der Tabelle „Arbeitsplatzstandort“ [sn_wsd_core_workplace_location]. Datentyp: Zeichenfolge |
| Reservierungs-ID | Erforderlich. Sys_id der Reservierung, für die die zusätzlichen Serviceanforderungen hinzugefügt werden sollen. Befindet sich in der Tabelle „Arbeitsplatzreservierung“ [sn_wsd_rsv_reservation]. Datentyp: Zeichenfolge |
| serviceKategorien | Erforderlich. Liste der Arbeitsplatzservice-Elemente oder zusätzlichen Services, die der Reservierung hinzugefügt werden sollen. Datentyp: Array von Objekten |
| serviceCategories.category | Erforderlich. Sys_id oder Name des Arbeitsplatzservice, der der Reservierung hinzugefügt werden soll. Befindet sich in der Tabelle [sn_wsd_case_workplace_service. Datentyp: Zeichenfolge |
| serviceKategorien.Kommentar | Erforderlich. Kommentare zur Servicekategorie. Datentyp: Zeichenfolge |
| serviceKategorien.flexibleServices | Erforderlich. Details zu jedem der Arbeitsplatzservice-Elemente oder zusätzlichen Services, die der Reservierung hinzugefügt oder storniert werden sollen. Datentyp: Array von Objekten |
| serviceCategories.flexibleServices.cancelFlag | Kennzeichnung, die angibt, ob die angegebene zusätzliche Serviceanfrage abgebrochen werden soll. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| serviceKategorien.flexibleServices.Kommentar | Erforderlich. Zusätzliche Kommentare zum Arbeitsplatzservice-Element oder zusätzlichen Service. Datentyp: Zeichenfolge |
| serviceCategories.flexibleServices.deliveryTime | Erforderlich. Lieferzeit des Arbeitsplatzservice-Elements oder zusätzlichen Service. Datentyp: Zeichenfolge Format: UTC - jjjj-mm-ttThh:mm:ssZ, z. B. 2021-02-05T18:00:00Z |
| serviceCategories.flexibleServices.extraServiceRequestId | Sys_id der vorhandenen zusätzlichen Serviceanfrage. Geben Sie diesen Parameter an, um eine vorhandene zusätzliche Serviceanfrage zu aktualisieren. Befindet sich in der Tabelle [sn_wsd_case_service_item_request]. Datentyp: Zeichenfolge |
| serviceCategories.flexibleServices.flexibleServiceId | Erforderlich. Sys_id des zusätzlichen Service- oder Arbeitsplatzservice-Elements. Befindet sich in der Tabelle [sn_wsd_case_workplace_service_item]. Datentyp: Zeichenfolge |
| serviceCategories.flexibleServices.quantity | Erforderlich. Anzahl der angeforderten zusätzlichen Service-Elemente. Datentyp: Zahl |
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/xml oder 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 HTTP-Antwortcodesder REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 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 | Ergebnisse für die Anforderung zurückgeben. Datentyp: Objekt |
| result.extraServiceRequests | Details zur hinzugefügten oder stornierten zusätzlichen Serviceanfrage. Datentyp: Array von Objekten |
| result.extraServiceRequests.flexibleServiceId | Sys_id der Anforderung für zusätzliche Service-Elemente, die der Reservierung hinzugefügt wurde. Befindet sich in der Tabelle [sn_wsd_case_workplace_service_item]. Datentyp: Zeichenfolge |
| result.extraServiceRequests.requestId | Sys_id des zusätzlichen Service-Elements, das der Anforderung hinzugefügt wurde. Befindet sich in der Tabelle [sn_wsd_case_service_item_request]. Datentyp: Zeichenfolge |
| result.reservableId | Sys_id des Arbeitsplatzstandorts, für den die Reservierung erstellt wird. Befindet sich in der Tabelle „Arbeitsplatzstandort“ [sn_wsd_core_workplace_location]. Datentyp: Zeichenfolge |
| result.reservationId | Sys_id der Reservierung, für die die zusätzliche Serviceanfrage hinzugefügt wurde. Befindet sich in der Tabelle „Arbeitsplatzreservierung“ [sn_wsd_rsv_reservation]. Datentyp: Zeichenfolge |
| Ergebnis.Erfolg | Kennzeichnung, die angibt, ob die zusätzliche Serviceanfrage erfolgreich der Reservierung hinzugefügt wurde. Mögliche Werte:
Datentyp: Boolesch |
cURL-Anforderung
Das folgende Codebeispiel zeigt, wie einer Reservierung eine zusätzliche Service-Elementanforderung hinzugefügt wird.
curl "http://instance.servicenow.com/api/sn_wsd_rsv/wsd_extra_service_request/submit" \
--request POST \
--header "Accept:application/json" \
--header "Concept-Type:application/json" \
--user 'username':'password'
Ergebnisse zurückgeben:
{
"result": {
"reservationId": "2dc2efdf531701103cf7ddeeff7b1227",
"reservableId": "02000d4edb7650106c731dcd13961914",
"extraServiceRequests": [
{
"requestId": "bea46dbc53e701103cf7ddeeff7b1236",
"flexibleServiceId": "e2ecf7b307500110c9b36b6e0ad30033"
}
],
"success": true
}
}