WSD – API für zusätzliche Serviceanfrage

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 4 Minuten Lesedauer
  • Die Workplace Service Delivery(WSD) Zusätzliche Serviceanfrage Die API stellt Endpunkte zur Verwaltung zusätzlicher Serviceanfragen für Reservierungen bereit.

    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 .

    Für zusätzliche Informationen zu Workplace Reservation Management, Siehe Management Von Arbeitsplatzreservierungen .

    WSD Extra-Service: /sn_wsd_rsv/extra_Service/list_loc_Layouts ABRUFEN

    Gibt die Details zu den zugeordneten Standortlayouts für einen angegebenen Arbeitsplatzstandort zurück.

    URL-Format

    Versionierte URL: /api/sn_wsd_rsv/{api_Version}/extra_Service/list_loc_Layouts

    Standard-URL: /api/sn_wsd_rsv/extra_Service/list_loc_Layouts

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfadparameter
    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

    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    location Erforderlich. SYS_ID des Arbeitsplatzstandorts, für den die Standortlayoutdetails zurückgegeben werden sollen.

    Datentyp: Zeichenfolge

    Tabelle: Arbeitsplatzstandort [sn_wsd_Core_Workplace_location]

    Tabelle : 3. Anforderungstextparameter
    Name Beschreibung
    Keine Erforderlich.

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 4. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json

    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 REST API-HTTP-Antwortcodes .

    Tabelle : 6. Statuscodes
    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 Liste der Layouts, die dem angegebenen Arbeitsplatzstandort zugeordnet sind.

    Datentyp: Array von Objekten

    "result": [
      {
        "capacity": Number,
        "cleanup_duration": "String",
        "image": {Object},
        "is_default": Boolean,
        "max_capacity": Number,
        "name": "String",
        "preparation_duration": "String",
        "short_description": "String",
        "sys_id": "String"
      }
    ]
    result.capacity Anzahl der Personen, die an der Besprechung teilnehmen

    Datentyp: Zahl

    Ergebnis.Cleanup_duration Zeit, die zum Bereinigen des reservierbaren Elements für dieses Layout benötigt wird.

    Datentyp: Zahl

    Einheit: Millisekunden

    Ergebnis.Bild Details zu einem Bild, das das Layout für das zugehörige reservierbare Element darstellt.

    Datentyp: Objekt

    "image": {
      "link": "String",
      "sys_id": "String"
    }

    Tabelle: Images [DB_image]

    result.image.link Link zu einem Bild, das das Layout für dieses reservierbare Element darstellt.

    Datentyp: Zeichenfolge

    Tabelle: Images [DB_image]

    Ergebnis.Image.sys_ID SYS_ID des zugeordneten Bilddatensatzes.

    Datentyp: Zeichenfolge

    Result.is_default Kennzeichnung, die angibt, ob das zugehörige Layout der Standard für das reservierbare Element ist.
    Gültige Werte:
    • true: Standard.
    • Falsch: Nicht Standard.

    Datentyp: Boolesch

    result.name Name des Standortlayouts.

    Datentyp: Zeichenfolge

    Ergebnis.max_Capacity Maximale Anzahl von Personen, die das Layout, das dem reservierbaren Element zugeordnet ist, aufnehmen kann.

    Datentyp: Zahl

    Ergebnis.Preparation_duration Zeit, die für die Vorbereitung des zugehörigen Standortlayouts benötigt wird.

    Datentyp: Zahl

    Einheit: Millisekunden

    Ergebnis.Kurzbeschreibung Kurze Beschreibung des Standortlayouts.

    Datentyp: Zeichenfolge

    Ergebnis.sys_ID SYS_ID des Standortlayouts.

    Datentyp: Zeichenfolge

    Tabelle: Layout [sn_wsd_rsv_Layout]

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird.

    "http://instance.servicenow.com/api/sn_wsd_rsv/extra_service/list_loc_layouts&location=d2716d4adb7210106c731dcd13961994" \
    --request GET \
    --header "Accept:application/json" \
    --user "username":"password"

    Ergebnisse zurückgeben:

    {
      "result": [
        {
          "sys_id": "f4fee556534301103cf7ddeeff7b12ed",
          "name": "Test",
          "short_description": "test",
          "is_default": false,
          "image": {
            "sys_id": "9648a7c5531301103cf7ddeeff7b1286",
            "link": "9648a7c5531301103cf7ddeeff7b1286.iix"
          },
          "capacity": null,
          "max_capacity": null,
          "preparation_duration": 172800000,
          "cleanup_duration": 86400000
        }
      ]
    }

    WSD Extra-Service – GET /api/sn_wsd_rsv/extra_Service/list_loc_Standard_Services

    Gibt die Details zu den zugehörigen Standardservices für einen angegebenen Arbeitsplatzstandort zurück.

    URL-Format

    Versionierte URL: /api/sn_wsd_rsv/{api_Version}/extra_Service/list_loc_Standard_Services

    Standard-URL: /api/sn_wsd_rsv/extra_Service/list_loc_Standard_Services

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

    Tabelle : 7. Pfadparameter
    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

    Tabelle : 8. Abfrageparameter
    Name Beschreibung
    location Erforderlich. SYS_ID des Arbeitsplatzstandorts, für den die Standardservices des Standortlayouts zurückgegeben werden sollen.

    Datentyp: Zeichenfolge

    Tabelle: Arbeitsplatzstandort [sn_wsd_Core_Workplace_location]

    Tabelle : 9. Anforderungstextparameter
    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 .

    Tabelle : 10. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: 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 REST API-HTTP-Antwortcodes .

    Tabelle : 12. Statuscodes
    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.Standard_Services
    Zugehörige Standardservices, z. B. Flipchart, Projektorbildschirm, Whiteboard und Markierungen.

    Datentyp: Array von Objekten

    "standard_services": [
      {
        "font_awesome_icon": "String",
        "name": "String",
        "short_description": "String",
        "sys_id": "String"
      }
    ]
    Ergebnis.Standard_Services.font_Awesome_icon Name des Miniaturansichtssymbols, das dem Standardservice zugeordnet ist.

    Datentyp: Zeichenfolge

    result.standard_services.name Name des Standardservice.

    Datentyp: Zeichenfolge

    Ergebnis.Standard_Services.short_description Kurze Beschreibung des Standardservice.

    Datentyp: Zeichenfolge

    Ergebnis.Standard_Services.sys_ID SYS_ID des Standardservicedatensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Standardservice [sn_wsd_rsv_Standard_Service]

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird, um die Standardservices zu erhalten.

    "http://instance.servicenow.com/api/sn_wsd_rsv/extra_service/list_loc_standard_services&location=d2716d4adb7210106c731dcd13961994" \
    --request GET \
    --header "Accept:application/json" \
    --user "username":"password"

    Ergebnisse zurückgeben:

    {
      "result": [
        {
          "sys_id": "9b01458edb7650106c731dcd13961945",
          "name": "Flip chart",
          "short_description": "Flip chart with paper sheets",
          "font_awesome_icon": "fa-calendar-o"
        },
        {
          "sys_id": "abd0c18edb7650106c731dcd13961965",
          "name": "Projector screen",
          "short_description": "Connect laptop to screen (HDMI and DVI)",
          "font_awesome_icon": "fa-caret-square-o-right"
        },
        {
          "sys_id": "9841858edb7650106c731dcd1396193c",
          "name": "Whiteboard",
          "short_description": "Whiteboard and markers",
          "font_awesome_icon": "fa-pencil-square-o"
        }
      ]
    }