WSD Zusätzliche Serviceanfrage-API

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 4 Minuten Lesedauer

    • Mit der Workplace Service Delivery (WSD) Extra Service Request- API können Sie zusätzliche Serviceanfragen für Reservierungen verwalten.

    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.

    Weitere Informationen zu Workplace Reservation Managementfinden Sie unter Workplace Reservation Management.

    WSD Extra Service – GET /sn_wsd_rsv/extra_service/list_loc_layouts

    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

    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
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    location Erforderlich. Sys_id des Arbeitsplatzstandorts, für den die Standortlayoutdetails zurückgegeben werden sollen.

    Befindet sich in der Tabelle „Arbeitsplatzstandort“ [sn_wsd_core_workplace_location].

    Datentyp: Zeichenfolge
    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 HTTP-Antwortcodesder REST-API.

    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
    result.cleanup_duration Zeitdauer, die zum Bereinigen des reservierbaren Elements für dieses Layout benötigt wird.

    Datentyp: Zahl

    Einheit: Millisekunden
    result.image Details zu einem Bild, das das Layout für das zugeordnete reservierbare Element darstellt.

    Befindet sich in der Tabelle „Bilder“ [db_image].

    "image": {
  "link": "String",
  "sys_id": "String"
}
    result.image.link Link zu einem Bild, das das Layout für dieses reservierbare Element darstellt. Befindet sich in der Tabelle „Bilder“ [db_image].

    Datentyp: Zeichenfolge
    result.image.sys_id Sys_id des zugeordneten Image-Datensatzes.

    Datentyp: Zeichenfolge
    result.is_default Kennzeichnung, die angibt, ob das zugeordnete Layout der Standard für das reservierbare Element ist.
    Gültige Werte:
    • true: Standard.
    • false: Nicht Standard.

    Datentyp: Boolesch
    result.name Name des Standortlayouts.

    Datentyp: Zeichenfolge
    result.max_capacity Maximale Anzahl von Personen, die das mit dem reservierbaren Element verknüpfte Layout aufnehmen kann.

    Datentyp: Zahl
    result.preparation_duration Zeit, die zur Vorbereitung des zugehörigen Standortlayouts benötigt wird.

    Datentyp: Zahl

    Einheit: Millisekunden
    result.short_description Kurze Beschreibung des Standortlayouts.

    Datentyp: Zeichenfolge
    result.sys_id Sys_id des Standortlayouts.

    Befindet sich in der Layouttabelle [sn_wsd_rsv_layout].

    Datentyp: Zeichenfolge

    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 zugeordneten 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

    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
    Tabelle : 8. Abfrageparameter
    Name Beschreibung
    location Erforderlich. Sys_id des Arbeitsplatzstandorts, für den die Standardservices für das Standortlayout zurückgegeben werden sollen.

    Befindet sich in der Tabelle „Arbeitsplatzstandort“ [sn_wsd_core_workplace_location].

    Datentyp: Zeichenfolge
    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 HTTP-Antwortcodesder REST-API.

    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
    result.standard_services
    Zugehörige Standardservices, z. B. Flipchart, Bildschirm, Whiteboard und Marker.

    Datentyp: Array von Objekten

    "standard_services": [
  {
    "font_awesome_icon": "String",
    "name": "String",
    "short_description": "String",
    "sys_id": "String"
  }
]
    result.standard_services.font_awesome_icon Name des Miniatursymbols, das dem Standardservice zugeordnet ist.

    Datentyp: Zeichenfolge
    result.standard_services.name Name des Standardservice.

    Datentyp: Zeichenfolge
    result.standard_services.short_description Kurze Beschreibung des Standardservice.

    Datentyp: Zeichenfolge
    result.standard_services.sys_id Sys_id des Standardservicedatensatzes. Befindet sich in der Tabelle „Standardservice“ [sn_wsd_rsv_standard_service].

    Datentyp: Zeichenfolge

    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"
    }
  ]
}