WSD-Schicht-API

Die Schicht -API Workplace Service Delivery (WSD) stellt einen Endpunkt bereit, der Schichtzeitspannen für ein bestimmtes Datum und eine bestimmte Uhrzeit zurückgibt.

Um auf diese API zuzugreifen, muss der Anrufer über die Rolle „sn_wsd_core.workplace_user“ verfügen, und die Plugins „Workplace Safety Management“ (sn_wsd_core) und „Workplace Reservation Management“ (sn_wsd_rsv) müssen aktiviert sein.

Diese API wird im Namespace sn_wsd_rsv ausgeführt.

Weitere Informationen zu Management von Arbeitsplatz-Reservierungenfinden Sie unter Reservierungsmanagement für Arbeitsplatz.

WSD-Schicht: GET /api/sn_wsd_rsv/wsd_shift/{shift_id}/timespan

Gibt die Schichtzeitspanne für ein bestimmtes Datum/eine bestimmte Uhrzeit und eine bestimmte Schicht zurück.

URL-Format

URL mit Versionsnummer: /api/sn_wsd_rsv/{api_version}/wsd_shift/{shift_id}/timespan

Standard-URL: /api/sn_wsd_rsv/wsd_shift/{shift_id}/timespan

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
shift_id	Sys_id der Schicht, für die die Zeitspanne abgerufen werden soll. Befindet sich in der Tabelle „Schicht“ [sn_wsd_core_shift]. Weitere Informationen zu schichtbasierten Reservierungen finden Sie unter Schichtbasierte Reservierung aktivieren. Datentyp: Zeichenfolge

Tabelle : 2. Abfrageparameter

Name	Beschreibung
Versuch_früher_start	Kennzeichnung, die angibt, ob eine frühe Startzeit festgelegt werden soll, wenn der angegebene Startwert innerhalb der Zeitspanne der Schicht liegt. Gültige Werte: wahr: Wenn die angegebene Schicht das im Parameter [] angegebene Datum/die im Parameter start angegebene(n) Datum/Uhrzeit enthält, wird das angegebene Startdatum/die angegebene Startzeit als Beginn der Zeitspanne zurückgegeben. „falsch“: Gibt die Schichtzeitspanne zurück, wie im zugehörigen Datensatz definiert. Datentyp: Boolesch Standardwert: false
start	Erforderlich. Datum und Uhrzeit des Beginns der zurückzugebenden Schichtzeitspannen. Format: UTC - jjjj-mm-ttThh:mm:ssZ, z. B. 2022-05-23T08:00:00Z
Feld	Zeitzone für die Qualifizierung der Schichtzeitspannen, z. B. ECT oder PST. Gibt auch die Schichtzeitspannen in dieser Zeitzone zurück. Format: UTC Datentyp: Zeichenfolge Standard: Zeitzone des Anwenders

Tabelle : 3. 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 : 4. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Anforderungstexts. Unterstützte Typen: application/json, application/xml oder, text/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.
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 zur Schichtzeitspanne, die den Suchkriterien entsprach. Datentyp: Objekt "result":{ "end": "String", "start": "String" }
result.end	Enddatum und -uhrzeit des Schichtzeitraums in der angegebenen Zeitzone. Format: UTC: jjjj-mm-ttThh:mm:ssZ, z. B. 2022-05-23T08:00:00Z Datentyp: Zeichenfolge
result.start	Startdatum und -uhrzeit des Schichtzeitraums in der angegebenen Zeitzone. Format: UTC: jjjj-mm-ttThh:mm:ssZ, z. B. 2022-05-23T08:00:00Z Datentyp: Zeichenfolge

cURL-Anforderung

Das folgende Codebeispiel zeigt, wie die Zeitspanne einer Schicht abgerufen wird.

curl "https://instance.servicenow.com/api/sn_wsd_rsv/wsd_shift/e5d23acfdb42a01097acc9003996193a/timespan?attempt_earlier_start=true&start=2022-05-23T08:00:00Z&timezone=ECT" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

Ergebnisse zurückgeben:

{
  "result": {
    "start": "2022-05-23T08:00:00Z",
    "end": "2022-05-23T15:00:00Z"
  }
}