WSD Extra-Service-API
Die Workplace Service Delivery(WSD) Zusätzlicher Service Die API stellt Endpunkte zum Abrufen zusätzlicher Services bereit, z. B. Standortlayouts und Standardservices eines Arbeitsplatzstandorts.
Um auf diese API zuzugreifen, muss der Anrufer über die Rolle sn_wsd_Core.Workplace_user verfügen.
Diese API wird in ausgeführt sn_wsd_rsv Namespace. Um auf diese API zuzugreifen, muss das Plugin „Workplace Reservation Management“ (sn_wsd_rsv) aktiviert sein.
Für zusätzliche Informationen zu Workplace Reservation Management, Siehe Management Von Arbeitsplatzreservierungen .
WSD Extra-Serviceanfrage – 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. 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 Serviceanforderungsdetails zurückgegeben werden sollen. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzreservierung [sn_wsd_rsv_reservation] |
| 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 REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Reservierungs-sys_ID 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 |
| Ergebnis.reservableId | SYS_ID des Arbeitsplatzstandorts, für den die Reservierung erstellt wird. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzstandort [sn_wsd_Core_Workplace_location] |
| Ergebnis.ReservierungId | SYS_ID der Reservierung, für die die zusätzlichen Serviceanforderungsdetails zurückgegeben werden sollen. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzreservierung [sn_wsd_rsv_reservation]. |
| result.serviceCategories | Details zur Servicekategorie der zugehörigen zusätzlichen Services. Datentyp: Objekt |
| result.serviceCategories.categoryFriendlyName | Anwenderfreundlicher Name der Kategorie des Arbeitsplatzservice oder zusätzlichen Service, z. B. Raumvereinbarung. Datentyp: Zeichenfolge |
| result.serviceCategories.CategoryCurrency Code | 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.serviceCategories.flexibleServices | Details zu jedem der Arbeitsplatzserviceelemente oder zusätzlichen Service, die für die Reservierung angefordert werden. Datentyp: Array von Objekten |
| result.serviceCategories.flexibleServices.Kapazität | Kapazität, die beim anfordern des Arbeitsplatzservice-Elements angefordert wird. Datentyp: Zahl |
| result.serviceCategories.flexibleServices.Kapazitätsaktiviert | Kennzeichnung, die angibt, ob der Anwender, der die Reservierung erstellt, die Kapazität des Arbeitsplatzes angeben kann. Mögliche Werte:
Datentyp: Boolesch |
| result.serviceCategories.flexibleServices.Kategorie | SYS_ID der Kategorie des Arbeitsplatzservice oder zusätzlichen Service, der der Reservierung zugeordnet ist. Datentyp: Zeichenfolge |
| result.serviceCategories.flexibleServices.KategorieKommentar | Zusätzliche Kommentare zur Kategorie. Datentyp: Zeichenfolge |
| result.serviceCategories.flexibleServices.CategoryFriendlyName | Anwenderfreundlicher Name der Kategorie des Arbeitsplatzservice oder zusätzlichen Service, z. B. Raumvereinbarung. Datentyp: Zeichenfolge |
| result.serviceCategories.flexibleServices.Kommentar | Zusätzliche Kommentare zum Arbeitsplatzserviceelement oder zum zusätzlichen Service. Datentyp: Zeichenfolge |
| result.serviceCategories.flexibleServices.CURRENCYCODE | Währungscode, der zur Berechnung der Kosten des zugehörigen Arbeitsplatzserviceelements oder zusätzlichen Service verwendet wird. Datentyp: Zeichenfolge |
| result.serviceCategories.flexibleServices.Lieferzeit | Lieferzeit des Arbeitsplatzservice-Elements oder zusätzlichen Service. Datentyp: Zeichenfolge Format: UTC – jjjj-mm-ddThh:mm:ssZ, z. B. 2021-02-05T18:00:00Z |
| result.serviceCategories.flexibleServices.Flexible ServiceId | SYS_ID des zusätzlichen Service- oder Arbeitsplatzservice-Elements. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzserviceelement [sn_wsd_Case_Workplace_Service_item] |
| result.serviceCategories.flexibleServices.FlexibleServiceName | Name des zugehörigen zusätzlichen Service- oder Arbeitsplatzservice-Elements. Datentyp: Zeichenfolge |
| result.serviceCategories.flexibleServices.Maximale Kapazität | Maximale Kapazität des Arbeitsplatzes, die angefordert werden kann. Datentyp: Zahl |
| result.serviceCategories.flexibleServices.Menge | Anzahl der angeforderten zusätzlichen Service-Elemente. Datentyp: Zahl |
| result.serviceCategories.flexibleServices.QuantityEnabled | Kennzeichnung, die angibt, ob der Anwender, der die Reservierung erstellt, die Menge der Service-Elemente angeben kann. Mögliche Werte:
Datentyp: Boolesch |
| result.serviceCategories.flexibleServices.RequestId | SYS_ID des zusätzlichen Service- oder Arbeitsplatzservice-Elements. Datentyp: Zeichenfolge Tabelle: Service anfordern [sn_wsd_Case_Service_item_Request] |
| result.serviceCategories.flexibleServices.ServiceItemImage | Dateiname des Miniaturbilds des Arbeitsplatzservice-Elements. Datentyp: Zeichenfolge |
| result.serviceCategories.flexibleServices.ServicePreis | Kosten des Arbeitsplatzservice-Elements oder zusätzlichen Service. Datentyp: Zeichenfolge |
| result.serviceCategories.flexibleServices.Servicezeiten | Details zur Zeit, die für die Vorbereitung und Bereinigung des Arbeitsplatzservice-Elements benötigt wird. Datentyp: Objekt |
| result.serviceCategories.flexibleServices.ServiceTimes.endBereinigung | Datum und Uhrzeit, zu der die Bereinigung des Arbeitsplatzservice-Elements endet Datentyp: Zeichenfolge |
| result.serviceCategories.flexibleServices.ServiceTimes.endVorbereitung | Datum und Uhrzeit, zu der die Vorbereitung des Arbeitsplatzservice-Elements endet Datentyp: Zeichenfolge |
| result.serviceCategories.flexibleServices.ServiceTimes.startBereinigen | Datum und Uhrzeit, zu der die Bereinigung des Arbeitsplatzservice-Elements beginnt. Datentyp: Zeichenfolge |
| result.serviceCategories.flexibleServices.ServiceTimes.startVorbereitung | Datum und Uhrzeit, zu der die Vorbereitung des Arbeitsplatzservice-Elements beginnt. Datentyp: Zeichenfolge |
| result.serviceCategories.flexibleServices.state | Details zum aktuellen Status des zugehörigen Arbeitsplatzserviceelements. Datentyp: Objekt |
| result.serviceCategories.flexibleServices.state.Display_value | Anzeigewert des Status des Arbeitsplatzservice-Elements, z. B. Offen. Datentyp: Zeichenfolge |
| result.serviceCategories.flexibleServices.state.Wert | Interner Wert des Status des Arbeitsplatzservice-Elements, z. B. Offen. Datentyp: Zeichenfolge |
| result.serviceCategories.flexibleServices.Unterkategorie | Details zur Unterkategorie des zugehörigen Arbeitsplatzservice-Elements. Datentyp: Objekt |
| result.serviceCategories.flexibleServices.Subcategory.Display_value | Anzeigewert der Unterkategorie für das Arbeitsplatzserviceelement oder den zusätzlichen Service, z. B. Stuhllayout, Getränke oder IT-Support. Datentyp: Zeichenfolge |
| result.serviceCategories.flexibleServices.Unterkategorie.Wert | Interner Wert der Unterkategorie des Arbeitsplatzservice-Elements oder zusätzlichen Service, z. B. Chair_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, zu der die Vorbereitung des Arbeitsplatzservice-Elements endet 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 Codebeispiel 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-Serviceanfrage – PATCH /api/sn_wsd_rsv/wsd_extra_Service_Request/Submit
Fügt einer angegebenen einzelnen Reservierung eine neue oder aktualisiert eine vorhandene zusätzliche Serviceanfrage.
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. 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 |
|---|---|
| ReservierungDateTimeChanged | Kennzeichnung, die angibt, ob sich Datum und Uhrzeit der Reservierung geändert haben. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| Reservierbare ID | Erforderlich. SYS_ID des Arbeitsplatzstandorts, für den die Reservierung erstellt wird. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzstandort [sn_wsd_Core_Workplace_location] |
| Reservierungs-ID | Erforderlich. SYS_ID der Reservierung, für die die zusätzlichen Serviceanforderungen hinzugefügt werden sollen. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzreservierung [sn_wsd_rsv_reservation] |
| 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. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzservice [sn_wsd_Case_Workplace_Service] |
| serviceCategories.comment | Erforderlich. Kommentare zur Servicekategorie. Datentyp: Zeichenfolge |
| Servicekategorien.flexible Services | Erforderlich. Details zu den einzelnen Arbeitsplatzserviceelementen 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 |
| serviceCategories.flexibleServices.comment | Erforderlich. Zusätzliche Kommentare zum Arbeitsplatzserviceelement oder zum zusätzlichen Service. Datentyp: Zeichenfolge |
| Servicekategorien.flexible Services.Lieferzeit | Erforderlich. Lieferzeit des Arbeitsplatzservice-Elements oder zusätzlichen Service. Datentyp: Zeichenfolge Format: UTC – jjjj-mm-ddThh:mm:ssZ, z. B. 2021-02-05T18:00:00Z |
| ServiceCategories.flexible Services.ExtraServiceRequestId | SYS_ID der vorhandenen zusätzlichen Serviceanfrage. Geben Sie diesen Parameter an, um eine vorhandene zusätzliche Serviceanfrage zu aktualisieren. Datentyp: Zeichenfolge Tabelle: Serviceelemente anfordern [sn_wsd_Case_Service_item_Request] |
| Servicekategorien.flexible Services.Flexible ServiceId | Erforderlich. SYS_ID des zusätzlichen Service- oder Arbeitsplatzservice-Elements. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzserviceelement [sn_wsd_Case_Workplace_Service_item] |
| Servicekategorien.flexible Services.Menge | 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/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. |
| 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 | Gibt Ergebnisse für die Anforderung zurück. Datentyp: Objekt |
| Ergebnis.extraServiceAnforderungen | Details zur hinzugefügten oder abgebrochenen zusätzlichen Serviceanfrage. Datentyp: Array des Objekts |
| Ergebnis.extraServiceAnforderungen.flexibleServiceId | SYS_ID der Anforderung des zusätzlichen Service-Elements, die der Reservierung hinzugefügt wurde. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzserviceelement [sn_wsd_Case_Workplace_Service_item] |
| Ergebnis.extraServiceAnforderungen.Anforderungs-ID | SYS_ID des zusätzlichen Service-Elements, das der Anforderung hinzugefügt wurde. Datentyp: Zeichenfolge Tabelle: Serviceelemente anfordern [sn_wsd_Case_Service_item_Request] |
| Ergebnis.reservableId | SYS_ID des Arbeitsplatzstandorts, für den die Reservierung erstellt wird. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzstandort [sn_wsd_Core_Workplace_location] |
| Ergebnis.ReservierungId | SYS_ID der Reservierung, für die die zusätzliche Serviceanfrage hinzugefügt wurde. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzreservierung [sn_wsd_rsv_reservation] |
| Ergebnis.Erfolg | Kennzeichnung, die angibt, ob die zusätzliche Serviceanfrage der Reservierung erfolgreich hinzugefügt wurde. Mögliche Werte:
Datentyp: Boolesch |
cURL-Anforderung
Das folgende Codebeispiel zeigt, wie einer Reservierung eine zusätzliche Serviceelementanforderung 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
}
}