WSD-AnwesenheitsAPI
Die WSD-Anwesenheit Mit API können Anwender ihren Zeitplan für die Anwesenheit im Büro verwalten, einschließlich wöchentlicher Routinen, einmaliger Ausnahmen und Sichtbarkeit von Mitarbeitern.
- Ruft die vollständigen Anwesenheitsdaten eines authentifizierten Anwenders ab, einschließlich seiner wöchentlichen Routine im Büro, geplanten Ausnahmen und optionalen Anwesenheitsinformationen von Mitarbeitenden.
- Verwalten Sie wöchentliche Routinen im Büro, damit Mitarbeiter einen wiederkehrenden Zeitplan festlegen können.
- Erstellen und verwalten Sie einmalige Ausnahmen, die die Routine für ein bestimmtes Datum überschreiben.
- Zeigen Sie Mitarbeitende an, und verwalten Sie sie, um eine koordinierte Planung im Büro zu ermöglichen.
Ein authentifizierter Anwender ist jemand, der angemeldet ist oder dessen Anmeldeinformationen in der API-Anforderung enthalten sind. Rufen Sie Endpunkte in beliebiger Reihenfolge an; jeder arbeitet unabhängig.
Die WSD-Anwesenheit API gehört zum Namespace „sn_wsd_Concierge“. Die WSD-Reservierungs-API /User/context ABRUFEN Endpunkt kann Anwesenheitszeitplandaten von zurückgeben WSD-Anwesenheit API, wenn das Concierge-Plugin aktiv ist.
Anforderungen
- Die dem Anwender zugewiesene sn_wsd_core.workplace_user-Rolle.
- Die Workplace Service Delivery Plugin „Core“ (com.sn_wsd_Core) aktiviert.
- In sys_user muss mindestens ein Anwenderdatensatz mit der zugewiesenen sn_wsd_core.workplace_user-Rolle vorhanden sein.
WSD-Anwesenheit: LÖSCHEN SIE /api/sn_wsd_Concierge/v1/presence/Collaborator/{Collaborator_ID}
Entfernt einen mitarbeitenden aus der Sichtbarkeitsliste der authentifizierten Anwender-Anwesenheit. Verwenden Sie diesen Endpunkt, wenn ein Anwender die Anwesenheit eines Kollegen im Büro nicht mehr nachverfolgen möchte.
Ein authentifizierter Anwender ist jemand, der angemeldet ist oder dessen Anmeldeinformationen in der API-Anforderung enthalten sind. Der mitarbeitende wird anhand seiner sys_ID identifiziert
URL-Format
Versionierte URL: /api/sn_wsd_Concierge/{api_Version}/presence/Collaborator/{Collaborator_ID}
Standard-URL: /api/sn_wsd_Concierge/presence/Collaborator/{Collaborator_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 |
| Collaborator_ID | SYS_ID des mitarbeitenden Mitarbeiters, der aus der Sichtbarkeitsliste des Anwenders entfernt werden soll. Tabelle: Benutzer [sys_user] Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json, application/xml, Oder text/xml. |
| Autorisierung | Anmeldeinformationen für Authentifizierung. Unterstützt Standardauthentifizierung oder sitzungsbasierte Authentifizierung. |
| Header | Beschreibung |
|---|---|
| Inhaltstyp | Datenformat des Antworttexts: Application/JSON. |
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. Fehlender oder ungültiger Pfadparameter „Collaborator_ID“. |
| 404 | Nicht gefunden. Der angegebene mitarbeitende wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Objekt, das die Ergebnisse der Anforderung enthält. Datentyp: Objekt |
| Ergebnis.Nachricht | Bestätigungsnachricht, die die Anzahl der entfernten Mitarbeitenden angibt. Datentyp: Zeichenfolge |
cURL-Anforderung
Dieses Beispiel entfernt einen bestimmten Mitarbeitenden aus der Sichtbarkeitsliste der authentifizierten Anwender-Anwesenheit.
curl "https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/collaborator/usr1a2b3c4d5e6" \
--request DELETE \
--header "Accept: application/json" \
--user "username:password"
Antworttext.
{
"result": {
"message": "1 collaborator(s) removed"
}
}
WSD-Anwesenheit: LÖSCHEN SIE /api/sn_wsd_Concierge/v1/presence/Exception/{Exception_ID}
Löscht eine bestimmte Anwesenheitsausnahme, die anhand ihrer sys_ID identifiziert wird Verwenden Sie diesen Endpunkt, wenn ein Anwender eine einmalige Überschreibung entfernen und zu seiner regulären wöchentlichen Routine für dieses Datum zurückkehren möchte.
URL-Format
Versionierte URL: /api/sn_wsd_Concierge/{api_Version}/Präsenz/Ausnahme/{Ausnahme_ID}
Standard-URL: /api/sn_wsd_Concierge/presence/Exception/{Exception_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 |
| Ausnahme_ID | Erforderlich. SYS_ID der zu löschenden Anwesenheitsausnahme. Tabelle: Ausnahmen bei Mitarbeiteranwesenheit (sn_wsd_concierge_employee_presence_exception) Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json, application/xml, Oder text/xml. |
| Autorisierung | Anmeldeinformationen für Authentifizierung. Unterstützt Standardauthentifizierung oder sitzungsbasierte Authentifizierung. |
| Header | Beschreibung |
|---|---|
| Inhaltstyp | Datenformat des Antworttexts: Application/JSON. |
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. Pfadparameter „Exception_ID“ fehlt oder ist ungültig. |
| 404 | Nicht gefunden. Die angegebene Ausnahme wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Objekt, das die Ergebnisse der Anforderung enthält. Datentyp: Objekt |
| Ergebnis.Nachricht | Bestätigungsnachricht, die angibt, dass die Ausnahme gelöscht wurde. Datentyp: Zeichenfolge |
cURL-Anforderung
In diesem Beispiel wird die Ausnahme exc1a2b3c4d5e6 gelöscht, wodurch dieses Datum auf die regelmäßige wöchentliche Routine des Anwenders zurückgesetzt wird.
curl "https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/exception/exc1a2b3c4d5e6" \
--request DELETE \
--header "Accept: application/json" \
--user "username:password"
Antworttext.
{
"result": {
"message": "Exception deleted successfully"
}
}
WSD-Anwesenheit – GET /api/sn_wsd_Concierge/v1/presence/Collaborator
Ruft die Liste der Mitarbeitenden für den authentifizierten Anwender zusammen mit den Anwesenheitsdaten, Routinen und Ausnahmen jedes Mitarbeitenden ab. Verwenden Sie diesen Endpunkt, um die Zeitpläne für die Anwesenheit von Kollegen im Büro anzuzeigen und eine koordinierte Planung im Büro zu ermöglichen.
URL-Format
Versionierte URL: /api/sn_wsd_Concierge/{api_Version}/presence/Collaborator
Standard-URL: /api/sn_wsd_Concierge/presence/Collaborator
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 |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json, application/xml, Oder text/xml. |
| Autorisierung | Anmeldeinformationen für Authentifizierung. Unterstützt Standardauthentifizierung oder sitzungsbasierte Authentifizierung. |
| Header | Beschreibung |
|---|---|
| Inhaltstyp | Datenformat des Antworttexts: Application/JSON. |
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. |
| 404 | Nicht gefunden. Der Anwender wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Objekt, das die Ergebnisse der Anforderung enthält. Datentyp: Objekt |
| Ergebnis.Anzahl | Gesamtzahl der zurückgegebenen Mitarbeitenden. Datentyp: Zahl |
| Ergebnis.Mitarbeitende | Liste der Mitarbeitenden mit ihren Anwesenheitsdaten. Wenn für einen Mitarbeitenden Datenschutz aktiviert ist, privacy_enabledIst „wahr“ mit Null routineUnd leer exceptions. Datentyp: Array von Objekten |
| Ergebnis.Mitarbeitende.sys_ID | SYS_ID des Anwenderdatensatzes des mitarbeitenden. Tabelle: Benutzer [sys_user] Datentyp: Zeichenfolge |
| result.collaborators.name | Anzeigename des mitarbeitenden, wie er in seinem sys_user-Datensatz angezeigt wird. Tabelle: Benutzer [sys_user] Datentyp: Zeichenfolge |
| Ergebnis.Mitarbeitende.Datenschutz_aktiviert | Boolescher Wert. Kennzeichnung, die angibt, ob der mitarbeitende den Datenschutz für seine Anwesenheitsdaten aktiviert hat. Gültige Werte:
Datentyp: Boolesch |
| Ergebnis.Mitarbeitende.Routine | Wöchentliche Routine des Mitarbeitenden im Büro. Enthält eine boolesche Kennzeichnung für jeden Wochentag, die die geplante Anwesenheit im Büro angibt. Wird Angezeigt Datentyp: Objekt |
| Ergebnis.Mitarbeitende.Ausnahmen | Ausnahmen für einmalige Anwesenheit des Mitarbeitenden. Gibt ein leeres Array zurück, wenn Privacy_enabled Ist Wahr .Datentyp: Array von Objekten |
| Ergebnis.Mitarbeitende.Ausnahmen.sys_ID | SYS_ID des Ausnahmedatensatzes. Tabelle: Ausnahmen bei Mitarbeiteranwesenheit (sn_wsd_concierge_employee_presence_exception) Datentyp: Zeichenfolge |
| result.collaborators.exceptions.date | Datum, für das diese Ausnahme gilt. Dies ist das Datum, an dem die Routine des Anwenders überschrieben wird. Format: jjjj-MM-tt Datentyp: Zeichenfolge |
| result.collaborators.exceptions.in_office | Kennzeichnung, die angibt, ob der Anwender an diesem Datum im Büro ist. Dies überschreibt alles, was die wöchentliche Routine für diesen Wochentag vorgibt. Gültige Werte:
Datentyp: Zeichenfolge |
| Ergebnis.Mitarbeitende.Ausnahmen.Ursprung | Quelle, die die Ausnahme erstellt hat. Gültige Werte:
Datentyp: Zeichenfolge |
| Ergebnis.Mitarbeitende.Ausnahmen.Standort | Name oder Bezeichner des Bürostandorts, an dem sich der Anwender an diesem Datum befindet. Nur relevant, wenn In_Office Ist Wahr . Kann eine leere Zeichenfolge sein, wenn der Anwender Remote ist.Datentyp: Zeichenfolge |
cURL-Anforderung
Dieses Beispiel ruft alle Mitarbeitenden und ihre Anwesenheitsdaten für den authentifizierten Anwender ab.
curl "https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/collaborator" \
--request GET \
--header "Accept: application/json" \
--user "username:password"
Antworttext.
{
"result": {
"count": 2,
"collaborators": [
{
"sys_id": "usr1a2b3c4d5e6", "name": "Jane Smith", "privacy_enabled": false,
"routine": {
"monday": true, "tuesday": true, "wednesday": false,
"thursday": true, "friday": false, "saturday": false, "sunday": false
},
"exceptions": [
{ "sys_id": "exc1a2b3c", "date": "2026-03-10", "in_office": true, "origin": "user", "location": "Building B" }
]
},
{ "sys_id": "usr7f8g9h0i1j2", "name": "John Doe", "privacy_enabled": true, "routine": null, "exceptions": [] }
]
}
}
WSD-Anwesenheit – GET /api/sn_wsd_Concierge/v1/presence/Exception
Ruft Anwesenheitsausnahmen für den authentifizierten Anwender ab. Ausnahmen können nach einem Datumsbereich oder einer bestimmten Ausnahme-sys_ID gefiltert werden Verwenden Sie diesen Endpunkt, wenn Sie einmalige Überschreibungen der wöchentlichen Routine eines Anwenders anzeigen müssen.
URL-Format
Versionierte URL: /api/sn_wsd_Concierge/{api_Version}/Presence/Exception
Standard-URL: /api/sn_wsd_Concierge/presence/Exception
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 |
|---|---|
| Ausnahme_ID | SYS_ID einer bestimmten abzurufenden Ausnahme. Wenn angegeben, wird der Datumsbereichsfilter überschrieben und nur die übereinstimmende Ausnahme zurückgegeben. Tabelle: Ausnahmen bei Mitarbeiteranwesenheit (sn_wsd_concierge_employee_presence_exception) Datentyp: Zeichenfolge |
| Exception_Start_date | Startdatum zum Filtern von Ausnahmen. Format: jjjj-MM-tt Datentyp: Zeichenfolge Standard: Heute |
| Exception_end_date | Enddatum zum Filtern von Ausnahmen. Format: jjjj-MM-tt Datentyp: Zeichenfolge Standard: Heute +3 Monate |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json, application/xml, Oder text/xml. |
| Autorisierung | Anmeldeinformationen für Authentifizierung. Unterstützt Standardauthentifizierung oder sitzungsbasierte Authentifizierung. |
| Header | Beschreibung |
|---|---|
| Inhaltstyp | Datenformat des Antworttexts: Application/JSON. |
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. Ungültiges Datumsformat für Exception_Start_date oder Exception_end_date. |
| 404 | Nicht gefunden. Die angegebene Ausnahme wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Objekt, das die Ergebnisse der Anforderung enthält. Datentyp: Objekt |
| Ergebnis.Ausnahmen | Liste der Anwesenheitsausnahmen, die den Filterkriterien entsprechen. Datentyp: Array von Objekten |
| result.exceptions.date | Datum, für das diese Ausnahme gilt. Dies ist das Datum, an dem die Routine des Anwenders überschrieben wird. Format: Format jjjj-MM-TT Datentyp: Zeichenfolge |
| result.exceptions.in_office | Kennzeichnung, die angibt, ob der Anwender an diesem Datum im Büro ist. Dies überschreibt alles, was die wöchentliche Routine für diesen Wochentag vorgibt. Gültige Werte:
Datentyp: Zeichenfolge |
| Ergebnis.Ausnahmen.Standort | Der Name oder Bezeichner des Bürostandorts, an dem sich der Anwender an diesem Datum befindet. Nur relevant, wenn In_Office Ist Wahr . Kann eine leere Zeichenfolge sein, wenn der Anwender Remote ist.Datentyp: Zeichenfolge |
| Ergebnis.Ausnahmen.Ursprung | Quelle, die die Ausnahme erstellt hat. Gültige Werte:
Datentyp: Zeichenfolge |
| Ergebnis.Ausnahmen.sys_ID | SYS_ID des Ausnahmedatensatzes. Tabelle: Ausnahmen bei Mitarbeiteranwesenheit (sn_wsd_concierge_employee_presence_exception) Datentyp: Zeichenfolge |
cURL-Anforderung
Dieses Beispiel ruft alle Ausnahmen für die erste Hälfte des Jahres 2026 ab.
curl "https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/exception?exception_start_date=2026-01-01&exception_end_date=2026-06-30" \
--request GET \
--header "Accept: application/json" \
--user "username:password"
Antworttext.
{
"result": {
"exceptions": [
{ "sys_id": "exc1a2b3c4d5e6", "date": "2026-02-14", "in_office": true, "origin": "user", "location": "Building A" },
{ "sys_id": "exc7f8g9h0i1j2", "date": "2026-03-17", "in_office": false, "origin": "system", "location": "" }
]
}
}
WSD-Anwesenheit: RUFT /api/sn_wsd_Concierge/v1/presence AB
Ruft die vollständigen Anwesenheitsdaten des authentifizierten Anwenders ab, einschließlich seiner wöchentlichen Routine im Büro, geplanten Anwesenheitsausnahmen und optional der Anwesenheitsinformationen seiner Mitarbeitenden.
Verwenden Sie diesen Endpunkt, um einen ganzheitlichen Überblick über die geplante Anwesenheit eines Anwenders im Büro zu erhalten. Sie können die Anwesenheitsdaten eines anderen Anwenders auch abfragen, indem Sie seine sys_ID angeben, vorbehaltlich der Datenschutzeinstellungen.
URL-Format
Versionierte URL: /api/sn_wsd_Concierge/{api_Version}/Presence
Standard-URL: /api/sn_wsd_Concierge/presence
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 |
|---|---|
| user_id | SYS_ID des Zielanwenders, dessen Anwesenheitsdaten abgerufen werden sollen. Wenn nicht angegeben, werden Anwesenheitsdaten für den authentifizierten Anwender zurückgegeben. Hinweis: Anwenderübergreifende Abfragen geben nicht autorisierte 401 zurück, es sei denn, der Anrufer verfügt über eine explizite Berechtigung. Tabelle: Benutzer [sys_user] Datentyp: Zeichenfolge |
| Exception_Start_date | Startdatum zum Filtern von Anwesenheitsausnahmen. Format: jjjj-MM-tt Datentyp: Zeichenfolge Standard: Heute |
| Exception_end_date | Enddatum zum Filtern von Anwesenheitsausnahmen. Format: jjjj-MM-tt Datentyp: Zeichenfolge Standard: Heute + 3 Monate |
| einbeziehen | Zugehörige Daten, die in die Antwort aufgenommen werden sollen. Nur gültiger Wert: Mitarbeitende Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json, application/xml, Oder text/xml. |
| Autorisierung | Anmeldeinformationen für Authentifizierung. Unterstützt Standardauthentifizierung oder sitzungsbasierte Authentifizierung. |
| Header | Beschreibung |
|---|---|
| Inhaltstyp | Datenformat des Antworttexts: Application/JSON. |
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. Ungültiges Datumsformat für Exception_Start_date oder Exception_end_date oder ungültiges user_ID-Format. |
| 401 | Nicht autorisiert Der authentifizierte Anwender hat keine Berechtigung zum Anzeigen der Anwesenheitsdaten des Zielanwenders. Wird zurückgegeben, wenn user_ID angegeben wird und nicht mit dem authentifizierten Anwender übereinstimmt. |
| 404 | Nicht gefunden. Der angegebene Anwender wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Objekt, das die Ergebnisse der Antwort enthält. |
| Ergebnis.Routine | Wöchentliche Routine im Büro für den Anwender. Enthält eine boolesche Kennzeichnung für jeden Wochentag, die die geplante Anwesenheit im Büro angibt. Wird Angezeigt Datentyp: Objekt |
| Ergebnis.Ausnahmen | Liste der einmaligen Anwesenheitsausnahmen, die die Routine des Anwenders für bestimmte Daten überschreiben. Datentyp: Array von Objekten |
| Ergebnis.Ausnahmen.sys_ID | SYS_ID des Ausnahmedatensatzes. Tabelle: Ausnahmen bei Mitarbeiteranwesenheit (sn_wsd_concierge_employee_presence_exception) Datentyp: Zeichenfolge |
| result.exceptions.date | Datum, für das diese Ausnahme gilt, im Format JJJJ-MM-TT. Dies ist das Datum, an dem die Routine des Anwenders überschrieben wird. Datentyp: Zeichenfolge |
| result.exceptions.in_office | Kennzeichnung, die angibt, ob der Anwender an diesem Datum im Büro ist. Dies überschreibt alles, was die wöchentliche Routine für diesen Wochentag vorgibt. Gültige Werte:
Datentyp: Zeichenfolge |
| Ergebnis.Ausnahmen.Ursprung | Quelle, die die Ausnahme erstellt hat. Gültige Werte:
Datentyp: Zeichenfolge |
| Ergebnis.Ausnahmen.Standort | Der Name oder Bezeichner des Bürostandorts, an dem sich der Anwender an diesem Datum befindet. Nur relevant, wenn In_Office Ist Wahr . Kann eine leere Zeichenfolge sein, wenn der Anwender Remote ist.Datentyp: Zeichenfolge |
| Ergebnis.Mitarbeitende | Liste der Mitarbeitenden und ihrer Anwesenheitsdaten. Nur zurückgegeben, wenn Include=Collaborators Ist angegeben.Wenn für einen Mitarbeitenden Datenschutz aktiviert ist, privacy_enabledIst „wahr“ mit Null routineUnd leer exceptions. Datentyp: Array von Objekten |
| Ergebnis.Mitarbeitende.sys_ID | SYS_ID des Anwenderdatensatzes des mitarbeitenden. Tabelle: Benutzer [sys_user] Datentyp: Zeichenfolge |
| result.collaborators.name | Der Anzeigename des mitarbeitenden, wie er in seinem sys_user-Datensatz angezeigt wird. Tabelle: Benutzer [sys_user] Datentyp: Zeichenfolge |
| Ergebnis.Mitarbeitende.Datenschutz_aktiviert | Boolescher Wert. Kennzeichnung, die angibt, ob der mitarbeitende den Datenschutz für seine Anwesenheitsdaten aktiviert hat. Gültige Werte:
Datentyp: Boolesch |
| Ergebnis.Mitarbeitende.Routine | Die wöchentliche Routine des Mitarbeitenden im Büro. Enthält eine boolesche Kennzeichnung für jeden Wochentag, die die geplante Anwesenheit im Büro angibt. Wird Angezeigt Datentyp: Objekt |
| Ergebnis.Mitarbeitende.Ausnahmen | Ausnahmen der einmaligen Anwesenheit des mitarbeitenden. Folgt der gleichen Struktur wie die des authentifizierten Anwenders exceptionsParameter. Gibt ein leeres Array zurück, wenn Privacy_enabled Ist Wahr .Datentyp: Array von Objekten |
cURL-Anforderung
Dieses Beispiel ruft die vollständigen Anwesenheitsdaten des authentifizierten Anwenders, einschließlich Zeitplänen für Mitarbeitende, für Ausnahmen im 1. Quartal 2026 ab.
curl "https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence?include=collaborators&exception_start_date=2026-01-01&exception_end_date=2026-03-31" \
--request GET \
--header "Accept: application/json" \
--user "username:password"
Antworttext.
{
"result": {
"routine": {
"monday": true, "tuesday": false, "wednesday": true,
"thursday": true, "friday": false, "saturday": false, "sunday": false
},
"exceptions": [
{
"sys_id": "a1b2c3d4e5f6",
"date": "2026-02-14",
"in_office": true,
"origin": "user",
"location": "Building A"
}
],
"collaborators": [
{
"sys_id": "f6e5d4c3b2a1",
"name": "Jane Smith",
"privacy_enabled": false,
"routine": {
"monday": true, "tuesday": true, "wednesday": false,
"thursday": true, "friday": false, "saturday": false, "sunday": false
},
"exceptions": []
}
]
}
}
WSD-Anwesenheit – GET /api/sn_wsd_Concierge/v1/presence/Routine
Ruft nur die wöchentliche Routine des authentifizierten Anwenders im Büro ab. Dies ist eine schlanke Alternative zum ABRUFEN von /Presence, wenn Sie nur den Routinezeitplan ohne Ausnahmen oder Mitarbeitende benötigen.
URL-Format
Versionierte URL: /api/sn_wsd_Concierge/{api_Version}/Presence/Routine
Standard-URL: /api/sn_wsd_Concierge/presence/Routine
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 |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json, application/xml, Oder text/xml. |
| Autorisierung | Anmeldeinformationen für Authentifizierung. Unterstützt Standardauthentifizierung oder sitzungsbasierte Authentifizierung. |
| Header | Beschreibung |
|---|---|
| Inhaltstyp | Datenformat des Antworttexts: Application/JSON. |
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. |
| 404 | Nicht gefunden. Der Anwender oder die Routine wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Objekt, das die Ergebnisse der Anforderung enthält. Datentyp: Objekt |
| result.user_id | SYS_ID des Anwenders, dessen Routine zurückgegeben wird. Tabelle: Anwender [sys_ID] Datentyp: Zeichenfolge |
| Ergebnis.Routine | Wiederkehrender wöchentlicher Zeitplan im Büro des Anwenders. Enthält eine boolesche Kennzeichnung für jeden Wochentag, die die geplante Anwesenheit im Büro angibt. Wird Angezeigt Datentyp: Objekt |
cURL-Anforderung
Dieses Beispiel ruft die wöchentliche Routine im Büro für den authentifizierten Anwender ab.
curl "https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/routine" \
--request GET \
--header "Accept: application/json" \
--user "username:password"
Antworttext. Zeigt an, dass die Routine des Anwenders die Anwesenheit im Büro von Montag bis Donnerstag anzeigt.
{
"result": {
"user_id": "a1b2c3d4e5f6g7h8",
"routine": {
"monday": true, "tuesday": true, "wednesday": true,
"thursday": true, "friday": false, "saturday": false, "sunday": false
}
}
}
WSD-Anwesenheit: PATCH /api/sn_wsd_Concierge/v1/presence/Routine
Aktualisiert die wöchentliche Routine des authentifizierten Anwenders im Büro teilweise. Verwenden Sie diesen Endpunkt, wenn ein Anwender bestimmte Tage anpassen muss, ohne den gesamten Zeitplan zurückzusetzen.
Nur die im Anforderungstext angegebenen Tage werden aktualisiert. Alle anderen Tage bleiben unverändert.
URL-Format
Versionierte URL: /api/sn_wsd_Concierge/{api_Version}/Presence/Routine
Standard-URL: /api/sn_wsd_Concierge/presence/Routine
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 |
|---|---|
| Routine | Erforderlich. Wöchentliche Routine des authentifizierten Anwenders. Enthält eine boolesche Kennzeichnung für jeden Wochentag, die die geplante Anwesenheit im Büro angibt. Wird Angezeigt Tage, die in der Anforderung ausgelassen werden, bleiben unverändert. Ein leeres Routineobjekt wird als No-OP akzeptiert. Datentyp: Objekt |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json, application/xml, Oder text/xml. |
| Autorisierung | Anmeldeinformationen für Authentifizierung. Unterstützt Standardauthentifizierung oder sitzungsbasierte Authentifizierung. |
| Inhaltstyp | Datenformat des Anforderungstexts: Application/JSON. |
| Header | Beschreibung |
|---|---|
| Inhaltstyp | Datenformat des Antworttexts: Application/JSON. |
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. Fehlender Anforderungstext, ungültiges Format oder keine gültigen Tagesfelder angegeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Objekt, das die Ergebnisse der Anforderung enthält. Datentyp: Objekt |
| Ergebnis.Nachricht | Bestätigungsnachricht, die angibt, dass die Routine aktualisiert wurde. Datentyp: Zeichenfolge |
| Ergebnis.Ergebnis | Enthält das vollständig aktualisierte Routineobjekt mit allen sieben Tagen, einschließlich unveränderter Tage. Datentyp: Objekt |
| Ergebnis.Routine | Wöchentliche Routine im Büro. Enthält eine boolesche Kennzeichnung für jeden Wochentag, an dem Wahr Gibt die Anwesenheit im Büro an, und Falsch Gibt keine Teilnahme an.Datentyp: Objekt |
cURL-Anforderung
Dieses Beispiel aktualisiert nur Freitag und Samstag auf „wahr“, sodass alle anderen Tage unverändert bleiben.
curl "https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/routine" \
--request PATCH \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username:password" \
--data '{
"routine": { "friday": true, "saturday": true }
}'
Antworttext.
{
"result": {
"message": "Routine updated successfully",
"result": {
"routine": {
"monday": true, "tuesday": true, "wednesday": true,
"thursday": true, "friday": true, "saturday": true, "sunday": false
}
}
}
}
WSD-Anwesenheit: VERÖFFENTLICHEN SIE /api/sn_wsd_Concierge/v1/presence/Collaborator
Fügt der Sichtbarkeit der Anwesenheit des authentifizierten Anwenders einen oder mehrere Mitarbeitende hinzu. Mitarbeitende können dann die Anwesenheitsdaten der anderen anzeigen. Verwenden Sie diesen Endpunkt, um ein Team oder eine Gruppe von Kollegen zu erstellen, deren Bürobesuch Sie nachverfolgen möchten.
URL-Format
Versionierte URL: /api/sn_wsd_Concierge/{api_Version}/presence/Collaborator
Standard-URL: /api/sn_wsd_Concierge/presence/Collaborator
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 |
|---|---|
| Collaborator_IDs | Erforderlich. Nicht leeres Array von sys_ID-Werten, das Anwender identifiziert, die als Mitarbeitende hinzugefügt werden sollen. Tabelle: Benutzer [sys_user] Datentyp: Array von Zeichenfolgen |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json, application/xml, Oder text/xml. |
| Autorisierung | Anmeldeinformationen für Authentifizierung. Unterstützt Standardauthentifizierung oder sitzungsbasierte Authentifizierung. |
| Inhaltstyp | Datenformat des Anforderungstexts: Application/JSON. |
| Header | Beschreibung |
|---|---|
| Inhaltstyp | Datenformat des Antworttexts: Application/JSON. |
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. Collaborator_IDs fehlen, leeres Array oder ungültiges sys_ID-Format. |
| 404 | Nicht gefunden. Mindestens eine sys_IDs des Mitarbeitenden wurde in der Tabelle „sys_user“ nicht gefunden. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Objekt, das die Ergebnisse der Anforderung enthält. Datentyp: Objekt |
| Ergebnis.Nachricht | Bestätigungsnachricht, die angibt, dass Mitarbeitende hinzugefügt wurden. Datentyp: Zeichenfolge |
| Ergebnis.Mitarbeitende | Liste der neu hinzugefügten Mitarbeitenden mit ihren Anwesenheitsdaten. Datentyp: Array von Objekten |
| Ergebnis.Mitarbeitende.sys_ID | SYS_ID des Anwenderdatensatzes des mitarbeitenden. Tabelle: Benutzer [sys_user] Datentyp: Zeichenfolge |
| result.collaborators.name | Der Anzeigename des mitarbeitenden, wie er in seinem sys_user-Datensatz angezeigt wird. Tabelle: Benutzer [sys_user] Datentyp: Zeichenfolge |
| Ergebnis.Mitarbeitende.Datenschutz_aktiviert | Boolescher Wert. Kennzeichnung, die angibt, ob der mitarbeitende den Datenschutz für seine Anwesenheitsdaten aktiviert hat. Gültige Werte:
Datentyp: Boolesch |
| Ergebnis.Mitarbeitende.Routine | Die wöchentliche Routine des Mitarbeitenden im Büro. Enthält eine boolesche Kennzeichnung für jeden Wochentag, die die geplante Anwesenheit im Büro angibt. Wird Angezeigt Datentyp: Objekt |
| Ergebnis.Mitarbeitende.Ausnahmen | Ausnahmen der einmaligen Anwesenheit des mitarbeitenden. Gibt ein leeres Array zurück, wenn Privacy_enabled Ist Wahr .Datentyp: Array von Objekten |
| Ergebnis.Mitarbeitende.Ausnahmen.sys_ID | SYS_ID des Ausnahmedatensatzes. Tabelle: Ausnahmen bei Mitarbeiteranwesenheit (sn_wsd_concierge_employee_presence_exception) Datentyp: Zeichenfolge |
| result.collaborators.exceptions.date | Datum, für das diese Ausnahme gilt. Dies ist das Datum, an dem die Routine des Anwenders überschrieben wird. Format: Format jjjj-MM-TT Datentyp: Zeichenfolge |
| result.collaborators.exceptions.in_office | Kennzeichnung, die angibt, ob der Anwender an diesem Datum im Büro ist. Dies überschreibt alles, was die wöchentliche Routine für diesen Wochentag vorgibt. Gültige Werte:
Datentyp: Zeichenfolge |
| Ergebnis.Mitarbeitende.Ausnahmen.Ursprung | Quelle, die die Ausnahme erstellt hat. Gültige Werte:
Datentyp: Zeichenfolge |
| Ergebnis.Mitarbeitende.Ausnahmen.Standort | Der Name oder Bezeichner des Bürostandorts, an dem sich der Anwender an diesem Datum befindet. Nur relevant, wenn In_Office Ist Wahr . Kann eine leere Zeichenfolge sein, wenn der Anwender Remote ist.Datentyp: Zeichenfolge |
cURL-Anforderung
In diesem Beispiel werden zwei Anwender als Mitarbeitende hinzugefügt, indem ihre sys_IDs angegeben werden.
curl "https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/collaborator" \
--request POST \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username:password" \
--data '{
"collaborator_ids": ["usr1a2b3c4d5e6", "usr7f8g9h0i1j2"]
}'
Antworttext.
{
"result": {
"message": "Collaborator(s) added successfully",
"collaborators": [
{
"sys_id": "usr1a2b3c4d5e6", "name": "Jane Smith", "privacy_enabled": false,
"routine": { "monday": true, "tuesday": true, "wednesday": false, "thursday": true, "friday": false, "saturday": false, "sunday": false },
"exceptions": []
},
{ "sys_id": "usr7f8g9h0i1j2", "name": "John Doe", "privacy_enabled": true, "routine": null, "exceptions": [] }
]
}
}
WSD-Anwesenheit – POST /api/sn_wsd_Concierge/v1/presence/Exception
Erstellt eine einmalige Anwesenheitsausnahme für den authentifizierten Anwender an einem bestimmten Datum. Verwenden Sie diesen Endpunkt, wenn ein Anwender an einem Tag im Büro sein möchte, an dem er normalerweise Remote arbeitet, oder umgekehrt.
Ausnahmen überschreiben die wöchentliche Routine des Anwenders für dieses Datum.
URL-Format
Versionierte URL: /api/sn_wsd_Concierge/[api_Version}/Präsenz/Ausnahme
Standard-URL: /api/sn_wsd_Concierge/presence/Exception
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 |
|---|---|
| Ausnahme | Erforderlich. Ausnahmeobjekt, das die Überschreibung der einmaligen Anwesenheit definiert. Datentyp: Objekt |
| Ausnahme.Datum | Datum der Ausnahme. Format: jjjj-MM-tt Datentyp: Zeichenfolge |
| exception.in_office | Kennzeichnung, die angibt, ob der Anwender an diesem Datum im Büro ist. Mögliche Werte:
Datentyp: Boolesch |
| Ausnahme.Standort | Name oder Bezeichner des Bürostandorts für diese Ausnahme. Datentyp: Zeichenfolge |
| Ausnahme.Ursprung | Quelle der Ausnahme. Gültige Werte: Datentyp: Zeichenfolge
|
| Ausnahme.sys_ID | SYS_ID der vorhandenen zu aktualisierenden Ausnahme. Tabelle: Ausnahmen bei Mitarbeiteranwesenheit (sn_wsd_concierge_employee_presence_exception) Datentyp: Zeichenfolge |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json, application/xml, Oder text/xml. |
| Autorisierung | Anmeldeinformationen für Authentifizierung. Unterstützt Standardauthentifizierung oder sitzungsbasierte Authentifizierung. |
| Inhaltstyp | Datenformat des Anforderungstexts: Application/JSON. |
| Header | Beschreibung |
|---|---|
| Inhaltstyp | Datenformat des Antworttexts: Application/JSON. |
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. Erforderliches Felddatum fehlt oder ungültiges Datumsformat. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Objekt, das das Ergebnis der Anforderung enthält. Datentyp: Objekt |
| Ergebnis.Nachricht | Bestätigungsnachricht, die angibt, dass die Ausnahme hinzugefügt wurde. Datentyp: Zeichenfolge |
| Ergebnis.Ergebnis | Objekt, das die erstellten Ausnahmen enthält. Datentyp: Objekt |
| Ergebnis.Ausnahmen | Array mit Details zu den erstellten Ausnahmen. Datentyp: Array von Objekten |
| result.result.exceptions.date | Datum, für das diese Ausnahme gilt, im Format JJJJ-MM-TT. Dies ist das Datum, an dem die Routine des Anwenders überschrieben wird. Datentyp: Zeichenfolge |
| result.result.exceptions.in_office | Kennzeichnung, die angibt, ob der Anwender an diesem Datum im Büro ist. Dies überschreibt alles, was die wöchentliche Routine für diesen Wochentag vorgibt. Gültige Werte:
Datentyp: Zeichenfolge |
| Ergebnis.Ergebnis.Ausnahmen.Standort | Der Name oder Bezeichner des Bürostandorts, an dem sich der Anwender an diesem Datum befindet. Nur relevant, wenn In_Office Ist Wahr . Kann eine leere Zeichenfolge sein, wenn der Anwender Remote ist.Datentyp: Zeichenfolge |
| Ergebnis.Ergebnis.Ausnahmen.Ursprung | Quelle, die die Ausnahme erstellt hat. Gültige Werte:
Datentyp: Zeichenfolge |
| Ergebnis.Ergebnis.Ausnahmen.sys_ID | SYS_ID des Ausnahmedatensatzes. Tabelle: Ausnahmen bei Mitarbeiteranwesenheit (sn_wsd_concierge_employee_presence_exception) Datentyp: Zeichenfolge |
cURL-Anforderung
Dieses Beispiel erstellt eine Anwesenheitsausnahme für den 14. Februar 2026, die den Anwender als im Büro in Gebäude A. markiert
curl "https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/exception" \
--request POST \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username:password" \
--data '{
"exception": {
"date": "2026-02-14",
"in_office": true,
"location": "Building A - Floor 3",
"origin": "user"
}
}'
Antworttext.
{
"result": {
"message": "Exception added successfully",
"result": {
"exceptions": [
{
"sys_id": "a1b2c3d4e5f6g7h8",
"date": "2026-02-14",
"in_office": true,
"origin": "user",
"location": "Building A - Floor 3"
}
]
}
}
}
WSD-Anwesenheit – POST /api/sn_wsd_Concierge/v1/presence/Routine
Erstellt eine neue wöchentliche Routine im Büro für den authentifizierten Anwender. Verwenden Sie diesen Endpunkt, wenn ein Anwender seine Anwesenheitsroutine zum ersten Mal einrichtet.
Alle sieben Tage der Woche müssen als boolesche Werte angegeben werden.
URL-Format
Versionierte URL: /api/sn_wsd_Concierge/{api_Version}/Presence/Routine
Standard-URL: /api/sn_wsd_Concierge/presence/Routine
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 |
| Routine | Erforderlich. Wöchentliche Routine im Büro für den Anwender. Enthält eine boolesche Kennzeichnung für jeden Wochentag, die die geplante Anwesenheit im Büro angibt. Wird Angezeigt Alle Tage sind erforderlich. Datentyp: Objekt |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json, application/xml, Oder text/xml. |
| Autorisierung | Anmeldeinformationen für Authentifizierung. Unterstützt Standardauthentifizierung oder sitzungsbasierte Authentifizierung. |
| Inhaltstyp | Datenformat des Anforderungstexts: Application/JSON. |
| Header | Beschreibung |
|---|---|
| Inhaltstyp | Datenformat des Antworttexts: Application/JSON. |
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. Fehlende Pflichtfelder oder ungültiger Datentyp. Alle sieben Tage müssen als boolesche Werte angegeben werden. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Objekt, das die Ergebnisse der Anforderung enthält. Datentyp: Objekt |
| Ergebnis.Nachricht | Bestätigungsnachricht, die angibt, dass die Routine erstellt wurde. Datentyp: Zeichenfolge |
| Ergebnis.Ergebnis | Enthält das erstellte Routineobjekt mit allen sieben Tagen. Datentyp: Objekt |
| Ergebnis.Routine | Wöchentliche Routine des Anwenders im Büro. Enthält eine boolesche Kennzeichnung für jeden Wochentag, die die geplante Anwesenheit im Büro angibt. Wird Angezeigt Datentyp: Objekt |
cURL-Anforderung
In diesem Beispiel wird eine wöchentliche Routine im Büro für Montag bis Donnerstag erstellt.
curl "https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/routine" \
--request POST \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username:password" \
--data '{
"routine": {
"monday": true, "tuesday": true, "wednesday": true,
"thursday": true, "friday": false, "saturday": false, "sunday": false
}
}'
Antworttext.
{
"result": {
"message": "Routine created successfully",
"result": {
"routine": {
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": false,
"saturday": false,
"sunday": false
}
}
}
}
WSD-Anwesenheit – PUT /api/sn_wsd_Concierge/v1/presence/Exception
Aktualisiert eine vorhandene Anwesenheitsausnahme, indem sie abgebrochen und ein Ersatz erstellt wird. Die ursprüngliche Ausnahme wird anhand ihrer sys_ID identifiziert Verwenden Sie diesen Endpunkt, wenn ein Anwender die Details einer zuvor erstellten Ausnahme ändern muss.
URL-Format
Versionierte URL: /api/sn_wsd_Concierge/{api_Version}/Presence/Exception
Standard-URL: /api/sn_wsd_Concierge/presence/Exception
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 |
|---|---|
| Ausnahme | Erforderlich. Ausnahmeobjekt mit den aktualisierten Details. Die sys_idUnd in_officeFelder sind erforderlich. Datentyp: Objekt |
| Ausnahme.Datum | Datum der Ausnahme. Format: jjjj-MM-tt Datentyp: Zeichenfolge |
| exception.in_office | Erforderlich. Kennzeichnung, die angibt, ob der Anwender an diesem Datum im Büro ist. Mögliche Werte:
Datentyp: Boolesch |
| Ausnahme.Standort | Name oder Bezeichner des Bürostandorts für diese Ausnahme. Datentyp: Zeichenfolge |
| Ausnahme.Ursprung | Quelle der Ausnahme. Gültige Werte:
Datentyp: Zeichenfolge Standard: Anwender |
| Ausnahme.sys_ID | Erforderlich. SYS_ID der vorhandenen zu aktualisierenden Ausnahme. Tabelle: Ausnahmen bei Mitarbeiteranwesenheit (sn_wsd_concierge_employee_presence_exception) Datentyp: Zeichenfolge |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json, application/xml, Oder text/xml. |
| Autorisierung | Anmeldeinformationen für Authentifizierung. Unterstützt Standardauthentifizierung oder sitzungsbasierte Authentifizierung. |
| Inhaltstyp | Datenformat des Anforderungstexts: Application/JSON. |
| Header | Beschreibung |
|---|---|
| Inhaltstyp | Datenformat des Antworttexts: Application/JSON. |
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. Fehlende Pflichtfelder „sys_ID“ oder „in_Office“. |
| 404 | Nicht gefunden. Die angegebene Ausnahme wurde nicht gefunden, oder der Anwender hat keine Berechtigung zum Ändern. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Objekt, das die Ergebnisse der Anforderung enthält. Datentyp: Objekt |
| Ergebnis.Nachricht | Bestätigungsnachricht, die angibt, dass die Ausnahme aktualisiert wurde. Datentyp: Zeichenfolge |
| Ergebnis.Ergebnis | Enthält die aktualisierten Ausnahmen. Datentyp: Objekt |
| Ergebnis.Ergebnis.Ausnahmen | Liste der Anwesenheitsausnahmen. Datentyp: Array von Objekten |
| Ergebnis.Ergebnis.Ausnahmen.sys_ID | SYS_ID des Ausnahmedatensatzes. Tabelle: Ausnahmen bei Mitarbeiteranwesenheit (sn_wsd_concierge_employee_presence_exception) Datentyp: Zeichenfolge |
| result.exceptions.date | Datum, für das diese Ausnahme gilt, im Format JJJJ-MM-TT. Dies ist das Datum, an dem die Routine des Anwenders überschrieben wird. Datentyp: Zeichenfolge |
| result.exceptions.in_office | Kennzeichnung, die angibt, ob der Anwender an diesem Datum im Büro ist. Dies überschreibt alles, was die wöchentliche Routine für diesen Wochentag vorgibt. Gültige Werte:
Datentyp: Zeichenfolge |
| Ergebnis.Ausnahmen.Ursprung | Quelle, die die Ausnahme erstellt hat. Gültige Werte:
Datentyp: Zeichenfolge |
| Ergebnis.Ausnahmen.Standort | Der Name oder Bezeichner des Bürostandorts, an dem sich der Anwender an diesem Datum befindet. Nur relevant, wenn In_Office Ist Wahr . Kann eine leere Zeichenfolge sein, wenn der Anwender Remote ist.Datentyp: Zeichenfolge |
cURL-Anforderung
Dieses Beispiel aktualisiert eine vorhandene Ausnahme, um den Status des Anwenders am selben Datum in „Remote“ (nicht im Büro) zu ändern.
curl "https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/exception" \
--request PUT \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username:password" \
--data '{
"exception": {
"sys_id": "exc1a2b3c4d5e6",
"in_office": false,
"date": "2026-02-14",
"location": "",
"origin": "user"
}
}'
Antworttext.
{
"result": {
"message": "Exception updated successfully",
"result": {
"exceptions": [
{ "sys_id": "exc9k0l1m2n3o4", "date": "2026-02-14", "in_office": false, "origin": "user", "location": "" }
]
}
}
}