WSD-Gruppenreservierungs-API
Die Workplace Service Delivery(WSD) Gruppenreservierung Die API stellt Endpunkte für die Verwaltung von Gruppenreservierungen bereit.
Mit Gruppenreservierungen können Sie verschiedene Standorte für verschiedene Personen (Gruppen) für ein und dasselbe Meeting reservieren.
Diese API wird in ausgeführt sn_wsd_rsv Namespace. Um auf diese API zuzugreifen, muss der Anrufer über die Rolle sn_wsd_Core.Workplace_user verfügen, und das Plugin „Workplace Reservation Management“ (sn_wsd_rsv) muss aktiviert sein.
Für zusätzliche Informationen zu Workplace Reservation Management, Siehe Management Von Arbeitsplatzreservierungen .
WSD-Gruppenreservierung: /api/sn_wsd_rsv/Group_reservation/{parent_ID} ABRUFEN
Gibt die übergeordneten und alle untergeordneten Reservierungen für eine angegebene Gruppenreservierung zurück.
URL-Format
Versionierte URL: /api/sn_wsd_rsv/{api_Version}/Group_reservation/{parent_ID}
Standard-URL: /api/sn_wsd_rsv/Group_reservation/{parent_ID}
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
| 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 |
| parent_id | SYS_ID des übergeordneten Reservierungsdatensatzes. Wenn eine Gruppenreservierung erstellt wird, werden ein übergeordneter Gruppendatensatz und ein oder mehrere untergeordnete Reservierungsdatensätze erstellt. Reservierungsdatensätze enthalten ein Feld namens reservation_subtype, das den Typ des Reservierungsdatensatzes angibt. Für übergeordnete Gruppendatensätze wird dieses Feld auf „übergeordnete Gruppe“ festgelegt, um anzugeben, dass es sich um einen übergeordneten Gruppendatensatz handelt. Für untergeordnete Datensätze ist dieses Feld auf „einzeln“ festgelegt. Innerhalb eines untergeordneten Datensatzes befindet sich die sys_ID des zugeordneten übergeordneten Reservierungsdatensatzes im Feld Source_reservation. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzreservierung [sn_wsd_rsv_reservation] |
| 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 Anforderungstexts. Unterstützte Typen: application/json, application/xmlOder, text/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 REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Ungültige oder keine übergeordnete Reservierungs-sys_ID angegeben. |
| 404 | Zugriff verweigert! Gruppenreservierung kann nicht storniert werden. Anwender hat unzureichende Rechte, um die angeforderte Gruppenreservierung zu stornieren. |
| 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 zu den übergeordneten und untergeordneten Reservierungen, die der Gruppenreservierung zugeordnet sind. Datentyp: Objekt |
cURL-Anforderung
Das folgende Codebeispiel zeigt, wie die Details für eine Gruppenreservierung abgerufen werden.
curl "http://instance.servicenow.com/api/sn_wsd_rsv/group_reservation/e2245051533b01103cf7ddeeff7b12d6" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'Ergebnisse zurückgeben:
{
"result": {
"parent": {
"sys_id": "e2245051533b01103cf7ddeeff7b12d6",
"number": "WRES0001142",
"start": "2022-05-30T04:30:00Z",
"end": "2022-05-30T05:30:00Z",
"sys_created_on": "2022-05-30T04:19:02Z",
"sys_updated_on": "2022-05-30T04:19:04Z",
"source_reservation": null,
"check_in_state": {
"value": "not_required",
"display_value": "Not required"
},
"external_id": null,
"external_ical": null,
"active": true,
"state": {
"value": "confirmed",
"display_value": "Confirmed"
},
"sensitivity": {
"value": "normal",
"display_value": "Normal"
},
"reservation_type": {
"value": "space",
"display_value": "Space"
},
"reservation_subtype": {
"value": "group_parent",
"display_value": "Group parent"
},
"reservation_purpose": {
"value": "meeting",
"display_value": "Meeting"
},
"attendees": null,
"number_of_attendees": 1,
"is_parent": true,
"subject": "Test#52",
"virtual_meeting": null,
"recording_details": [],
"sync_state": {
"value": "not_required",
"display_value": "Synchronization not required"
},
"sub_source": {
"value": "servicenow_workplace_service_delivery",
"display_value": "ServiceNow Workplace Service Delivery"
},
"last_updated_sub_source": {
"value": "servicenow_workplace_service_delivery",
"display_value": "ServiceNow Workplace Service Delivery"
},
"reservable_module": {
"sys_id": "5db44502dbb650106c731dcd13961937",
"name": "Desks",
"title": "Desks",
"inline_title": "desk",
"font_awesome_icon": "fa-desktop",
"reservable_table": "sn_wsd_core_space",
"reservable_filter": "active=true^is_reservable=true^location_type=5f017383eb512010b89bfdfc9c5228c8^building.is_reservable=true^floor.is_reservable=true^EQ",
"short_description": "Reserve a single desks",
"reservable_type": "location",
"require_subject": null,
"require_cancel_notes": false,
"virtual_meeting_provider": {
"sys_id": "e33d9e6853c201103cf7ddeeff7b1205",
"display_value": "Template"
},
"allow_invitees": null,
"display_number_of_attendees": null,
"display_on_behalf_of": "1",
"display_sensitivity": null,
"max_days_in_future": "90",
"allow_whole_day": "1",
"require_whole_day": null,
"selection_type": "unit",
"reservable_container_field": null,
"reservable_quantity_field": null,
"apply_to_shift": null,
"max_occurrences": "90",
"enable_facet_filter": false,
"search_limit": 10000,
"enable_ical_generation": null,
"enable_group_reservations": "1",
"enable_browse_near_a_person": "1",
"enable_browse_by_area": "1",
"display_value": "Desks",
"browse_near_a_person_enabled": true,
"browse_by_area_enabled": true,
"reservable_columns": [
"sys_id",
"external_id",
"email",
"name",
"title",
"description",
"image",
"number",
"site",
"campus",
"building",
"floor",
"area",
"capacity",
"reservable_quantity",
"location_type",
"order",
"requires_check_in",
"is_reservable"
],
"layout_mapping": {
"title": [
"name"
],
"description": [
"description"
],
"subtitle": [
"campus",
"building",
"floor",
"area"
],
"subtitle_asc": [
"area",
"floor",
"building",
"campus"
],
"image": "image",
"body": [
{
"label": "Capacity",
"icon": "fa-users",
"field": "capacity",
"field_to_display": ""
},
{
"label": "Standard services",
"icon": "fa-check",
"field": "standard_services",
"field_to_display": "name"
},
{
"label": "Reservable purposes",
"icon": "fa-tags",
"field": "reservable_purposes",
"field_to_display": "name"
}
]
},
"timeSlots": [
{
"sys_id": "d5331cf2dbb5f01038e42b24ca961906",
"name": "All day",
"short_description": "8am - 6pm",
"slot_start": "08:00",
"slot_end": "18:00"
},
{
"sys_id": "de131cf2dbb5f01038e42b24ca961931",
"name": "Before noon",
"short_description": "8am - 12pm",
"slot_start": "08:00",
"slot_end": "12:00"
},
{
"sys_id": "6e99ab5ddbb930102e8e853e68961929",
"name": "After noon",
"short_description": "1pm - 6pm",
"slot_start": "13:00",
"slot_end": "18:00"
}
],
"buildingSysIds": [
"9e0364cedb3650106c731dcd1396192b"
],
"reservable_views": [
{
"type": "card",
"label": "Card view",
"iconClass": "fa-th-large",
"isDefault": true,
"order": "1"
},
{
"type": "schedule",
"label": "Schedule view",
"iconClass": "fa-calendar-o",
"isDefault": false,
"order": "2"
}
],
"checkin_before_minutes": 30,
"reservation_paths": [
{
"value": "browse_all",
"displayValue": "Browse all"
},
{
"value": "browse_near_a_person",
"displayValue": "Browse near a person"
},
{
"value": "browse_by_area",
"displayValue": "Browse by area"
}
],
"override_approval_policy": "never_required"
},
"notification_recipients": null,
"notification_custom_message": null,
"opened_by": {
"sys_id": "6816f79cc0a8016401c5a33be04be441",
"value": "6816f79cc0a8016401c5a33be04be441",
"displayValue": "System Administrator",
"display_value": "System Administrator",
"name": "System Administrator",
"user_name": "admin",
"table": "sys_user",
"avatar": "c148e1d13741310042106710ce41f149.iix?t=small",
"initials": "SA",
"email": "admin@example.com",
"label": "System Administrator, Finance"
},
"requested_for": {
"sys_id": "6816f79cc0a8016401c5a33be04be441",
"value": "6816f79cc0a8016401c5a33be04be441",
"displayValue": "System Administrator",
"display_value": "System Administrator",
"name": "System Administrator",
"user_name": "admin",
"table": "sys_user",
"avatar": "c148e1d13741310042106710ce41f149.iix?t=small",
"initials": "SA",
"email": "admin@example.com",
"label": "System Administrator, Finance"
},
"edit_restriction": {
"value": "no_restriction",
"display_value": "No restriction"
},
"source": {
"value": "servicenow",
"display_value": "Workplace Services"
},
"source_icon": {
"classNames": "fa fa-calendar-check-o",
"tooltip": "Reservation is confirmed",
"imgSrc": ""
},
"shift": null,
"locations": [
{
"sys_id": "73c2698adb7210106c731dcd13961968",
"name": "B1-03-03",
"description": "Desk reserved for the Team-C. After 10am, free to reserve for everyone.",
"display_value": "B1-03-03",
"capacity": 1,
"label_value": "Workspace/Desk name",
"email": null,
"reservable_module": {
"sys_id": "5db44502dbb650106c731dcd13961937",
"name": "Desks",
"title": "Desks",
"inline_title": "desk"
},
"region": {
"sys_id": "2d626c4edb3650106c731dcd1396194b",
"display_value": "Europe",
"active": true
},
"site": {
"sys_id": "b17220cedb3650106c731dcd1396197a",
"display_value": "Western Europe",
"active": true
},
"campus": {
"sys_id": "44d2e0cedb3650106c731dcd13961988",
"display_value": "Amsterdam Campus",
"active": true
},
"building": {
"sys_id": "9e0364cedb3650106c731dcd1396192b",
"display_value": "AMS-B1",
"active": true,
"timezone": {
"value": "Europe/Amsterdam",
"displayValue": "Europe/Amsterdam"
}
},
"floor": {
"sys_id": "5373a8cedb3650106c731dcd1396198a",
"display_value": "Floor 3",
"active": true
},
"area": {
"sys_id": "410ff04edb7650106c731dcd13961973",
"display_value": "Desks C1",
"active": true
},
"reservation": {
"sys_id": "2a24d0d1533b01103cf7ddeeff7b126b",
"number_of_attendees": 1,
"state": {
"value": "confirmed",
"display_value": "Confirmed"
},
"requested_for": {
"sys_id": "62826bf03710200044e0bfc8bcbe5df1",
"value": "62826bf03710200044e0bfc8bcbe5df1",
"displayValue": "Abel Tuter",
"display_value": "Abel Tuter",
"name": "Abel Tuter",
"user_name": "abel.tuter",
"table": "sys_user",
"avatar": "063e38383730310042106710ce41f13b.iix?t=small",
"initials": "AT",
"email": "abel.tuter@example.com",
"label": "Product Management"
},
"number": "WRES0001143",
"active": true
},
"number_of_attendees": 1,
"state": {
"value": "confirmed",
"display_value": "Confirmed"
},
"number": "WRES0001143",
"requested_for": {
"sys_id": "62826bf03710200044e0bfc8bcbe5df1",
"value": "62826bf03710200044e0bfc8bcbe5df1",
"displayValue": "Abel Tuter",
"display_value": "Abel Tuter",
"name": "Abel Tuter",
"user_name": "abel.tuter",
"table": "sys_user",
"avatar": "063e38383730310042106710ce41f13b.iix?t=small",
"initials": "AT",
"email": "abel.tuter@example.com",
"label": "Product Management"
}
},
{
"sys_id": "32f2a98adb7210106c731dcd13961972",
"name": "B1-03-04",
"description": "Desk reserved for the Team-C. After 10am, free to reserve for everyone.",
"display_value": "B1-03-04",
"capacity": 1,
"label_value": "Workspace/Desk name",
"email": null,
"reservable_module": {
"sys_id": "5db44502dbb650106c731dcd13961937",
"name": "Desks",
"title": "Desks",
"inline_title": "desk"
},
"region": {
"sys_id": "2d626c4edb3650106c731dcd1396194b",
"display_value": "Europe",
"active": true
},
"site": {
"sys_id": "b17220cedb3650106c731dcd1396197a",
"display_value": "Western Europe",
"active": true
},
"campus": {
"sys_id": "44d2e0cedb3650106c731dcd13961988",
"display_value": "Amsterdam Campus",
"active": true
},
"building": {
"sys_id": "9e0364cedb3650106c731dcd1396192b",
"display_value": "AMS-B1",
"active": true,
"timezone": {
"value": "Europe/Amsterdam",
"displayValue": "Europe/Amsterdam"
}
},
"floor": {
"sys_id": "5373a8cedb3650106c731dcd1396198a",
"display_value": "Floor 3",
"active": true
},
"area": {
"sys_id": "410ff04edb7650106c731dcd13961973",
"display_value": "Desks C1",
"active": true
},
"reservation": {
"sys_id": "6a24d0d1533b01103cf7ddeeff7b126e",
"number_of_attendees": 1,
"state": {
"value": "confirmed",
"display_value": "Confirmed"
},
"requested_for": {
"sys_id": "a8f98bb0eb32010045e1a5115206fe3a",
"value": "a8f98bb0eb32010045e1a5115206fe3a",
"displayValue": "Abraham Lincoln",
"display_value": "Abraham Lincoln",
"name": "Abraham Lincoln",
"user_name": "abraham.lincoln",
"table": "sys_user",
"avatar": null,
"initials": "AL",
"email": "abraham.lincoln@example.com",
"label": ""
},
"number": "WRES0001144",
"active": true
},
"number_of_attendees": 1,
"state": {
"value": "confirmed",
"display_value": "Confirmed"
},
"number": "WRES0001144",
"requested_for": {
"sys_id": "a8f98bb0eb32010045e1a5115206fe3a",
"value": "a8f98bb0eb32010045e1a5115206fe3a",
"displayValue": "Abraham Lincoln",
"display_value": "Abraham Lincoln",
"name": "Abraham Lincoln",
"user_name": "abraham.lincoln",
"table": "sys_user",
"avatar": null,
"initials": "AL",
"email": "abraham.lincoln@example.com",
"label": ""
}
}
],
"reservationAcl": {
"write": {
"record": true,
"fields": {
"subject": true,
"sensitivity": true,
"requested_for": true,
"number_of_attendees": true,
"location": true
},
"allFields": true
},
"read": true
}
},
"children": [
{
"sys_id": "2a24d0d1533b01103cf7ddeeff7b126b",
"number": "WRES0001143",
"location": {
"sys_id": "73c2698adb7210106c731dcd13961968",
"name": "B1-03-03",
"description": "Desk reserved for the Team-C. After 10am, free to reserve for everyone.",
"display_value": "B1-03-03",
"capacity": 1,
"label_value": "Workspace/Desk name",
"email": null,
"reservable_module": {
"sys_id": "5db44502dbb650106c731dcd13961937",
"name": "Desks",
"title": "Desks",
"inline_title": "desk"
},
"region": {
"sys_id": "2d626c4edb3650106c731dcd1396194b",
"display_value": "Europe",
"active": true
},
"site": {
"sys_id": "b17220cedb3650106c731dcd1396197a",
"display_value": "Western Europe",
"active": true
},
"campus": {
"sys_id": "44d2e0cedb3650106c731dcd13961988",
"display_value": "Amsterdam Campus",
"active": true
},
"building": {
"sys_id": "9e0364cedb3650106c731dcd1396192b",
"display_value": "AMS-B1",
"active": true,
"timezone": {
"value": "Europe/Amsterdam",
"displayValue": "Europe/Amsterdam"
}
},
"floor": {
"sys_id": "5373a8cedb3650106c731dcd1396198a",
"display_value": "Floor 3",
"active": true
},
"area": {
"sys_id": "410ff04edb7650106c731dcd13961973",
"display_value": "Desks C1",
"active": true
},
"reservation": {
"sys_id": "2a24d0d1533b01103cf7ddeeff7b126b",
"number_of_attendees": 1,
"state": {
"value": "confirmed",
"display_value": "Confirmed"
},
"requested_for": {
"sys_id": "62826bf03710200044e0bfc8bcbe5df1",
"name": "Abel Tuter",
"user_name": "abel.tuter"
},
"number": "WRES0001143",
"active": true
},
"number_of_attendees": 1,
"state": {
"value": "confirmed",
"display_value": "Confirmed"
},
"number": "WRES0001143",
"requested_for": {
"sys_id": "62826bf03710200044e0bfc8bcbe5df1",
"name": "Abel Tuter",
"user_name": "abel.tuter"
}
},
"start": "2022-05-30T04:30:00Z",
"end": "2022-05-30T05:30:00Z",
"sys_created_on": "2022-05-30T04:19:02Z",
"sys_updated_on": "2022-05-30T04:19:04Z",
"source_reservation": {
"sys_id": "e2245051533b01103cf7ddeeff7b12d6",
"display_value": "WRES0001142",
"name": "WRES0001142"
},
"check_in_state": {
"value": "awaiting_check_in",
"display_value": "Awaiting check-in"
},
"external_id": null,
"external_ical": null,
"active": true,
"state": {
"value": "confirmed",
"display_value": "Confirmed"
},
"sensitivity": {
"value": "normal",
"display_value": "Normal"
},
"reservation_type": {
"value": "space",
"display_value": "Space"
},
"reservation_subtype": {
"value": "single",
"display_value": "Single"
},
"reservation_purpose": {
"value": "meeting",
"display_value": "Meeting"
},
"attendees": null,
"number_of_attendees": 1,
"is_parent": false,
"subject": "Test#52",
"virtual_meeting": null,
"recording_details": [],
"sync_state": {
"value": "not_required",
"display_value": "Synchronization not required"
},
"sub_source": {
"value": "servicenow_workplace_service_delivery",
"display_value": "ServiceNow Workplace Service Delivery"
},
"last_updated_sub_source": {
"value": "servicenow_workplace_service_delivery",
"display_value": "ServiceNow Workplace Service Delivery"
},
"reservable_module": {
"sys_id": "5db44502dbb650106c731dcd13961937",
"name": "Desks",
"title": "Desks",
"inline_title": "desk",
"font_awesome_icon": "fa-desktop",
"reservable_table": "sn_wsd_core_space",
"reservable_filter": "active=true^is_reservable=true^location_type=5f017383eb512010b89bfdfc9c5228c8^building.is_reservable=true^floor.is_reservable=true^EQ",
"short_description": "Reserve a single desks",
"reservable_type": "location",
"require_subject": null,
"require_cancel_notes": false,
"virtual_meeting_provider": {
"sys_id": "e33d9e6853c201103cf7ddeeff7b1205",
"display_value": "Template"
},
"allow_invitees": null,
"display_number_of_attendees": null,
"display_on_behalf_of": "1",
"display_sensitivity": null,
"max_days_in_future": "90",
"allow_whole_day": "1",
"require_whole_day": null,
"selection_type": "unit",
"reservable_container_field": null,
"reservable_quantity_field": null,
"apply_to_shift": null,
"max_occurrences": "90",
"enable_facet_filter": false,
"search_limit": 10000,
"enable_ical_generation": null,
"enable_group_reservations": "1",
"enable_browse_near_a_person": "1",
"enable_browse_by_area": "1",
"display_value": "Desks",
"browse_near_a_person_enabled": true,
"browse_by_area_enabled": true,
"reservable_columns": [
"sys_id",
"external_id",
"email",
"name",
"title",
"description",
"image",
"number",
"site",
"campus",
"building",
"floor",
"area",
"capacity",
"reservable_quantity",
"location_type",
"order",
"requires_check_in",
"is_reservable"
],
"layout_mapping": {
"title": [
"name"
],
"description": [
"description"
],
"subtitle": [
"campus",
"building",
"floor",
"area"
],
"subtitle_asc": [
"area",
"floor",
"building",
"campus"
],
"image": "image",
"body": [
{
"label": "Capacity",
"icon": "fa-users",
"field": "capacity",
"field_to_display": ""
},
{
"label": "Standard services",
"icon": "fa-check",
"field": "standard_services",
"field_to_display": "name"
},
{
"label": "Reservable purposes",
"icon": "fa-tags",
"field": "reservable_purposes",
"field_to_display": "name"
}
]
},
"timeSlots": [
{
"sys_id": "d5331cf2dbb5f01038e42b24ca961906",
"name": "All day",
"short_description": "8am - 6pm",
"slot_start": "08:00",
"slot_end": "18:00"
},
{
"sys_id": "de131cf2dbb5f01038e42b24ca961931",
"name": "Before noon",
"short_description": "8am - 12pm",
"slot_start": "08:00",
"slot_end": "12:00"
},
{
"sys_id": "6e99ab5ddbb930102e8e853e68961929",
"name": "After noon",
"short_description": "1pm - 6pm",
"slot_start": "13:00",
"slot_end": "18:00"
}
],
"buildingSysIds": [
"9e0364cedb3650106c731dcd1396192b"
],
"reservable_views": [
{
"type": "card",
"label": "Card view",
"iconClass": "fa-th-large",
"isDefault": true,
"order": "1"
},
{
"type": "schedule",
"label": "Schedule view",
"iconClass": "fa-calendar-o",
"isDefault": false,
"order": "2"
}
],
"checkin_before_minutes": 30,
"reservation_paths": [
{
"value": "browse_all",
"displayValue": "Browse all"
},
{
"value": "browse_near_a_person",
"displayValue": "Browse near a person"
},
{
"value": "browse_by_area",
"displayValue": "Browse by area"
}
],
"override_approval_policy": "never_required"
},
"notification_recipients": null,
"notification_custom_message": null,
"opened_by": {
"sys_id": "6816f79cc0a8016401c5a33be04be441",
"value": "6816f79cc0a8016401c5a33be04be441",
"displayValue": "System Administrator",
"display_value": "System Administrator",
"name": "System Administrator",
"user_name": "admin",
"table": "sys_user",
"avatar": "c148e1d13741310042106710ce41f149.iix?t=small",
"initials": "SA",
"email": "admin@example.com",
"label": "System Administrator, Finance"
},
"requested_for": {
"sys_id": "62826bf03710200044e0bfc8bcbe5df1",
"value": "62826bf03710200044e0bfc8bcbe5df1",
"displayValue": "Abel Tuter",
"display_value": "Abel Tuter",
"name": "Abel Tuter",
"user_name": "abel.tuter",
"table": "sys_user",
"avatar": "063e38383730310042106710ce41f13b.iix?t=small",
"initials": "AT",
"email": "abel.tuter@example.com",
"label": "Product Management"
},
"edit_restriction": {
"value": "fully_restricted",
"display_value": "Fully restricted"
},
"source": {
"value": "servicenow",
"display_value": "Workplace Services"
},
"source_reservation_requester": {
"sys_id": "6816f79cc0a8016401c5a33be04be441",
"name": "System Administrator",
"user_name": "admin"
},
"source_icon": {
"classNames": "fa fa-calendar-check-o",
"tooltip": "Reservation is confirmed",
"imgSrc": ""
},
"shift": null,
"reservationAcl": {
"write": {
"record": true,
"fields": {
"subject": true,
"sensitivity": true,
"requested_for": true,
"number_of_attendees": true,
"location": true
},
"allFields": true
},
"read": true
}
},
{
"sys_id": "6a24d0d1533b01103cf7ddeeff7b126e",
"number": "WRES0001144",
"location": {
"sys_id": "32f2a98adb7210106c731dcd13961972",
"name": "B1-03-04",
"description": "Desk reserved for the Team-C. After 10am, free to reserve for everyone.",
"display_value": "B1-03-04",
"capacity": 1,
"label_value": "Workspace/Desk name",
"email": null,
"reservable_module": {
"sys_id": "5db44502dbb650106c731dcd13961937",
"name": "Desks",
"title": "Desks",
"inline_title": "desk"
},
"region": {
"sys_id": "2d626c4edb3650106c731dcd1396194b",
"display_value": "Europe",
"active": true
},
"site": {
"sys_id": "b17220cedb3650106c731dcd1396197a",
"display_value": "Western Europe",
"active": true
},
"campus": {
"sys_id": "44d2e0cedb3650106c731dcd13961988",
"display_value": "Amsterdam Campus",
"active": true
},
"building": {
"sys_id": "9e0364cedb3650106c731dcd1396192b",
"display_value": "AMS-B1",
"active": true,
"timezone": {
"value": "Europe/Amsterdam",
"displayValue": "Europe/Amsterdam"
}
},
"floor": {
"sys_id": "5373a8cedb3650106c731dcd1396198a",
"display_value": "Floor 3",
"active": true
},
"area": {
"sys_id": "410ff04edb7650106c731dcd13961973",
"display_value": "Desks C1",
"active": true
},
"reservation": {
"sys_id": "6a24d0d1533b01103cf7ddeeff7b126e",
"number_of_attendees": 1,
"state": {
"value": "confirmed",
"display_value": "Confirmed"
},
"requested_for": {
"sys_id": "a8f98bb0eb32010045e1a5115206fe3a",
"name": "Abraham Lincoln",
"user_name": "abraham.lincoln"
},
"number": "WRES0001144",
"active": true
},
"number_of_attendees": 1,
"state": {
"value": "confirmed",
"display_value": "Confirmed"
},
"number": "WRES0001144",
"requested_for": {
"sys_id": "a8f98bb0eb32010045e1a5115206fe3a",
"name": "Abraham Lincoln",
"user_name": "abraham.lincoln"
}
},
"start": "2022-05-30T04:30:00Z",
"end": "2022-05-30T05:30:00Z",
"sys_created_on": "2022-05-30T04:19:02Z",
"sys_updated_on": "2022-05-30T04:19:04Z",
"source_reservation": {
"sys_id": "e2245051533b01103cf7ddeeff7b12d6",
"display_value": "WRES0001142",
"name": "WRES0001142"
},
"check_in_state": {
"value": "awaiting_check_in",
"display_value": "Awaiting check-in"
},
"external_id": null,
"external_ical": null,
"active": true,
"state": {
"value": "confirmed",
"display_value": "Confirmed"
},
"sensitivity": {
"value": "normal",
"display_value": "Normal"
},
"reservation_type": {
"value": "space",
"display_value": "Space"
},
"reservation_subtype": {
"value": "single",
"display_value": "Single"
},
"reservation_purpose": {
"value": "meeting",
"display_value": "Meeting"
},
"attendees": null,
"number_of_attendees": 1,
"is_parent": false,
"subject": "Test#52",
"virtual_meeting": null,
"recording_details": [],
"sync_state": {
"value": "not_required",
"display_value": "Synchronization not required"
},
"sub_source": {
"value": "servicenow_workplace_service_delivery",
"display_value": "ServiceNow Workplace Service Delivery"
},
"last_updated_sub_source": {
"value": "servicenow_workplace_service_delivery",
"display_value": "ServiceNow Workplace Service Delivery"
},
"reservable_module": {
"sys_id": "5db44502dbb650106c731dcd13961937",
"name": "Desks",
"title": "Desks",
"inline_title": "desk",
"font_awesome_icon": "fa-desktop",
"reservable_table": "sn_wsd_core_space",
"reservable_filter": "active=true^is_reservable=true^location_type=5f017383eb512010b89bfdfc9c5228c8^building.is_reservable=true^floor.is_reservable=true^EQ",
"short_description": "Reserve a single desks",
"reservable_type": "location",
"require_subject": null,
"require_cancel_notes": false,
"virtual_meeting_provider": {
"sys_id": "e33d9e6853c201103cf7ddeeff7b1205",
"display_value": "Template"
},
"allow_invitees": null,
"display_number_of_attendees": null,
"display_on_behalf_of": "1",
"display_sensitivity": null,
"max_days_in_future": "90",
"allow_whole_day": "1",
"require_whole_day": null,
"selection_type": "unit",
"reservable_container_field": null,
"reservable_quantity_field": null,
"apply_to_shift": null,
"max_occurrences": "90",
"enable_facet_filter": false,
"search_limit": 10000,
"enable_ical_generation": null,
"enable_group_reservations": "1",
"enable_browse_near_a_person": "1",
"enable_browse_by_area": "1",
"display_value": "Desks",
"browse_near_a_person_enabled": true,
"browse_by_area_enabled": true,
"reservable_columns": [
"sys_id",
"external_id",
"email",
"name",
"title",
"description",
"image",
"number",
"site",
"campus",
"building",
"floor",
"area",
"capacity",
"reservable_quantity",
"location_type",
"order",
"requires_check_in",
"is_reservable"
],
"layout_mapping": {
"title": [
"name"
],
"description": [
"description"
],
"subtitle": [
"campus",
"building",
"floor",
"area"
],
"subtitle_asc": [
"area",
"floor",
"building",
"campus"
],
"image": "image",
"body": [
{
"label": "Capacity",
"icon": "fa-users",
"field": "capacity",
"field_to_display": ""
},
{
"label": "Standard services",
"icon": "fa-check",
"field": "standard_services",
"field_to_display": "name"
},
{
"label": "Reservable purposes",
"icon": "fa-tags",
"field": "reservable_purposes",
"field_to_display": "name"
}
]
},
"timeSlots": [
{
"sys_id": "d5331cf2dbb5f01038e42b24ca961906",
"name": "All day",
"short_description": "8am - 6pm",
"slot_start": "08:00",
"slot_end": "18:00"
},
{
"sys_id": "de131cf2dbb5f01038e42b24ca961931",
"name": "Before noon",
"short_description": "8am - 12pm",
"slot_start": "08:00",
"slot_end": "12:00"
},
{
"sys_id": "6e99ab5ddbb930102e8e853e68961929",
"name": "After noon",
"short_description": "1pm - 6pm",
"slot_start": "13:00",
"slot_end": "18:00"
}
],
"buildingSysIds": [
"9e0364cedb3650106c731dcd1396192b"
],
"reservable_views": [
{
"type": "card",
"label": "Card view",
"iconClass": "fa-th-large",
"isDefault": true,
"order": "1"
},
{
"type": "schedule",
"label": "Schedule view",
"iconClass": "fa-calendar-o",
"isDefault": false,
"order": "2"
}
],
"checkin_before_minutes": 30,
"reservation_paths": [
{
"value": "browse_all",
"displayValue": "Browse all"
},
{
"value": "browse_near_a_person",
"displayValue": "Browse near a person"
},
{
"value": "browse_by_area",
"displayValue": "Browse by area"
}
],
"override_approval_policy": "never_required"
},
"notification_recipients": null,
"notification_custom_message": null,
"opened_by": {
"sys_id": "6816f79cc0a8016401c5a33be04be441",
"value": "6816f79cc0a8016401c5a33be04be441",
"displayValue": "System Administrator",
"display_value": "System Administrator",
"name": "System Administrator",
"user_name": "admin",
"table": "sys_user",
"avatar": "c148e1d13741310042106710ce41f149.iix?t=small",
"initials": "SA",
"email": "admin@example.com",
"label": "System Administrator, Finance"
},
"requested_for": {
"sys_id": "a8f98bb0eb32010045e1a5115206fe3a",
"value": "a8f98bb0eb32010045e1a5115206fe3a",
"displayValue": "Abraham Lincoln",
"display_value": "Abraham Lincoln",
"name": "Abraham Lincoln",
"user_name": "abraham.lincoln",
"table": "sys_user",
"avatar": null,
"initials": "AL",
"email": "abraham.lincoln@example.com",
"label": ""
},
"edit_restriction": {
"value": "fully_restricted",
"display_value": "Fully restricted"
},
"source": {
"value": "servicenow",
"display_value": "Workplace Services"
},
"source_reservation_requester": {
"sys_id": "6816f79cc0a8016401c5a33be04be441",
"name": "System Administrator",
"user_name": "admin"
},
"source_icon": {
"classNames": "fa fa-calendar-check-o",
"tooltip": "Reservation is confirmed",
"imgSrc": ""
},
"shift": null,
"reservationAcl": {
"write": {
"record": true,
"fields": {
"subject": true,
"sensitivity": true,
"requested_for": true,
"number_of_attendees": true,
"location": true
},
"allFields": true
},
"read": true
}
}
]
}
}
WSD-Gruppenreservierung: PATCH /api/sn_wsd_rsv/Group_reservation/Cancel/{ID}
Bricht eine angegebene Gruppenreservierung ab.
URL-Format
Versionierte URL: /api/sn_wsd_rsv/{api_Version}/Group_reservation/Cancel/{ID}
Standard-URL: /api/sn_wsd_rsv/Group_reservation/Cancel/{ID}
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
| 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 |
| id | SYS_ID des übergeordneten Reservierungsdatensatzes. Wenn eine Gruppenreservierung erstellt wird, werden ein übergeordneter Gruppendatensatz und ein oder mehrere untergeordnete Reservierungsdatensätze erstellt. Reservierungsdatensätze enthalten ein Feld namens reservation_subtype, das den Typ des Reservierungsdatensatzes angibt. Für übergeordnete Gruppendatensätze wird dieses Feld auf „übergeordnete Gruppe“ festgelegt, um anzugeben, dass es sich um einen übergeordneten Gruppendatensatz handelt. Für untergeordnete Datensätze ist dieses Feld auf „einzeln“ festgelegt. Innerhalb eines untergeordneten Datensatzes befindet sich die sys_ID des zugeordneten übergeordneten Reservierungsdatensatzes im Feld Source_reservation. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzreservierung [sn_wsd_rsv_reservation] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Cancel_Notes | Grund für die Stornierung der Reservierung. Datentyp: Zeichenfolge Standard: „Reservierung über Gruppenabbruch storniert“ |
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/xmlOder, 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 REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Ungültige oder keine übergeordnete Reservierungs-sys_ID angegeben. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Zugriff verweigert! Gruppenreservierung kann nicht storniert werden. Anwender hat unzureichende Rechte, um die angeforderte Gruppenreservierung zu stornieren. |
| 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 | Ergebnisse der Anforderung zum Abbrechen der Gruppenreservierung. Datentyp: Objekt |
| Ergebnis.alle untergeordnete Elemente Abgebrochen | Kennzeichnung, die angibt, ob alle untergeordneten Reservierungen, die der Gruppenreservierung zugeordnet sind, erfolgreich storniert wurden. Mögliche Werte:
Datentyp: Boolesch |
| result.cancelledParent | Kennzeichnung, die angibt, ob die übergeordnete Reservierung für die Gruppenreservierung erfolgreich storniert wurde. Mögliche Werte:
Datentyp: Boolesch |
| result.canceledReservations | Liste der sys_IDs der untergeordneten Reservierungen, die erfolgreich storniert wurden. Datentyp: Array |
| Ergebnis.Fehleruntergeordnete Meetings | Liste der sys_IDs der untergeordneten Reservierungen, die nicht storniert wurden. Datentyp: Array |
| result.msg | Wenn eine Reservierung nicht abgebrochen werden konnte, enthält dieser Parameter eine Meldung über die Fehlerursache. Datentyp: Zeichenfolge |
| Ergebnis.übergeordnetes Element | SYS_ID der übergeordneten Reservierung, die storniert wurde. Datentyp: Zeichenfolge |
| Ergebnis.Erfolg | Kennzeichnung, die angibt, ob die Gruppenreservierung erfolgreich storniert wurde. Mögliche Werte:
Datentyp: Boolesch |
| result.user_msg | Für die künftige Verwendung reserviert. Wenn eine Reservierung nicht abgebrochen werden konnte, enthält dieser Parameter eine übersetzte Meldung über die Fehlerursache, die Sie in der Anwenderoberfläche anzeigen können. Datentyp: Zeichenfolge |
cURL-Anforderung
Das folgende Codebeispiel zeigt, wie Sie eine Gruppenreservierung stornieren.
curl "http://instance.servicenow.com/api/sn_wsd_rsv/group_reservation/cancel/22c1aee353af01103cf7ddeeff7b12d5" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"cancel_notes\":\"Need to postpone until next quarter\"
}" \
--user 'username':'password'Ergebnisse zurückgeben:
{
"result": {
"success": true,
"canceledReservations": [
"6ec1aee353af01103cf7ddeeff7b12d8",
"aac1aee353af01103cf7ddeeff7b12db"
],
"failedChildMeetings": [],
"cancelledParent": true,
"allChildrenCanceled": true,
"msg": "",
"user_msg": "",
"parent": "22c1aee353af01103cf7ddeeff7b12d5"
}
}WSD-Gruppenreservierung: PATCH /api/sn_wsd_rsv/Group_reservation/Update/{ID}
Aktualisiert eine angegebene Gruppenreservierung.
Sie können die folgenden Reservierungsparameter aktualisieren:
- Betreff
- Startdatum und -uhrzeit
- Enddatum und -zeit
- Schicht, die der Reservierung zugeordnet ist
- Arbeitsplatzstandort einer untergeordneten Reservierung
Hinweis:
Sie müssen mindestens einen dieser Parameter im Anforderungstext des Endpunktaufrufs angeben. Parameter, die nicht übergeben werden, werden in den zugehörigen Datensätzen nicht geändert.
URL-Format
Versionierte URL: /api/sn_wsd_rsv/{api_Version}/Group_reservation/Update/{ID}
Standard-URL: /api/sn_wsd_rsv/Group_reservation/Update/{ID}
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
| 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 |
| id | SYS_ID des übergeordneten Reservierungsdatensatzes. Wenn eine Gruppenreservierung erstellt wird, werden ein übergeordneter Gruppendatensatz und ein oder mehrere untergeordnete Reservierungsdatensätze erstellt. Reservierungsdatensätze enthalten ein Feld namens reservation_subtype, das den Typ des Reservierungsdatensatzes angibt. Für übergeordnete Gruppendatensätze wird dieses Feld auf „übergeordnete Gruppe“ festgelegt, um anzugeben, dass es sich um einen übergeordneten Gruppendatensatz handelt. Für untergeordnete Datensätze ist dieses Feld auf „einzeln“ festgelegt. Innerhalb eines untergeordneten Datensatzes befindet sich die sys_ID des zugeordneten übergeordneten Reservierungsdatensatzes im Feld Source_reservation. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzreservierung [sn_wsd_rsv_reservation] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| untergeordnete Elemente | Aktualisierte Liste der untergeordneten Reservierungsdatensätze, die der Reservierung zugeordnet werden sollen. Datentyp: Array von Objekten |
| Untergeordnete Elemente.ist_privat | Kennzeichnung, die angibt, ob die Reservierung privat ist. Wenn privat, wird die Reservierung niemandem außer dem Besitzer angezeigt. Weitere Informationen zu diesen Datenschutzeinstellungen finden Sie unter Datenschutzeinstellungen für Standort und Auswirkung . Gültige Werte:
Datentyp: Boolesch Standard: Wert, der in den Systemeigenschaften für Datenschutz festgelegt ist. |
| Untergeordnete Elemente.Standort | Aktualisierte sys_ID des zu reservierenden Standorts. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzstandort [sn_wsd_Core_Workplace_location] |
| Untergeordnete Elemente.angefordert_für | Aktualisierte sys_ID des Anwenders, für den die Reservierung angefordert wird. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
| Ende | Aktualisierte Endzeit der Reservierung. Datentyp: Zeichenfolge Format: UTC oder Ortszeit (jjjj-mm-tt hh:mm:ss) |
| requested_for | SYS_ID oder E-Mail-Adresse des Anwenders, für den die Reservierung vorgenommen wird. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
| Reservierbares_Modul | Erforderlich. SYS_ID des reservierbaren Moduls, das der Reservierung zugeordnet werden soll. A Reservierbares Modul Definiert die für eine Reservierung erforderlichen Arbeitsplatzelemente. Datentyp: Zeichenfolge Tabelle: Reservierbares Modul [sn_wsd_rsv_reservable_Module] |
| Schicht | Aktualisierte sys_ID der Schicht, die der Reservierung zugeordnet werden soll. Weitere Informationen zu schichtbasierten Reservierungen finden Sie unter Aktivieren Sie die schichtbasierte Reservierung . Datentyp: Zeichenfolge Tabelle: Schicht [sn_wsd_Core_Shift] |
| Start | Aktualisierte Startzeit der Reservierung. Datentyp: Zeichenfolge Format: UTC oder Ortszeit (jjjj-mm-tt hh:mm:ss) Standard: Leer – Startzeit ist in untergeordneten Reservierungen angegeben |
| subject | Aktualisierter Betreff der Besprechung, die der Reservierung zugeordnet ist. Datentyp: Zeichenfolge Standard: Leer |
| Arbeitsplatzstandort | Aktualisierte sys_ID des Arbeitsplatzstandorts, der der Gruppenreservierung zugeordnet werden soll. Datentyp: Zeichenfolge Standard: Leer – Standorte sind in untergeordneten Reservierungen angegeben Tabelle: Arbeitsplatzstandort [sn_wsd_Core_Workplace_location |
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/xmlOder, 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 REST API-HTTP-Antwortcodes .
| 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 | Gibt Ergebnisse aus der Erstellung oder Aktualisierung mehrerer Reservierungen zurück. Datentyp: Objekt |
| Ergebnis.übergeordnetes Element | SYS_ID der übergeordneten Reservierung, die aktualisiert wurde. Datentyp: Zeichenfolge |
| Ergebnis.Erfolg | Kennzeichnung, die angibt, ob die Reservierung erfolgreich erstellt wurde. Mögliche Werte:
Datentyp: Boolesch |
| Ergebnis.Erfolgsreservierungen | Liste der Reservierungen, die erfolgreich aktualisiert wurden. Datentyp: Array von Objekten |
| result.successfulReservations.msg | Interne Nachricht zum Update. Stellt technische Informationen zum Vorgang bereit. Datentyp: Zeichenfolge |
| Ergebnis.Erfolgsreservierungen.Vorgang | Typ des ausgeführten Vorgangs, z. B. Erstellen oder Aktualisieren. Wenn der Gruppenreservierung ein neues reservierbares Element hinzugefügt wird, z. B. ein hinzugefügter Raum, wird dieser Wert als zurückgegeben Erstellen , Andernfalls ist er auf festgelegt Aktualisieren . Datentyp: Zeichenfolge |
| Ergebnis.SuccessfulReservierungen.sys_ID | SYS_ID der erstellten Reservierung. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzreservierung [sn_wsd_rsv_reservation] |
| result.successfulReservations.user_msg | Anwendernachricht zum Update. Diese Nachricht kann basierend auf der Spracheinstellung des Anwenders übersetzt werden und sollte diejenige sein, die in der Anwenderoberfläche angezeigt wird. Datentyp: Zeichenfolge |
| Ergebnis.nicht erfolgreiche Reservierungen | Liste der Reservierungen, die nicht erfolgreich aktualisiert wurden. Datentyp: Array von Objekten |
| result.unSuccessfulReservations.msg | Meldung zum Aktualisierungsfehler. Datentyp: Zeichenfolge |
| Ergebnis.unSuccessfulReservierungen.Vorgang | Typ des ausgeführten Vorgangs, z. B. Erstellen oder Aktualisieren. Datentyp: Zeichenfolge |
| Ergebnis.unSuccessfulReserations.sys_ID | SYS_ID der erstellten Reservierung. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzreservierung [sn_wsd_rsv_reservation] |
| result.unSuccessfulReservations.user_msg | Meldung zum Aktualisierungsfehler. Datentyp: Zeichenfolge |
cURL-Anforderung
Das folgende Beispiel zeigt, wie Sie diesen Endpunkt aufrufen, um eine Gruppenreservierung zu aktualisieren.
curl "http://instance.servicenow.com/api/sn_wsd_rsv/group_reservation/update/b84e218a87586550cfaa99b73cbb35ec" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"reservable_module\": \"5db44502dbb650106c731dcd13961937\",
\"subject\": \"Test-123\",
\"reservation_purpose\": \"meeting\",
\"timezone\": \"US/Pacific\",
\"children\": [
{
\"location\": \"6a11a94adb7210106c731dcd1396194e\",
\"requested_for\": \"62826bf03710200044e0bfc8bcbe5df1\",
\"is_private\": false
},
{
\"location\": \"9841e94adb7210106c731dcd13961914\",
\"requested_for\": \"6816f79cc0a8016401c5a33be04be441\",
\"is_private\": false
}
],
\"start\": \"2023-02-12T11:30:00Z\",
\"end\": \"2023-02-12T12:30:00Z\"
}" \Ergebnisse zurückgeben:
{
"result": {
"parent": "b84e218a87586550cfaa99b73cbb35ec",
"success": true,
"successfulReservations": [
{
"operation": "create",
"sys_id": "7b9e658a87586550cfaa99b73cbb357d",
"msg": "",
"user_msg": null,
"location": "6a11a94adb7210106c731dcd1396194e"
},
{
"operation": "create",
"sys_id": "3b9e658a87586550cfaa99b73cbb3580",
"msg": "",
"user_msg": null,
"location": "9841e94adb7210106c731dcd13961914"
}
],
"unSuccessfulReservations": []
}
}WSD-Gruppenreservierung – NACH /api/sn_wsd_rsv/Group_reservation/add
Erstellt eine Gruppenreservierung.
URL-Format
Versionierte URL: /api/sn_wsd_rsv/{api_Version}/Group_reservation/add
Standard-URL: /api/sn_wsd_rsv/Group_reservation/add
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
| 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 |
|---|---|
| untergeordnete Elemente | Erforderlich. Liste der untergeordneten Reservierungsdatensätze, die der Reservierung zugeordnet werden sollen. Datentyp: Array von Objekten |
| Untergeordnete Elemente.ist_privat | Kennzeichnung, die angibt, ob die Reservierung privat ist. Wenn privat, wird die Reservierung niemandem außer dem Besitzer angezeigt. Weitere Informationen zu diesen Datenschutzeinstellungen finden Sie unter Datenschutzeinstellungen für Standort und Auswirkung . Gültige Werte:
Datentyp: Boolesch Standard: Wert, der in den Systemeigenschaften für Datenschutz festgelegt ist. |
| Untergeordnete Elemente.Standort | Erforderlich. SYS_ID des zu reservierenden Standorts. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzstandort [sn_wsd_Core_Workplace_location] |
| Untergeordnete Elemente.angefordert_für | Erforderlich. SYS_ID des Anwenders, für den die Reservierung angefordert wird. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
| Ende | Erforderlich, wenn shiftParameter wurde nicht übergeben. Angeforderte Endzeit der Reservierung. Datentyp: Zeichenfolge Format: UTC oder Ortszeit (jjjj-mm-tt hh:mm:ss) |
| requested_for | SYS_ID oder E-Mail-Adresse des Anwenders, für den die Reservierung vorgenommen wird. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
| Reservierbares_Modul | Erforderlich. SYS_ID des reservierbaren Moduls, das der Reservierung zugeordnet werden soll. A Reservierbares Modul Definiert die für eine Reservierung erforderlichen Arbeitsplatzelemente. Datentyp: Zeichenfolge Tabelle: Reservierbares Modul [sn_wsd_rsv_reservable_Module] |
| Schicht | SYS_ID der Schicht, die der Reservierung zugeordnet werden soll. Wenn dieser Parameter übergeben wird, wird endParameter ist nicht erforderlich. Weitere Informationen zu schichtbasierten Reservierungen finden Sie unter Aktivieren Sie die schichtbasierte Reservierung . Datentyp: Zeichenfolge Tabelle: Schicht [sn_wsd_Core_Shift] |
| Start | Erforderlich. Angeforderte Startzeit der Reservierung. Datentyp: Zeichenfolge Format: UTC oder Ortszeit (jjjj-mm-tt hh:mm:ss) |
| subject | Erforderlich. Betreff der Besprechung, die der Reservierung zugeordnet ist. Datentyp: Zeichenfolge |
| Arbeitsplatzstandort | SYS_ID des Arbeitsplatzstandorts, der der Gruppenreservierung zugeordnet werden soll. Datentyp: Zeichenfolge Standard: Leer – Standorte sind in untergeordneten Reservierungen angegeben Tabelle: Arbeitsplatzstandort [sn_wsd_Core_Workplace_location] |
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/xmlOder, 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 REST API-HTTP-Antwortcodes .
| 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 | Details zu den erstellten Gruppenreservierungen. Datentyp: Objekt |
| Ergebnis.created_Children | Details zu den erstellten untergeordneten Reservierungen. Datentyp: Array von Objekten |
| Ergebnis.created_Children.location | SYS_ID des zu reservierenden Standorts. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzstandort [sn_wsd_Core_Workplace_location] |
| Ergebnis.erstellt_untergeordnete.angefordert_für | SYS_ID des Anwenders, für den die untergeordnete Reservierung erstellt wurde. Datentyp: Zeichenfolge |
| Ergebnis.created_Children.sys_ID | SYS_ID des erstellten untergeordneten Reservierungsdatensatzes. Datentyp: Zeichenfolge |
| Ergebnis.failed_Children | Details zu den untergeordneten Reservierungen, die nicht erstellt werden konnten. Datentyp: Array von Objekten |
| Ergebnis.failed_Children.location | SYS_ID des Standortdatensatzes, der der fehlgeschlagenen Reservierung zugeordnet ist. Datentyp: Zeichenfolge |
| Ergebnis.FAILED_Children.REQUESTED_for | SYS_ID des Anwenders, für den die untergeordnete Reservierung angefordert wurde. Datentyp: Zeichenfolge |
| Ergebnis.failed_Children.sys_ID | Immer -1. Datentyp: Zeichenfolge |
| result.msg | Wenn die Anforderung fehlschlägt, wird eine Meldung angezeigt, die den Fehler beschreibt. Datentyp: Zeichenfolge |
| Ergebnis.übergeordnetes Element | SYS_ID des übergeordneten Reservierungsdatensatzes. Wenn eine Gruppenreservierung erstellt wird, werden ein übergeordneter Gruppendatensatz und ein oder mehrere untergeordnete Reservierungsdatensätze erstellt. Reservierungsdatensätze enthalten ein Feld namens reservation_subtype, das den Typ des Reservierungsdatensatzes angibt. Für übergeordnete Gruppendatensätze wird dieses Feld auf „übergeordnete Gruppe“ festgelegt, um anzugeben, dass es sich um einen übergeordneten Gruppendatensatz handelt. Für untergeordnete Datensätze ist dieses Feld auf „einzeln“ festgelegt. Innerhalb eines untergeordneten Datensatzes befindet sich die sys_ID des zugeordneten übergeordneten Reservierungsdatensatzes im Feld Source_reservation. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzreservierung [sn_wsd_rsv_reservation] |
| Ergebnis.Erfolg | Kennzeichnung, die angibt, ob die Reservierung erfolgreich erstellt wurde. Mögliche Werte:
Datentyp: Boolesch |
| result.userMsg | Wenn die Anforderung fehlschlägt, wird eine Meldung angezeigt, die den Fehler beschreibt. Datentyp: Zeichenfolge |
cURL-Anforderung
Das folgende Codebeispiel zeigt, wie dieser Endpunkt zum Erstellen einer Gruppenreservierung verwendet wird.
curl "http://instance.servicenow.com/api/sn_wsd_rsv/group_reservation/add" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"reservable_module\": \"5db44502dbb650106c731dcd13961937\",
\"subject\": \"Test-123\",
\"reservation_purpose\": \"meeting\",
\"timezone\": \"US/Pacific\",
\"children\": [
{
\"location\": \"6a11a94adb7210106c731dcd1396194e\",
\"requested_for\": \"62826bf03710200044e0bfc8bcbe5df1\",
\"is_private\": false
},
{
\"location\": \"9841e94adb7210106c731dcd13961914\",
\"requested_for\": \"6816f79cc0a8016401c5a33be04be441\",
\"is_private\": false
}
],
\"start\": \"2023-01-12T11:30:00Z\",
\"end\": \"2023-01-12T12:30:00Z\"
}" \
--user 'username':'password'Ergebnisse zurückgeben:
{
"result": {
"parent": "b84e218a87586550cfaa99b73cbb35ec",
"success": true,
"created_children": [
{
"sys_id": "7c4e218a87586550cfaa99b73cbb35ee",
"location": "6a11a94adb7210106c731dcd1396194e",
"requested_for": "62826bf03710200044e0bfc8bcbe5df1"
},
{
"sys_id": "3c4e218a87586550cfaa99b73cbb35f1",
"location": "9841e94adb7210106c731dcd13961914",
"requested_for": "6816f79cc0a8016401c5a33be04be441"
}
],
"failed_children": [],
"user_msg": "",
"msg": ""
}
}