API de reserva de grupo do WSD
A API de reserva de grupo Workplace Service Delivery (WSD) fornece endpoints para gerenciar reservas de grupo.
As reservas de grupo permitem que você reserve locais diferentes para várias pessoas (grupos) para a mesma reunião.
Esta API é executada no namespace sn_wsd_rsv. Para acessar essa API, o solicitante deve ter a função sn_wsd_core.workplace_user e o plug-in Workplace Reservation Management (sn_wsd_rsv) deve estar ativado.
Para obter informações adicionais sobre Workplace Reservation Management, consulte Workplace Reservation Management.
Reserva de grupo do WSD - GET /api/sn_wsd_rsv/group_reservation/{parent_id}
Retorna as reservas primárias e todas as secundárias de uma reserva de grupo especificada.
Formato de URL
URL com controle de versões: /api/sn_wsd_rsv/{api_version}/group_reservation/{parent_id}
URL padrão: /api/sn_wsd_rsv/group_reservation/{parent_id}
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| parent_id | Sys_id do registro de reserva primário. Localizado na tabela Reserva do local de trabalho [sn_wsd_rsv_reservation]. Quando uma reserva de grupo é criada, um registro primário de grupo e um ou mais registros de reserva secundários são criados. Os registros de reserva contêm um campo chamado reserve_subtype, que indica o tipo de registro de reserva. Para registros primários de grupo, este campo é definido como "Primário do grupo" para indicar que é um registro primário de grupo. Para registros secundários, este campo é definido como "Único". Em um registro secundário, o sys_id do registro de reserva primário associado está no campo source_reservation. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum |
| Nome | Descrição |
|---|---|
| Nenhum |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da solicitação. Tipos compatíveis: application/json, application/xml ou, text/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum |
Códigos de status
Os códigos de status a seguir se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP da REST API.
| Código de status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Inválido ou nenhum sys_id de reserva primário fornecido. |
| 404 | Acesso negado. Não é possível cancelar a reserva de grupo. O usuário não tem direitos suficientes para cancelar a reserva de grupo solicitada. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
Parâmetros do corpo da resposta
| Nome | Descrição |
|---|---|
| resultado | Detalhes sobre as reservas primárias e secundárias associadas à reserva de grupo. Tipo de dados: objeto |
Solicitação de cURL
O exemplo de código a seguir mostra como recuperar os detalhes de uma reserva de grupo.
curl "http://instance.servicenow.com/api/sn_wsd_rsv/group_reservation/e2245051533b01103cf7ddeeff7b12d6" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'Retornar resultados:
{
"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
}
}
]
}
}
Reserva de grupo do WSD - PATCH /api/sn_wsd_rsv/group_reservation/cancel/{id}
Cancela uma reserva de grupo especificada.
Formato de URL
URL com controle de versões: /api/sn_wsd_rsv/{api_version}/group_reservation/cancel/{id}
URL padrão: /api/sn_wsd_rsv/group_reservation/cancel/{id}
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| id | Sys_id do registro de reserva primário. Localizado na tabela Reserva do local de trabalho [sn_wsd_rsv_reservation]. Quando uma reserva de grupo é criada, um registro primário de grupo e um ou mais registros de reserva secundários são criados. Os registros de reserva contêm um campo chamado reserve_subtype, que indica o tipo de registro de reserva. Para registros primários de grupo, este campo é definido como "Primário do grupo" para indicar que é um registro primário de grupo. Para registros secundários, este campo é definido como "Único". Em um registro secundário, o sys_id do registro de reserva primário associado está no campo source_reservation. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum |
| Nome | Descrição |
|---|---|
| cancel_notes | Motivo para o cancelamento da reserva. Tipo de dados: cadeia de caracteres Padrão: "Reserva cancelada por meio de cancelamento de grupo" |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da solicitação. Tipos compatíveis: application/json, application/xml ou, text/xml. Padrão: application/json |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Oferece suporte somente a application/json. |
| Cabeçalho | Descrição |
|---|---|
| Nenhum |
Códigos de status
Os códigos de status a seguir se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP da REST API.
| Código de status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Inválido ou nenhum sys_id de reserva primário fornecido. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 404 | Acesso negado. Não é possível cancelar a reserva de grupo. O usuário não tem direitos suficientes para cancelar a reserva de grupo solicitada. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
Parâmetros do corpo da resposta
| Nome | Descrição |
|---|---|
| resultado | Resultados da solicitação de cancelamento da reserva de grupo. Tipo de dados: objeto |
| result.allChildrenCanceled | Sinalizador que indica se todas as reservas secundárias associadas à reserva de grupo foram canceladas com sucesso. Valores possíveis:
Tipo de dados: booliano |
| result.cancelledParent | Sinalizador que indica se a reserva primária da reserva de grupo foi cancelada com sucesso. Valores possíveis:
Tipo de dados: booliano |
| result.canceledReservations | Lista de sys_ids das reservas secundárias que foram canceladas com sucesso. Tipo de dados: matriz |
| result.failedChildMeetings | Lista de sys_ids das reservas secundárias que não foram canceladas. Tipo de dados: matriz |
| result.msg | Se houver falha ao cancelar alguma reserva, este parâmetro conterá uma mensagem sobre a causa da falha. Tipo de dados: cadeia de caracteres |
| resultado.parental | Sys_id da reserva primária que foi cancelada. Tipo de dados: cadeia de caracteres |
| resultado.sucesso | Sinalizador que indica se a reserva de grupo foi cancelada com sucesso. Valores possíveis:
Tipo de dados: booliano |
| resultado.user_msg | Reservado para uso futuro. Se houver falha ao cancelar alguma reserva, este parâmetro conterá uma mensagem traduzida sobre a causa da falha que você pode exibir na IU. Tipo de dados: cadeia de caracteres |
Solicitação de cURL
O exemplo de código a seguir mostra como cancelar uma reserva de grupo.
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'Retornar resultados:
{
"result": {
"success": true,
"canceledReservations": [
"6ec1aee353af01103cf7ddeeff7b12d8",
"aac1aee353af01103cf7ddeeff7b12db"
],
"failedChildMeetings": [],
"cancelledParent": true,
"allChildrenCanceled": true,
"msg": "",
"user_msg": "",
"parent": "22c1aee353af01103cf7ddeeff7b12d5"
}
}Reserva de grupo do WSD - PATCH /api/sn_wsd_rsv/group_reservation/update/{id}
Atualiza uma reserva de grupo especificada.
Você pode atualizar os seguintes parâmetros de reserva:
- Assunto
- Data e horário de início
- Data e horário de término
- Turno associado à reserva
- Localização do local de trabalho de qualquer reserva secundária
Nota:
Você deve especificar pelo menos um desses parâmetros no corpo da solicitação da chamada do endpoint. Os parâmetros que não são passados não são modificados nos registros associados.
Formato de URL
URL com controle de versões: /api/sn_wsd_rsv/{api_version}/group_reservation/update/{id}
URL padrão: /api/sn_wsd_rsv/group_reservation/update/{id}
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| id | Sys_id do registro de reserva primário. Localizado na tabela Reserva do local de trabalho [sn_wsd_rsv_reservation]. Quando uma reserva de grupo é criada, um registro primário de grupo e um ou mais registros de reserva secundários são criados. Os registros de reserva contêm um campo chamado reserve_subtype, que indica o tipo de registro de reserva. Para registros primários de grupo, este campo é definido como "Primário do grupo" para indicar que é um registro primário de grupo. Para registros secundários, este campo é definido como "Único". Em um registro secundário, o sys_id do registro de reserva primário associado está no campo source_reservation. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum |
| Nome | Descrição |
|---|---|
| secundários | Lista atualizada de registros de reservas secundárias para associar à reserva. Tipo de dados: matriz de objetos |
| filhos.é_privado | Sinalizador que indica se a reserva é privada. Se for privada, a reserva não aparecerá para ninguém, exceto o proprietário. Para obter informações adicionais sobre essas configurações de privacidade, consulte Configurações de privacidade do local e impacto. Valores válidos:
Tipo de dados: booliano Padrão: valor definido para privacidade nas propriedades do sistema. |
| secundário.local | sys_id atualizado do local a ser reservado. Localizado na tabela Local do local de trabalho [sn_wsd_core_workplace_location]. Tipo de dados: cadeia de caracteres |
| filhos.solicitados_para | sys_id atualizado do usuário para o qual a reserva está sendo solicitada. Localizado na tabela Usuário [sys_user]. Tipo de dados: cadeia de caracteres |
| término | Hora de término atualizada da reserva. Tipo de dados: cadeia de caracteres Formato: UTC ou hora local (aaaa-mm-dd hh:mm:ss) |
| requested_for | Sys_id ou endereço de e-mail do usuário para o qual a reserva está sendo feita. Localizado na tabela Usuário [sys_user]. Tipo de dados: cadeia de caracteres |
| reservable_module | Obrigatório. Sys_id do módulo reservável a ser associado à reserva. Um módulo reservável define os itens do local de trabalho necessários para uma reserva. Localizado na tabela Módulo reservável [sn_wsd_rsv_reservable_module]. Tipo de dados: cadeia de caracteres |
| shift | sys_id do turno atualizado para associar à reserva. Localizado na tabela Turno [sn_wsd_core_shift]. Para obter informações adicionais sobre reservas baseadas em turno, consulte Habilitar reserva baseada em turno. Tipo de dados: cadeia de caracteres |
| início | Hora de início atualizada da reserva. Tipo de dados: cadeia de caracteres Formato: UTC ou hora local (aaaa-mm-dd hh:mm:ss) Padrão: vazio - a hora de início é especificada nas reservas secundárias |
| assunto | Assunto atualizado da reunião associada à reserva. Tipo de dados: cadeia de caracteres Padrão: vazio |
| local_de_trabalho | sys_id atualizado do local de trabalho a ser associado à reserva de grupo. Localizado na tabela Local do local de trabalho [sn_wsd_core_workplace_location]. Tipo de dados: cadeia de caracteres Padrão: vazio - os locais são especificados nas reservas secundárias |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da solicitação. Tipos compatíveis: application/json, application/xml ou, text/xml. Padrão: application/json |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Oferece suporte somente a application/json. |
| Cabeçalho | Descrição |
|---|---|
| Nenhum |
Códigos de status
Os códigos de status a seguir se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP da REST API.
| Código de status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
Parâmetros do corpo da resposta
| Nome | Descrição |
|---|---|
| resultado | Retornar resultados da criação ou atualização de reservas múltiplas. Tipo de dados: objeto |
| resultado.parental | Sys_id da reserva primária que foi atualizada. Tipo de dados: cadeia de caracteres |
| resultado.sucesso | Sinalizador que indica se a reserva foi criada com sucesso. Valores possíveis:
Tipo de dados: booliano |
| result.SuccessfulReservations | Lista das reservas que foram atualizadas com sucesso. Tipo de dados: matriz |
| result.successfulReservations.msg | Mensagem interna sobre a atualização. Fornece informações técnicas sobre a operação. Tipo de dados: cadeia de caracteres |
| result.SuccessfulReservations.operation | Tipo de operação que foi realizada, como criar ou atualizar. Se um novo reservável for adicionado à reserva de grupo, como uma sala adicionada, este valor será retornado como criar, caso contrário, ele será definido como atualizar. Tipo de dados: cadeia de caracteres |
| resultado.reservasbem-sucedidas.sys_id | Sys_id da reserva que foi criada. Localizado na tabela Reserva do local de trabalho [sn_wsd_rsv_reservation]. Tipo de dados: cadeia de caracteres |
| result.successfulReservations.user_msg | Mensagem do usuário sobre a atualização. Esta mensagem pode ser traduzida com base na preferência de idioma do usuário e deve ser aquela que aparece na IU. Tipo de dados: cadeia de caracteres |
| result.unSuccessfulReservations | Lista das reservas que foram atualizadas sem sucesso. Tipo de dados: matriz |
| result.unSuccessfulReservations.msg | Mensagem sobre o erro de atualização. Tipo de dados: cadeia de caracteres |
| result.unSuccessfulReservations.operation | Tipo de operação que foi realizada, como criar ou atualizar. Tipo de dados: cadeia de caracteres |
| result.unSuccessfulReservations.sys_id | Sys_id da reserva que foi criada. Localizado na tabela Reserva do local de trabalho [sn_wsd_rsv_reservation]. Tipo de dados: cadeia de caracteres |
| result.unSuccessfulReservations.user_msg | Mensagem sobre o erro de atualização. Tipo de dados: cadeia de caracteres |
Solicitação de cURL
O exemplo a seguir mostra como chamar este endpoint para atualizar uma reserva de grupo.
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\"
}" \Retornar resultados:
{
"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": []
}
}Reserva de grupo do WSD - POST /api/sn_wsd_rsv/group_reservation/add
Cria uma reserva de grupo.
Formato de URL
URL com controle de versões: /api/sn_wsd_rsv/{api_version}/group_reservation/add
URL padrão: /api/sn_wsd_rsv/group_reservation/add
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum |
| Nome | Descrição |
|---|---|
| secundários | Obrigatório. Lista de registros de reservas secundários a serem associados à reserva. Tipo de dados: matriz de objetos |
| filhos.é_privado | Sinalizador que indica se a reserva é privada. Se for privada, a reserva não aparecerá para ninguém, exceto o proprietário. Para obter informações adicionais sobre essas configurações de privacidade, consulte Configurações de privacidade do local e impacto. Valores válidos:
Tipo de dados: booliano Padrão: valor definido para privacidade nas propriedades do sistema. |
| secundário.local | Obrigatório. Sys_id do local a ser reservado. Localizado na tabela Local do local de trabalho [sn_wsd_core_workplace_location]. Tipo de dados: cadeia de caracteres |
| filhos.solicitados_para | Obrigatório. Sys_id do usuário para o qual a reserva está sendo solicitada. Localizado na tabela Usuário [sys_user]. Tipo de dados: cadeia de caracteres |
| término | Obrigatório se o parâmetro shift não for passado. Hora de término solicitada da reserva. Tipo de dados: cadeia de caracteres Formato: UTC ou hora local (aaaa-mm-dd hh:mm:ss) |
| requested_for | Sys_id ou endereço de e-mail do usuário para o qual a reserva está sendo feita. Localizado na tabela Usuário [sys_user]. Tipo de dados: cadeia de caracteres |
| reservable_module | Obrigatório. Sys_id do módulo reservável a ser associado à reserva. Um módulo reservável define os itens do local de trabalho necessários para uma reserva. Localizado na tabela Módulo reservável [sn_wsd_rsv_reservable_module]. Tipo de dados: cadeia de caracteres |
| shift | Sys_id do turno a ser associado à reserva. Localizado na tabela Turno [sn_wsd_core_shift]. Se este parâmetro for passado, o parâmetro end não será necessário. Para obter informações adicionais sobre reservas baseadas em turno, consulte Habilitar reserva baseada em turno. Tipo de dados: cadeia de caracteres |
| início | Obrigatório. Hora de início solicitada da reserva. Tipo de dados: cadeia de caracteres Formato: UTC ou hora local (aaaa-mm-dd hh:mm:ss) |
| assunto | Obrigatório. Assunto da reunião associada à reserva. Tipo de dados: cadeia de caracteres |
| local_de_trabalho | Sys_id do local de trabalho a ser associado à reserva de grupo. Localizado na tabela Local do local de trabalho [sn_wsd_core_workplace_location]. Tipo de dados: cadeia de caracteres Padrão: vazio - os locais são especificados nas reservas secundárias |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da solicitação. Tipos compatíveis: application/json, application/xml ou, text/xml. Padrão: application/json |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Oferece suporte somente a application/json. |
| Cabeçalho | Descrição |
|---|---|
| Nenhum |
Códigos de status
Os códigos de status a seguir se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP da REST API.
| Código de status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
Parâmetros do corpo da resposta
| Nome | Descrição |
|---|---|
| resultado | Detalhes sobre as reservas de grupo criadas. Tipo de dados: objeto |
| result.created_children | Detalhes sobre as reservas secundárias que foram criadas. Tipo de dados: matriz de objetos |
| result.created_children.location | Sys_id do local a ser reservado. Localizado na tabela Local do local de trabalho [sn_wsd_core_workplace_location]. Tipo de dados: cadeia de caracteres |
| result.created_children.requested_for | Sys_id do usuário para o qual a reserva secundária foi criada. Tipo de dados: cadeia de caracteres |
| result.created_children.sys_id | Sys_id do registro de reserva secundário que foi criado. Tipo de dados: cadeia de caracteres |
| result.failed_children | Detalhes sobre as reservas secundárias que não foram criadas. Tipo de dados: matriz de objetos |
| result.failed_children.location | Sys_id do registro do local associado à reserva com falha. Tipo de dados: cadeia de caracteres |
| result.failed_children.requested_for | Sys_id do usuário para o qual a reserva secundária foi solicitada. Tipo de dados: cadeia de caracteres |
| result.failed_children.sys_id | Sempre -1. Tipo de dados: cadeia de caracteres |
| result.msg | Se a solicitação falhar, uma mensagem que descreve o erro. Tipo de dados: cadeia de caracteres |
| resultado.parental | Sys_id do registro de reserva primário. Localizado na tabela Reserva do local de trabalho [sn_wsd_rsv_reservation]. Quando uma reserva de grupo é criada, um registro primário de grupo e um ou mais registros de reserva secundários são criados. Os registros de reserva contêm um campo chamado reserve_subtype, que indica o tipo de registro de reserva. Para registros primários de grupo, este campo é definido como "Primário do grupo" para indicar que é um registro primário de grupo. Para registros secundários, este campo é definido como "Único". Em um registro secundário, o sys_id do registro de reserva primário associado está no campo source_reservation. Tipo de dados: cadeia de caracteres |
| resultado.sucesso | Sinalizador que indica se a reserva foi criada com sucesso. Valores possíveis:
Tipo de dados: booliano |
| result.userMsg | Se a solicitação falhar, uma mensagem que descreve o erro. Tipo de dados: cadeia de caracteres |
Solicitação de cURL
O exemplo de código a seguir mostra como usar este endpoint para criar reservas de grupo.
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'Retornar resultados:
{
"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": ""
}
}