API für eingeladene WSD-Reservierungen
Die Workplace Service Delivery (WSD) Reservation Invitees- API bietet Endpunkte zum Hinzufügen eingeladener Personen zu Reservierungen, zum Abrufen eingeladener Personen einer Reservierung und zum erneuten Zuweisen eingeladener Personen einer Reservierung.
Um auf diese API zuzugreifen, muss der Anrufer über die Rolle sn_wsd_core.workplace_user verfügen, und das Plugin „Management von Arbeitsplatz-Reservierungen“ (sn_wsd_rsv) muss 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.
Eingeladene Personen für WSD-Reservierung – GET /api/sn_wsd_rsv/wsd_reservation_invitees/reservation/{sys_id}
Ruft Details zu den eingeladenen Personen ab, die einer angegebenen Reservierung zugeordnet sind.
URL-Format
URL mit Versionsnummer: /api/sn_wsd_rsv/{api_version}/wsd_reservation_invitees/reservation/{sys_id}
Standard-URL: /api/sn_wsd_rsv/reservation/{sys_id}
Unterstützte Anforderungsparameter
| 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 |
| sys_id | Sys_id der Reservierung, für die die Details der eingeladenen Person zurückgegeben werden sollen. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| 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.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| 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-Antwortcodes der REST-API.
| 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 | Gibt Ergebnisse für die eingeladenen Personen zurück, die der angegebenen Reservierung zugeordnet sind. Datentyp: Objekt |
| „ergebnis.eingeladene“ | Details zu den eingeladenen Personen, die der Reservierung zugeordnet sind. Datentyp: Array von Objekten |
| result.invitees.email | E-Mail-Adresse der eingeladenen Person. Datentyp: Zeichenfolge |
| Ergebnis.Eingeladene Personen.firstName | Vorname der eingeladenen Person. Datentyp: Zeichenfolge |
| Ergebnis.eingeladene Personen.Einladungs-ID | Sys_id des Anwenderdatensatzes des Mitarbeiters. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
| Ergebnis.Eingeladene.Einladungsstatus | Details zum aktuellen Status des eingeladenen Anwenders für die Reservierung. Datentyp: Objekt |
| Ergebnis.eingeladene Personen.Einladungsstatus.Anzeigewert | Anzeigewert für den Status der eingeladenen Person, z. B. „Neu“ oder „Entfernt“. Datentyp: Zeichenfolge |
| Ergebnis.eingeladene Personen.Einladungsstatus.Wert | Interner Wert für den Status der eingeladenen Person. Datentyp: Zeichenfolge |
| result.invitees.inviteeType | Typ der eingeladenen Person. Gültige Werte: (Groß-/Kleinschreibung beachten)
Datentyp: Zeichenfolge |
| Ergebnis.Eingeladene Personen.istVIP | Kennzeichnung, die angibt, ob der eingeladene Teilnehmer als VIP klassifiziert ist. Gültige Werte:
Datentyp: Boolesch |
| Ergebnis.eingeladene Personen.istWifiErforderlich | Kennzeichnung, die angibt, ob das WLAN-Passwort dem Besucher am Eingang bereitgestellt werden soll. Gültige Werte:
Datentyp: Boolesch |
| Ergebnis.Eingeladene Personen.istParkenErforderlich | Kennzeichnung, die angibt, ob die eingeladene Person einen Parkplatz benötigt. Gültige Werte:
Datentyp: Boolesch |
| Ergebnis.Eingeladene Personen.lastName | Nachname der eingeladenen Person. Datentyp: Zeichenfolge |
| result.invitees.licensePlate | Nummernschild des eingeladenen Teilnehmers. Datentyp: Zeichenfolge |
| Ergebnis.Eingeladene.Ort | Details zum Arbeitsplatzstandort der eingeladenen Person. Datentyp: Objekt |
| Ergebnis.Eingeladene Personen.Standort.Anzeigename | Anzeigename des Arbeitsplatzstandorts der eingeladenen Person, z. B. Paris. Datentyp: Zeichenfolge |
| result.eventees.location.sysId | Sys_id des Arbeitsplatzstandorts der eingeladenen Person. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzstandort [sn_wsd_core_worplace_location] |
| result.invitees.name | Name der eingeladenen Person. Datentyp: Zeichenfolge |
| result.invitees.org | Organisation des eingeladenen Unternehmens. Datentyp: Zeichenfolge |
| result.eventees.parkingType | Art des für die eingeladene Person erforderlichen Parkplatzes. Gültige Werte: (Groß-/Kleinschreibung beachten)
Datentyp: Zeichenfolge |
| Ergebnis.Eingeladene.Telefonnummer | Telefonnummer der eingeladenen Person. Datentyp: Zeichenfolge |
| Ergebnis.Eingeladene.PrivateNotizen | Alle zusätzlichen Hinweise, die von der eingeladenen Person bereitgestellt wurden. Datentyp: Zeichenfolge |
| Ergebnis.Eingeladene Personen.Reservierungs-ID | Sys_id der Reservierung, der die eingeladene Person zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzreservierung [sn_wsd_rsv_reservation] |
| „ergebnis.eingeladene Personen.reservationEinladungs-ID“ | Sys_id des eingeladenen Reservierungsempfängers für Besucher. Datentyp: Zeichenfolge Tabelle: Eingeladene Person für Reservierung [sn_wsd_rsv_m2m_reservation_invitee] |
| Ergebnis.Eingeladene.Titel | Titel der eingeladenen Person. Datentyp: Zeichenfolge |
| result.eventees.visitorType | Typ der eingeladenen Person. Gültige Werte: (Groß-/Kleinschreibung beachten)
Datentyp: Zeichenfolge |
| result.reservationId | Sys_id der Reservierung, der die eingeladene Person zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzreservierung [sn_wsd_rsv_reservation] |
| result.reservationSubType | Untertyp des Reservierungsdatensatzes, z. B. einzeln oder mehrfach untergeordnet. Datentyp: Zeichenfolge |
| Ergebnis.Erfolg | Kennzeichnung, die angibt, ob der Anruf erfolgreich war. Mögliche Werte:
Datentyp: Boolesch |
cURL-Anforderung
Das folgende Codebeispiel zeigt, wie die eingeladenen Personen für eine Reservierung abgerufen werden.
curl
"http://instance.servicenow.com/api/sn_wsd_rsv/wsd_reservation_invitees/reservation/17979dc9536b01103cf7ddeeff7b12b3" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
Ergebnisse zurückgeben:
{
"result": {
"success": true,
"reservationId": "17979dc9536b01103cf7ddeeff7b12b3",
"reservationSubType": "single",
"invitees": [
{
"reservationId": "17979dc9536b01103cf7ddeeff7b12b3",
"location": {
"sysId": "19efb84edb7650106c731dcd1396193c",
"displayName": "Dublin"
},
"reservationInviteeId": "1f97d58d53e701103cf7ddeeff7b129a",
"inviteeType": "employee",
"inviteState": {
"displayValue": "New",
"value": "new"
},
"inviteeId": "6816f79cc0a8016401c5a33be04be441",
"name": "System Administrator",
"email": "admin@example.com"
},
{
"reservationId": "17979dc9536b01103cf7ddeeff7b12b3",
"location": {
"sysId": "19efb84edb7650106c731dcd1396193c",
"displayName": "Dublin"
},
"reservationInviteeId": "8ee7ddc9536b01103cf7ddeeff7b1219",
"inviteeType": "employee",
"inviteState": {
"displayValue": "New",
"value": "new"
},
"inviteeId": "62826bf03710200044e0bfc8bcbe5df1",
"name": "Abel Tuter",
"email": "abel.tuter@example.com"
},
{
"reservationId": "17979dc9536b01103cf7ddeeff7b12b3",
"location": {
"sysId": "19efb84edb7650106c731dcd1396193c",
"displayName": "Dublin"
},
"reservationInviteeId": "4ae7d10d536b01103cf7ddeeff7b126b",
"inviteeType": "visitor",
"inviteState": {
"displayValue": "New",
"value": "new"
},
"inviteeId": "86e7d10d536b01103cf7ddeeff7b1267",
"firstName": "Visitor",
"lastName": "User",
"name": "Visitor User",
"email": "visitoruser@example.com",
"phoneNumber": "+919876543210",
"isVIP": true,
"parkingType": "normal_parking",
"licensePlate": "1234",
"isParkingRequired": true,
"org": "Senow",
"visitorType": "contractor",
"title": "President",
"isWifiRequired": true,
"privateNotes": "Visiting"
}
]
}
}
WSD-Reservierung Eingeladene Personen: POST /api/sn_wsd_rsv/wsd_reservation_invitees/reassign
Weist die angegebenen eingeladenen Personen von einer Reservierung einer anderen zu.
URL-Format
URL mit Versionsnummer: /api/sn_wsd_rsv/{api_version}/wsd_reservation_invitees/reassign
Standard-URL: /api/sn_wsd_rsv/wsd_reservation_invitees/reassign
Unterstützte Anforderungsparameter
| 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 |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Reservierungs-ID | Erforderlich. Sys_id der Reservierung, der die eingeladenen Personen neu zugewiesen werden sollen. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzreservierung [sn_wsd_rsv_reservation] |
| reservierungEingeladene Personen | Liste der eingeladenen Personen, die der im Parameter reservationId angegebenen Reservierung neu zugewiesen werden sollen. Dadurch werden die angegebenen eingeladenen Personen aus einer früheren Reservierung entfernt, in der sie gemäß der Tabelle der eingeladenen Personen der Reservierung anwesend waren, und werden in diese Reservierung verschoben. Datentyp: Array von Zeichenfolgen Tabelle: Eingeladene Person für Reservierung [sn_wsd_rsv_m2m_reservation_invitee] |
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.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Anforderungstexts. Unterstützte Typen: application/json, application/xml oder, text/xml Standard: application/json |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| 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-Antwortcodes der REST-API.
| 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 Neuzuweisung der eingeladenen Person. Datentyp: Objekt |
| result.reservationEinladungIds | Liste der sys_ids der eingeladenen Personen der Reservierung, die der angegebenen Reservierung neu zugewiesen wurden. Datentyp: Array von Zeichenfolgen |
| Ergebnis.Erfolg | Kennzeichnung, die angibt, ob die eingeladenen Personen der Reservierung neu zugewiesen wurden. Mögliche Werte:
Datentyp: Boolesch |
cURL-Anforderung
Das folgende Codebeispiel zeigt, wie eingeladene Personen einer Reservierung neu zugewiesen werden.
curl "http://instance.servicenow.com/api/sn_wsd_rsv/wsd_reservation_invitees/reassign" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"reservationId\":\"3984e6c1532f01103cf7ddeeff7b129b\",
\"reservationInvitees\":{\"aa31427f531701103cf7ddeeff7b1243\",\"e231427f531701103cf7ddeeff7b1243\"}
}" \
--user 'username':'password'
Ergebnisse zurückgeben:
{
"result": {
"success": true,
"reservationInviteeIds": [
"aa31427f531701103cf7ddeeff7b1243",
"e231427f531701103cf7ddeeff7b1243"
]
}
}
WSD-Reservierung Eingeladene Personen: POST /api/sn_wsd_rsv/wsd_reservation_invitees/submit
Fügt die angegebenen eingeladenen Personen zu einer angegebenen Reservierung hinzu.
URL-Format
URL mit Versionsnummer: /api/sn_wsd_rsv/{api_version}/wsd_reservation_invitees/submit
Standard-URL: /api/sn_wsd_rsv/wsd_reservation_invitees/submit
Unterstützte Anforderungsparameter
| 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 |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| eingeladene Personen | Liste der eingeladenen Personen, die der angegebenen Reservierung hinzugefügt werden sollen. Datentyp: Objekt |
| einladene Personen.E-Mail | Erforderlich, wenn inviteeType „visitor“ ist. E-Mail-Adresse der eingeladenen Person. Datentyp: Zeichenfolge |
| eingeladene Personen.firstName | Vorname der eingeladenen Person. Datentyp: Zeichenfolge |
| „eingeladene.einladungs-ID“ | Erforderlich, wenn inviteType „Mitarbeiter“ ist. Sys_id des Anwenderdatensatzes des Mitarbeiters. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
| einladene.einladungsTyp | Erforderlich. Typ der eingeladenen Person. Gültige Werte: (Groß-/Kleinschreibung beachten)
Datentyp: Zeichenfolge |
| Eingeladene.istVIP | Kennzeichnung, die angibt, ob der eingeladene Teilnehmer als VIP klassifiziert ist. Gültige Werte:
Datentyp: Boolesch |
| „eingeladene.istWifiErforderlich“ | Kennzeichnung, die angibt, ob das WLAN-Passwort dem Besucher am Eingang bereitgestellt werden soll. Gültige Werte:
Datentyp: Boolesch |
| eingeladene Personen.lastName | Nachname der eingeladenen Person. Datentyp: Zeichenfolge |
| einladene Personen. Lizenznummer | Nummernschild des eingeladenen Teilnehmers. Datentyp: Zeichenfolge |
| invitees.org | Organisation des eingeladenen Unternehmens. Datentyp: Zeichenfolge |
| „eingeladene.parkplatzTyp“ | Art des für die eingeladene Person erforderlichen Parkplatzes. Gültige Werte: (Groß-/Kleinschreibung beachten)
Datentyp: Zeichenfolge |
| einladene Personen.Telefon | Telefonnummer der eingeladenen Person. Datentyp: Zeichenfolge |
| einladene Personen.privateNotizen | Alle zusätzlichen Hinweise, die von der eingeladenen Person bereitgestellt wurden. Datentyp: Zeichenfolge |
| „eingeladene Personen.Titel“ | Titel der eingeladenen Person. Datentyp: Zeichenfolge |
| „eingeladene.besucherTyp“ | Typ der eingeladenen Person. Gültige Werte: (Groß-/Kleinschreibung beachten)
Datentyp: Zeichenfolge |
| Reservierungs-ID | Erforderlich. Sys_id der Reservierung, für die die eingeladenen Personen hinzugefügt werden sollen. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzreservierungen [sn_wsd_rsv_reservation] |
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.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Anforderungstexts. Unterstützte Typen: application/json, application/xml oder, text/xml Standard: application/json |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| 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-Antwortcodes der REST-API.
| 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 | Ergebnis des Hinzufügens der eingeladenen Personen zur Reservierung. Datentyp: Objekt |
| result.reservationId | Sys_id der Reservierung, der die eingeladene Person hinzugefügt wurde. Datentyp: Zeichenfolge |
| Ergebnis.Erfolg | Kennzeichnung, die angibt, ob die eingeladenen Personen der Reservierung hinzugefügt wurden. Mögliche Werte:
Datentyp: Boolesch |
cURL-Anforderung
Das folgende Codebeispiel zeigt, wie einer Reservierung sowohl ein Besucher als auch ein Mitarbeiter hinzugefügt wird.
curl "http://instance.servicenow.com/api/sn_wsd_rsv/v1/wsd_reservation_invitees/submit" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{[
\"reservationId\": \"041c4a13532f01103cf7ddeeff7b12c0\",
\"invitees\": [
{
\"inviteeType\": \"employee\",
\"inviteeId\": \"62826bf03710200044e0bfc8bcbe5df1\"
},
{
\"inviteeType\": \"visitor\",
\"email\": \"visitoruser@example.com\",
\"firstName\": \"Visitor\",
\"lastName\":\"User\",
\"isVIP\":true,
\"visitorType\":\"contractor\",
\"title\": \"ServiceNow Developer\",
\"phone\": \"+91 9876543210\",
\"isWifiRequired\": true,
\"parkingType\": \"ev_parking\",
\"licensePlate\": \"TS00TS0000\",
\"org\": \"ServiceNow\",
\"privateNotes\": \"Remarks\"
}
]}" \
--user 'username':'password'
Ergebnisse zurückgeben:
{
"result": {
"success": true,
"reservationId": "17979dc9536b01103cf7ddeeff7b12b3"
}
}