WSD-Schicht-API

Die Workplace Service Delivery(WSD) Schicht Die API 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 „Arbeitsplatzsicherheitsmanagement“ (sn_wsd_Core) und „Arbeitsplatzreservierungsmanagement“ (sn_wsd_rsv) müssen aktiviert sein.

Diese API wird in ausgeführt sn_wsd_rsv Namespace.

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

WSD-Schicht: /api/sn_wsd_rsv/wsd_Shift/{Shift_ID}/time espan ABRUFEN

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

URL-Format

Versionierte URL: /api/sn_wsd_rsv/{api_Version}/wsd_Shift/{Shift_ID}/time espan

Standard-URL: /api/sn_wsd_rsv/wsd_Shift/{Shift_ID}/time espan

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
Shift_ID	SYS_ID der Schicht, für die die Zeitspanne abgerufen werden soll. Weitere Informationen zu schichtbasierten Reservierungen finden Sie unter Aktivieren Sie die schichtbasierte Reservierung . Datentyp: Zeichenfolge Tabelle: Schicht [sn_wsd_Core_Shift]

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 in angegebene Datum/die Uhrzeit enthält startParameter, gibt das angegebene Startdatum/-Uhrzeit als Beginn der Zeitspanne zurück. Falsch: Geben Sie die Schichtzeitspanne zurück, wie im zugehörigen Datensatz definiert. Datentyp: Boolesch Standardwert: false
Start	Erforderlich. Datum und Uhrzeit des Starts der zurückzukehrenden Schichtzeitspannen. Format: UTC – jjjj-mm-ddThh:mm:ssZ, z. B. 2022-05-23T08:00:00Z
Feld	Zeitzone, die bei der Qualifizierung der Schichtzeitspannen verwendet werden soll, 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/xmlOder, 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 REST API-HTTP-Antwortcodes .

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 entsprachen. Datentyp: Objekt "result":{ "end": "String", "start": "String" }
Ergebnis.Ende	Enddatum und -Uhrzeit der Schichtzeitspanne in der angegebenen Zeitzone. Format: UTC: jjjj-mm-ddThh:mm:ssZ, z. B. 2022-05-23T08:00:00Z Datentyp: Zeichenfolge
Ergebnis.Start	Startdatum und -Uhrzeit der Schichtzeitspanne in der angegebenen Zeitzone. Format: UTC: jjjj-mm-ddThh: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"
  }
}